gen_avr8.pro.write_template module

Module
write_template.py
Copyright
Copyright (C) 2018 Vladimir Roncevic <elektron.ronca@gmail.com> gen_avr8 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. gen_avr8 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Info
Defined class WriteTemplate with attribute(s) and method(s). Created API for write template content with parameters.
class gen_avr8.pro.write_template.WriteTemplate(verbose=False)[source]

Bases: ats_utilities.config_io.base_check.FileChecking

Defined class WriteTemplate with attribute(s) and method(s). Created API for Write template content with parameters. It defines:

attributes:
GEN_VERBOSE - console text indicator for process-phase.
__pro_dir - current project directory.
methods:
__init__ - initial constructor.
pro_dir - property methods for set/get operations.
check_module - check project module.
write - write a template content to a project module.
__str__ - dunder method for WriteTemplate.
GEN_VERBOSE = 'GEN_AVR8::PRO::WRITE_TEMPLATE'
VERBOSE = 'ATS_UTILITIES'
check_module(module, verbose=False)[source]

Check project module.

Parameters:
  • module (<str>) – module name.
  • verbose (<bool>) – enable/disable verbose option.
Returns:

‘build’ | ‘source’| None (wrong module name).

Return type:

<str> | <NoneType>

Exceptions:

ATSTypeError | ATSBadCallError

pro_dir

Property method for getting project dir.

Returns:project dir | None.
Return type:<str> | <NoneType>
Exceptions:None
write(project_data, verbose=False)[source]

Write a template content to a project module.

Parameters:
  • project_data (<dict>) – project data.
  • verbose (<bool>) – enable/disable verbose option.
Returns:

boolean status, True (success) | False.

Return type:

<bool>

Exception:

ATSTypeError | ATSBadCallError