Added cpl_cli docs & moved cpl_cli/templates -> cpl_cli/_templates

src/cpl_cli/_templates/generate/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_cpl-cli sh-edraft Common Python library CLI
+~~~~~~~~~~~~~~~~~~~
+
+sh-edraft Common Python library Command Line Interface
+
+:copyright: (c) 2020 - 2021 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'cpl_cli._templates.generate'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
+__version__ = '2021.4'
+
+from collections import namedtuple
+
+# imports:
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='2021', minor='4', micro='None')

src/cpl_cli/_templates/generate/abc_template.py

@@ -0,0 +1,38 @@
+import textwrap
+from string import Template
+
+from cpl.utils.string import String
+from cpl_cli._templates.template_file_abc import TemplateFileABC
+
+
+class ABCTemplate(TemplateFileABC):
+
+    def __init__(self, name: str, schematic: str, schematic_upper: str, path: str):
+        TemplateFileABC.__init__(self)
+
+        self._name = f'{String.convert_to_snake_case(name)}_{schematic}.py'
+        self._class_name = f'{String.first_to_upper(name)}{schematic_upper}'
+        self._path = path
+        self._value = textwrap.dedent("""\
+        from abc import ABC, abstractmethod
+
+
+        class $Name(ABC):
+        
+            @abstractmethod
+            def __init__(self): pass
+        """)
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def value(self) -> str:
+        return Template(self._value).substitute(
+            Name=self._class_name
+        )

src/cpl_cli/_templates/generate/class_template.py

@@ -0,0 +1,35 @@
+import textwrap
+from string import Template
+
+from cpl.utils.string import String
+from cpl_cli._templates.template_file_abc import TemplateFileABC
+
+
+class ClassTemplate(TemplateFileABC):
+
+    def __init__(self, name: str, schematic: str, schematic_upper: str, path: str):
+        TemplateFileABC.__init__(self)
+
+        self._name = f'{String.convert_to_snake_case(name)}.py'
+        self._class_name = f'{String.first_to_upper(name)}'
+        self._path = path
+        self._value = textwrap.dedent("""\
+        class $Name:
+
+            def __init__(self):
+                pass
+        """)
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def value(self) -> str:
+        return Template(self._value).substitute(
+            Name=self._class_name
+        )

src/cpl_cli/_templates/generate/configmodel_template.py

@@ -0,0 +1,54 @@
+import textwrap
+from string import Template
+
+from cpl.utils.string import String
+from cpl_cli._templates.template_file_abc import TemplateFileABC
+
+
+class ConfigModelTemplate(TemplateFileABC):
+
+    def __init__(self, name: str, schematic: str, schematic_upper: str, path: str):
+        TemplateFileABC.__init__(self)
+
+        self._name = f'{String.convert_to_snake_case(name)}_{schematic}.py'
+        self._class_name = f'{String.first_to_upper(name)}{schematic_upper}'
+        self._path = path
+        self._value = textwrap.dedent("""\
+        import traceback
+
+        from cpl.configuration.configuration_model_abc import ConfigurationModelABC
+        from cpl.console import Console
+        
+        
+        class $Name(ConfigurationModelABC):
+        
+            def __init__(self):
+                ConfigurationModelABC.__init__(self)
+        
+                self._atr = ''
+        
+            @property
+            def atr(self) -> str:
+                return self._atr
+        
+            def from_dict(self, settings: dict):
+                try:
+                    self._atr = settings['atr']
+                except Exception as e:
+                    Console.error(f'[ ERROR ] [ {__name__} ]: Reading error in {self.__name__} settings')
+                    Console.error(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}')
+        """)
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def value(self) -> str:
+        return Template(self._value).substitute(
+            Name=self._class_name
+        )

src/cpl_cli/_templates/generate/enum_template.py

@@ -0,0 +1,37 @@
+import textwrap
+from string import Template
+
+from cpl.utils.string import String
+from cpl_cli._templates.template_file_abc import TemplateFileABC
+
+
+class EnumTemplate(TemplateFileABC):
+
+    def __init__(self, name: str, schematic: str, schematic_upper: str, path: str):
+        TemplateFileABC.__init__(self)
+
+        self._name = f'{String.convert_to_snake_case(name)}_{schematic}.py'
+        self._class_name = f'{String.first_to_upper(name)}{schematic_upper}'
+        self._path = path
+        self._value = textwrap.dedent("""\
+        from enum import Enum
+        
+        
+        class $Name(Enum):
+        
+            atr = 0
+        """)
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def value(self) -> str:
+        return Template(self._value).substitute(
+            Name=self._class_name
+        )

src/cpl_cli/_templates/generate/init_template.py

@@ -0,0 +1,32 @@
+import textwrap
+from string import Template
+
+from cpl.utils.string import String
+from cpl_cli._templates.template_file_abc import TemplateFileABC
+
+
+class InitTemplate(TemplateFileABC):
+
+    def __init__(self, name: str, schematic: str, schematic_upper: str, path: str):
+        TemplateFileABC.__init__(self)
+
+        self._name = f'__init__.py'
+        self._class_name = f'{String.first_to_upper(name)}{schematic_upper}'
+        self._path = path
+        self._value = textwrap.dedent("""\
+        # imports
+        """)
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def value(self) -> str:
+        return Template(self._value).substitute(
+            Name=self._class_name
+        )

src/cpl_cli/_templates/generate/service_template.py

@@ -0,0 +1,35 @@
+import textwrap
+from string import Template
+
+from cpl.utils.string import String
+from cpl_cli._templates.template_file_abc import TemplateFileABC
+
+
+class ServiceTemplate(TemplateFileABC):
+
+    def __init__(self, name: str, schematic: str, schematic_upper: str, path: str):
+        TemplateFileABC.__init__(self)
+
+        self._name = f'{String.convert_to_snake_case(name)}_{schematic}.py'
+        self._class_name = f'{String.first_to_upper(name)}{schematic_upper}'
+        self._path = path
+        self._value = textwrap.dedent("""\
+        class $Name:
+
+            def __init__(self):
+                pass
+        """)
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def value(self) -> str:
+        return Template(self._value).substitute(
+            Name=self._class_name
+        )

src/cpl_cli/_templates/generate/thread_template.py

@@ -0,0 +1,41 @@
+import textwrap
+from string import Template
+
+from cpl.utils.string import String
+from cpl_cli._templates.template_file_abc import TemplateFileABC
+
+
+class ThreadTemplate(TemplateFileABC):
+
+    def __init__(self, name: str, schematic: str, schematic_upper: str, path: str):
+        TemplateFileABC.__init__(self)
+
+        self._name = f'{String.convert_to_snake_case(name)}_{schematic}.py'
+        self._class_name = f'{String.first_to_upper(name)}{schematic_upper}'
+        self._path = path
+        self._value = textwrap.dedent("""\
+        import threading
+        
+        
+        class $Name(threading.Thread):
+
+            def __init__(self):
+                threading.Thread.__init__(self)
+                
+            def run(self) -> None:
+                pass
+        """)
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def path(self) -> str:
+        return self._path
+
+    @property
+    def value(self) -> str:
+        return Template(self._value).substitute(
+            Name=self._class_name
+        )