sh-edraft.de/sh_cpl
2
1
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects 1 Releases 12 Wiki Activity

Added first publisher tests, fixed small bugs

Browse Source
This commit is contained in:
Sven Heidemann
2020-11-24 19:53:24 +01:00
parent 45154950ee
commit cd9d4d3c3d
14 changed files with 118 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
src/sh_edraft/publishing/__init__.py Normal file
View File

@@ -0,0 +1,26 @@
# -*- coding: utf-8 -*-
"""
sh_edraft.publishing
~~~~~~~~~~~~~~~~~~~
:copyright: (c) 2020 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'sh_edraft.publishing'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 sh-edraft.de'
__version__ = '2020.12.5'
from collections import namedtuple
# imports:
from .publisher import Publisher
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major=2020, minor=12, micro=5)

26
src/sh_edraft/publishing/base/__init__.py Normal file
View File

@@ -0,0 +1,26 @@
# -*- coding: utf-8 -*-
"""
sh_edraft.publishing.base
~~~~~~~~~~~~~~~~~~~
:copyright: (c) 2020 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'sh_edraft.publishing.base'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 sh-edraft.de'
__version__ = '2020.12.5'
from collections import namedtuple
# imports:
from .publisher_base import PublisherBase
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major=2020, minor=12, micro=5)

32
src/sh_edraft/publishing/base/publisher_base.py Normal file
View File

@@ -0,0 +1,32 @@
from abc import abstractmethod
from typing import Optional
from sh_edraft.logging.base.logger_base import LoggerBase
from sh_edraft.publishing.model.template import Template
from sh_edraft.service.base.service_base import ServiceBase
class PublisherBase(ServiceBase):
@abstractmethod
def __init__(self):
ServiceBase.__init__(self)
self._logger: Optional[LoggerBase] = None
self._source_path: Optional[str] = None
self._dist_path: Optional[str] = None
self._settings: Optional[list[Template]] = None
self._included_files: list[str] = []
self._excluded_files: list[str] = []
@property
@abstractmethod
def source_path(self) -> str: pass
@property
@abstractmethod
def dist_path(self) -> str: pass
@abstractmethod
def publish(self) -> str: pass

27
src/sh_edraft/publishing/model/__init__.py Normal file
View File

@@ -0,0 +1,27 @@
# -*- coding: utf-8 -*-
"""
sh_edraft.publishing.model
~~~~~~~~~~~~~~~~~~~
:copyright: (c) 2020 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'sh_edraft.publishing.model'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 sh-edraft.de'
__version__ = '2020.12.5'
from collections import namedtuple
# imports:
from .template import Template
from .template_enum import TemplateEnum
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major=2020, minor=12, micro=5)

122
src/sh_edraft/publishing/model/template.py Normal file
View File

@@ -0,0 +1,122 @@
from typing import Optional
from sh_edraft.source_code.model.version import Version
from sh_edraft.configuration.model import ConfigurationModelBase
from sh_edraft.publishing.model.template_enum import TemplateEnum
class Template(ConfigurationModelBase):
def __init__(
self,
template_path: Optional[str] = None,
name: Optional[str] = None,
description: Optional[str] = None,
long_description: Optional[str] = None,
copyright_date: Optional[str] = None,
copyright_name: Optional[str] = None,
license_name: Optional[str] = None,
license_description: Optional[str] = None,
title: Optional[str] = None,
author: Optional[str] = None,
version: Optional[dict] = None
):
self._template_path: Optional[str] = template_path
self._name: Optional[str] = name
self._description: Optional[str] = description
self._long_description: Optional[str] = long_description
self._copyright_date: Optional[str] = copyright_date
self._copyright_name: Optional[str] = copyright_name
self._license_name: Optional[str] = license_name
self._license_description: Optional[str] = license_description
self._title: Optional[str] = title
self._author: Optional[str] = author
self._version: Optional[Version] = Version()
self._version.from_dict(version)
self._file_content: Optional[str] = None
@property
def template_path(self) -> Optional[str]:
return self._template_path
@property
def name(self) -> Optional[str]:
return self._name
@property
def description(self) -> Optional[str]:
return self._description
@property
def long_description(self) -> Optional[str]:
return self._long_description
@property
def copyright_date(self) -> Optional[str]:
return self._copyright_date
@property
def copyright_name(self) -> Optional[str]:
return self._copyright_name
@property
def license_name(self) -> Optional[str]:
return self._license_name
@property
def license_description(self) -> Optional[str]:
return self._license_description
@property
def title(self) -> Optional[str]:
return self._title
@property
def author(self) -> Optional[str]:
return self._author
@property
def version(self) -> Optional[Version]:
return self._version
@property
def file_content(self) -> Optional[str]:
return self._file_content
@file_content.setter
def file_content(self, file_content: Optional[str]):
self._file_content = file_content
def from_dict(self, settings: dict):
self._template_path = settings[TemplateEnum.TemplatePath.value]
self._name = settings[TemplateEnum.Name.value]
self._description = settings[TemplateEnum.Description.value]
self._long_description = settings[TemplateEnum.LongDescription.value]
self._copyright_date = settings[TemplateEnum.CopyrightDate.value]
self._copyright_name = settings[TemplateEnum.CopyrightName.value]
self._license_name = settings[TemplateEnum.LicenseName.value]
self._license_description = settings[TemplateEnum.LicenseDescription.value]
self._title = settings[TemplateEnum.Title.value]
self._author = settings[TemplateEnum.Author.value]
self._version.from_dict(settings[TemplateEnum.Version.value])
def to_dict(self) -> dict:
version: Optional[dict] = None
if self._version is not None:
version = self._version.to_dict()
return {
TemplateEnum.TemplatePath.value: self._template_path,
TemplateEnum.Name.value: self._name,
TemplateEnum.Description.value: self._description,
TemplateEnum.LongDescription.value: self._long_description,
TemplateEnum.CopyrightDate.value: self._copyright_date,
TemplateEnum.CopyrightName.value: self._copyright_name,
TemplateEnum.LicenseName.value: self._license_name,
TemplateEnum.LicenseDescription.value: self._license_description,
TemplateEnum.Title.value: self._title,
TemplateEnum.Author.value: self._author,
TemplateEnum.Version.value: version
}

16
src/sh_edraft/publishing/model/template_enum.py Normal file
View File

@@ -0,0 +1,16 @@
from enum import Enum
class TemplateEnum(Enum):
TemplatePath = 'TemplatePath'
Name = 'Name'
Description = 'Description'
LongDescription = 'LongDescription'
CopyrightDate = 'CopyrightDate'
CopyrightName = 'CopyrightName'
LicenseName = 'LicenseName'
LicenseDescription = 'LicenseDescription'
Title = 'Title'
Author = 'Author'
Version = 'Version'

239
src/sh_edraft/publishing/publisher.py Normal file
View File

@@ -0,0 +1,239 @@
import os
import shutil
from string import Template as stringTemplate
from sh_edraft.logging.base.logger_base import LoggerBase
from sh_edraft.publishing.base.publisher_base import PublisherBase
from sh_edraft.publishing.model.template import Template
class Publisher(PublisherBase):
def __init__(self):
super().__init__()
self._included_files: list[str] = []
self._excluded_files: list[str] = []
self._template_ending = '_template.txt'
@property
def source_path(self) -> str:
return self._source_path
@property
def dist_path(self):
return self._dist_path
def _get_template_output(self, t: Template, name: str, imports: str) -> str:
self._logger.trace(__name__, f'Started {__name__}._get_template_output')
try:
if t.file_content == '':
raise Exception(f'Template is empty: {t.template_path}')
self._logger.trace(__name__, f'Stopped {__name__}._get_template_output')
return stringTemplate(t.file_content).substitute(
Name=name,
Description=t.description,
LongDescription=t.long_description,
CopyrightDate=t.copyright_date,
CopyrightName=t.copyright_name,
LicenseName=t.license_name,
LicenseDescription=t.license_description,
Title=t.title if t.title is not None and t.title != '' else name,
Author=t.author,
Version=t.version.to_str(),
Major=t.version.major,
Minor=t.version.minor,
Micro=t.version.micro,
Imports=imports
)
except Exception as e:
self._logger.fatal(__name__, f'Cannot read Template: {t.template_path}', e)
self._logger.trace(__name__, f'Stopped {__name__}._get_template_output')
def _read_source_path(self):
self._logger.trace(__name__, f'Started {__name__}._read_source_path')
for r, d, f in os.walk(self._source_path):
for file in f:
if file.endswith('.py') or file in self._included_files:
self._included_files.append(os.path.join(r, file))
self._logger.trace(__name__, f'Stopped {__name__}._read_source_path')
def _read_templates(self):
self._logger.trace(__name__, f'Started {__name__}._read_templates')
for t in self._settings:
output_template: str = ''
if not os.path.isfile(t.template_path):
self._logger.fatal(__name__, f'Template not found: {t.template_path}')
with open(t.template_path) as template:
t.file_content = template.read()
template.close()
if t.file_content == '':
self._logger.fatal(__name__, f'Template is empty: {t.template_path}')
self._logger.trace(__name__, f'Stopped {__name__}._read_templates')
def _create_dist_path(self):
self._logger.trace(__name__, f'Started {__name__}._create_dist_path')
if os.path.isdir(self._dist_path):
try:
shutil.rmtree(self._dist_path)
self._logger.info(__name__, f'Deleted {self._dist_path}')
except Exception as e:
self._logger.fatal(__name__, f'Cannot delete old dist directory', e)
if not os.path.isdir(self._dist_path):
try:
os.makedirs(self._dist_path)
self._logger.debug(__name__, f'Created directories: {self._dist_path}')
self._logger.info(__name__, f'Created dist directory')
except Exception as e:
self._logger.fatal(__name__, f'Cannot create dist directory', e)
self._logger.trace(__name__, f'Stopped {__name__}._create_dist_path')
@staticmethod
def _get_template_name_from_dirs(file: str) -> str:
dirs = os.path.dirname(file).split('/')
for d in dirs:
if d.__contains__('.'):
dirs.remove(d)
if len(dirs) == 0:
return os.path.basename(file)
else:
return '.'.join(dirs)
def _write_templates(self):
self._logger.trace(__name__, f'Started {__name__}._write_templates')
for template in self._settings:
for file in self._included_files:
if os.path.basename(file) == '__init__.py' and file not in self._excluded_files:
template_name = template.name
if template.name == '*' or template.name == '':
template_name = self._get_template_name_from_dirs(file)
else:
name = self._get_template_name_from_dirs(file)
if name.__contains__('.'):
if template.name != name.split('.')[len(name.split('.')) - 1]:
continue
else:
if template.name != name:
continue
try:
module_file_lines: list[str] = []
module_py_lines: list[str] = []
imports = ''
with open(file, 'r') as py_file:
module_file_lines = py_file.readlines()
py_file.close()
if len(module_file_lines) == 0:
with open(file, 'w+') as py_file:
py_file.write(self._get_template_output(template, template_name, '# imports:'))
py_file.close()
self._logger.debug(__name__, f'Written to {file}')
else:
is_started = False
for line in module_file_lines:
if line.__contains__('# imports'):
is_started = True
if (line.__contains__('from') or line.__contains__('import')) and is_started:
module_py_lines.append(line.replace('\n', ''))
if len(module_py_lines) > 0:
imports = '\n'.join(module_py_lines)
with open(file, 'w+') as py_file:
py_file.write(self._get_template_output(template, template_name, imports))
py_file.close()
self._logger.debug(__name__, f'Written to {file}')
except Exception as e:
self._logger.error(__name__, f'Cannot write to file: {file}', e)
self._logger.info(__name__, f'Written to all included modules')
self._logger.trace(__name__, f'Stopped {__name__}._write_templates')
def _copy_all_included_files(self):
self._logger.trace(__name__, f'Started {__name__}._copy_all_included_files')
dist_path = self._dist_path
if self._dist_path.endswith('/'):
dist_path = dist_path[:len(dist_path) - 1]
for file in self._included_files:
is_file_excluded = False
if file in self._excluded_files:
is_file_excluded = True
else:
for excluded in self._excluded_files:
if file.__contains__(excluded):
is_file_excluded = True
if not is_file_excluded:
output_file = ''
if file.startswith('..'):
output_file = file.replace('..', '')
elif file.startswith('.'):
output_file = file.replace('.', '', 1)
output_file = f'{dist_path}{output_file}'
output_path = os.path.dirname(output_file)
try:
if not os.path.isdir(output_path):
os.makedirs(output_path)
except Exception as e:
self._logger.error(__name__, f'Cannot create directories: {output_path}', e)
try:
shutil.copy(file, output_file)
except Exception as e:
self._logger.error(__name__, f'Cannot copy file: {file} to {output_path}', e)
self._logger.debug(__name__, f'Copied {file} to {output_path}')
self._logger.info(__name__, f'Copied all included files')
self._logger.trace(__name__, f'Stopped {__name__}._copy_all_included_files')
def include(self, path: str):
self._logger.trace(__name__, f'Started {__name__}.include')
self._included_files.append(path)
self._logger.trace(__name__, f'Stopped {__name__}.include')
def exclude(self, path: str):
self._logger.trace(__name__, f'Started {__name__}.exclude')
self._excluded_files.append(path)
self._logger.trace(__name__, f'Stopped {__name__}.exclude')
def init(self, args: tuple):
self._logger: LoggerBase = args[0]
self._source_path: str = args[1]
self._dist_path: str = args[2]
self._settings: list[Template] = args[3]
self._logger.header(f'{__name__}:')
def create(self):
self._logger.trace(__name__, f'Started {__name__}.create')
if not self._dist_path.endswith('/'):
self._dist_path += '/'
self._read_source_path()
self._read_templates()
self._create_dist_path()
self._logger.trace(__name__, f'Stopped {__name__}.create')
def publish(self):
self._logger.trace(__name__, f'Started {__name__}.publish')
self._write_templates()
self._copy_all_included_files()
self._logger.trace(__name__, f'Stopped {__name__}.publish')