Module licenseware.cli.base_creator

Classes

class BaseCreator (entity_id: str)

This class uses the given entity_id which can be: uploader_id, report_id, app_id etc The entity_id will have multiple derivate shapes (see bellow transformations in the init method) which will be passed to jinja templates as template variables

Each file creation class should inherit (if possible) from this class.

As an example you can see licenseware/cli/uploader_creator package.

Expand source code

class BaseCreator(metaclass=ABCMeta):
    """
        This class uses the given `entity_id` which can be: uploader_id, report_id, app_id etc
        The `entity_id` will have multiple derivate shapes (see bellow transformations in the __init__ method) 
        which will be passed to jinja templates as template variables

        Each file creation class should inherit (if possible) from this class.

        As an example you can see `licenseware/cli/uploader_creator` package.

    """

    def __init__(self, entity_id: str):
        self.entity_id = entity_id
        entity_idli = entity_id.strip().replace("-", "|").replace("_", "|").split("|")
        self.entity_title = "".join([v.capitalize() for v in entity_idli]) # odb-service => OdbService
        self.entity_dash = "-".join([v.lower() for v in entity_idli]) # odb-service => odb-service
        self.entity_dash_upper = "-".join([v.upper() for v in entity_idli]) # odb-service => ODB-SERVICE
        self.entity_underscore = "_".join([v.lower() for v in entity_idli]) # odb-service => odb_service
        self.entity_underscore_upper = "_".join([v.upper() for v in entity_idli]) # odb-service => ODB_SERVICE


    @classmethod
    def __subclasshook__(cls, subclass):
        # Ensure `create` method is provided
        return (
            hasattr(subclass, 'create') and callable(subclass.create)
            # Fail
            or NotImplemented
        )

    @abstractmethod
    def create(self):
        raise NotImplemented

    def create_file(
        self, 
        filename: str, 
        filepath: str, 
        template_resource: ModuleType, 
        template_filename: str = None, 
        **template_vars
    ):

        """
        
        This methods uses the jinja template to generate a new file.

        :filename - the filename of the output
        :filepath - the path where the file should be saved
        :template_resource - the resource module which contains the .jinja template
        :template_filename - the jinja template filename 
        (if not provided will look for filename.jinja in the template_resource package)
        :template_vars - the variables that should be passed to the jinja template

        """

        file_path = os.path.join(filepath, filename)
        if os.path.exists(file_path): return False
        if not os.path.exists(filepath): os.makedirs(filepath)

        raw_contents = pkg_resources.read_text(template_resource, template_filename or filename + '.jinja')
        file_contents = Template(raw_contents).render(
            **{
                'entity_title': self.entity_title, 
                'entity_dash': self.entity_dash,
                'entity_dash_upper': self.entity_dash_upper,
                'entity_underscore': self.entity_underscore,
                'entity_underscore_upper': self.entity_underscore_upper
            }, **template_vars
        )

        with open(file_path, 'w') as f:
            f.write(file_contents)

        return True

Subclasses

• AppRootFilesCreator
• DevOpsCreator
• ReportComponentCreator
• ReportCreator
• RestxControllerCreator
• UnittestFileCreator
• UploaderCreator

Methods

def create(self)

Expand source code

@abstractmethod
def create(self):
    raise NotImplemented

def create_file(self, filename: str, filepath: str, template_resource: module, template_filename: str = None, **template_vars)

This methods uses the jinja template to generate a new file.

:filename - the filename of the output :filepath - the path where the file should be saved :template_resource - the resource module which contains the .jinja template :template_filename - the jinja template filename (if not provided will look for filename.jinja in the template_resource package) :template_vars - the variables that should be passed to the jinja template

Expand source code

def create_file(
    self, 
    filename: str, 
    filepath: str, 
    template_resource: ModuleType, 
    template_filename: str = None, 
    **template_vars
):

    """
    
    This methods uses the jinja template to generate a new file.

    :filename - the filename of the output
    :filepath - the path where the file should be saved
    :template_resource - the resource module which contains the .jinja template
    :template_filename - the jinja template filename 
    (if not provided will look for filename.jinja in the template_resource package)
    :template_vars - the variables that should be passed to the jinja template

    """

    file_path = os.path.join(filepath, filename)
    if os.path.exists(file_path): return False
    if not os.path.exists(filepath): os.makedirs(filepath)

    raw_contents = pkg_resources.read_text(template_resource, template_filename or filename + '.jinja')
    file_contents = Template(raw_contents).render(
        **{
            'entity_title': self.entity_title, 
            'entity_dash': self.entity_dash,
            'entity_dash_upper': self.entity_dash_upper,
            'entity_underscore': self.entity_underscore,
            'entity_underscore_upper': self.entity_underscore_upper
        }, **template_vars
    )

    with open(file_path, 'w') as f:
        f.write(file_contents)

    return True