gen_coap_service.pro package¶
Submodules¶
Module contents¶
- Module
__init__.py
- Copyright
Copyright (C) 2020 - 2024 Vladimir Roncevic <elektron.ronca@gmail.com> gen_coap_service 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_coap_service 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
Defines class GenCoAP with attribute(s) and method(s). Generates project_structure by templates and parameters.
- class gen_coap_service.pro.GenCoAP(verbose: bool = False)[source]¶
Bases:
FileCheck
,ProConfig
,ProName
Defines class GenCoAP with attribute(s) and method(s). Generates project_structure by template and parameters.
It Definess:
- attributes:
- _GEN_VERBOSE - Console text indicator for process-phase._PRO_STRUCTURE - Project setup (templates, modules)._reader - Reader API._writer - Writer API.
- methods:
- __init__ - Initials GenCoAP constructor.get_reader - Gets template reader.get_writer - Gets template writer.gen_project - Generates autotools project skeleton.
- _GEN_VERBOSE: str = 'GEN_COAP_SERVICE::PRO::GEN_PRO'¶
- _PRO_STRUCTURE: str = '/../conf/project.yaml'¶
- get_reader() gen_coap_service.pro.read_template.ReadTemplate | None [source]¶
Gets template reader.
- Returns:
Template reader object | None
- Return type:
<ReadTemplate> | <NoneType>
- Exceptions:
None
- get_writer() gen_coap_service.pro.write_template.WriteTemplate | None [source]¶
Gets template writer.
- Returns:
Template writer object | none
- Return type:
<WriteTemplate> | <NoneType
- Exceptions:
None
- project_setup(pro_name: str | None, pro_type: str | None, verbose: bool = False) bool [source]¶
Generates autotools project skeleton.
- Parameters:
pro_name (<str> | <NoneType>) – Project name | None
pro_type (<str> | <NoneType>) – Project type | None
verbose (<bool>) – Enable/Disable verbose option
- Returns:
True (success operation) | False
- Return type:
<bool>
- Exceptions:
ATSTypeError | ATSValueError