2022-02-06 22:58:43 +01:00
|
|
|
from typing import List, Optional, Union, Dict
|
|
|
|
from pathlib import Path
|
|
|
|
import yaml
|
|
|
|
import json
|
2022-02-06 22:37:41 +01:00
|
|
|
from .enums import NamingScheme
|
2022-02-05 22:40:10 +01:00
|
|
|
from .generic_text import GenericText
|
2022-02-06 15:09:25 +01:00
|
|
|
from .formatterif import Config
|
|
|
|
from .git_version_info import GitVersionInfo
|
2022-02-04 11:39:15 +01:00
|
|
|
|
|
|
|
|
2022-02-06 21:25:52 +01:00
|
|
|
class VersionInfo:
|
|
|
|
def __init__(self):
|
|
|
|
self._repo_version: Optional[GitVersionInfo] = None
|
|
|
|
self._pytex_version: Optional[GitVersionInfo] = None
|
|
|
|
|
|
|
|
@property
|
|
|
|
def pytex_version(self) -> Optional[GitVersionInfo]:
|
|
|
|
if self._pytex_version is None:
|
|
|
|
return None
|
|
|
|
else:
|
|
|
|
return self._pytex_version
|
|
|
|
|
|
|
|
@property
|
|
|
|
def repo_version(self) -> Optional[GitVersionInfo]:
|
|
|
|
if self._repo_version is None:
|
|
|
|
return None
|
|
|
|
else:
|
|
|
|
return self._repo_version
|
|
|
|
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
class FormattingConfig(Config):
|
2022-02-04 11:39:15 +01:00
|
|
|
def __init__(self):
|
2022-02-05 23:54:45 +01:00
|
|
|
self._naming_scheme: Optional[Union[NamingScheme, str]] = None
|
2022-02-06 22:37:41 +01:00
|
|
|
self._license: Optional[GenericText] = None
|
2022-02-06 16:52:24 +01:00
|
|
|
self._description: Optional[str] = None
|
2022-02-04 11:39:15 +01:00
|
|
|
|
2022-02-05 23:54:45 +01:00
|
|
|
self._include_extra_header: Optional[bool] = None
|
|
|
|
self._include_build_time: Optional[bool] = None
|
|
|
|
self._include_pytex_version: Optional[bool] = None
|
|
|
|
self._include_pytex_info_text: Optional[bool] = None
|
|
|
|
self._include_repo_version: Optional[bool] = None
|
|
|
|
self._include_repo_info_text: Optional[bool] = None
|
2022-02-06 22:29:44 +01:00
|
|
|
self._include_time: Optional[bool] = None
|
2022-02-04 11:39:15 +01:00
|
|
|
|
2022-02-06 15:28:04 +01:00
|
|
|
self._extra_header: Optional[GenericText] = None
|
2022-02-05 22:40:10 +01:00
|
|
|
self._author: Optional[str] = None
|
2022-02-05 23:54:45 +01:00
|
|
|
self._version: Optional[str] = None
|
2022-02-05 22:40:10 +01:00
|
|
|
self._pytex_info_text: Optional[GenericText] = None
|
|
|
|
self._repo_info_text: Optional[GenericText] = None
|
|
|
|
|
2022-02-06 20:38:14 +01:00
|
|
|
self._include_drv: Optional[bool] = None
|
|
|
|
self._include_ins: Optional[bool] = None
|
2022-02-06 22:34:43 +01:00
|
|
|
self._docstrip_guards: Optional[List[str]] = None
|
|
|
|
|
|
|
|
self._doc_dependencies: Optional[List[str]] = None
|
|
|
|
self._tex_dependencies: Optional[List[str]] = None
|
2022-02-06 15:09:25 +01:00
|
|
|
|
2022-02-06 16:03:56 +01:00
|
|
|
@classmethod
|
2022-02-06 22:58:43 +01:00
|
|
|
def from_yaml(cls, content: Path):
|
|
|
|
with open(content, 'r') as config:
|
|
|
|
content: Dict = yaml.safe_load(config)
|
|
|
|
return cls.from_json(content)
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def from_json(cls, content: Union[Path, Dict]):
|
|
|
|
if isinstance(content, Path):
|
|
|
|
with open(content, 'r') as config:
|
|
|
|
content: Dict = json.load(config)
|
|
|
|
|
2022-02-06 16:03:56 +01:00
|
|
|
|
2022-02-06 22:37:41 +01:00
|
|
|
def to_yaml(self) -> str:
|
|
|
|
pass
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def naming_scheme(self) -> NamingScheme:
|
|
|
|
if self._naming_scheme is None:
|
|
|
|
return NamingScheme.prepend_author
|
|
|
|
else:
|
|
|
|
return self._naming_scheme
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@naming_scheme.setter
|
|
|
|
def naming_scheme(self, naming_scheme: NamingScheme):
|
|
|
|
self._naming_scheme = naming_scheme
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
2022-02-06 22:37:41 +01:00
|
|
|
def license(self) -> GenericText:
|
2022-02-06 15:09:25 +01:00
|
|
|
if self._license is None:
|
2022-02-06 22:37:41 +01:00
|
|
|
return GenericText([])
|
2022-02-06 15:09:25 +01:00
|
|
|
else:
|
|
|
|
return self._license
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@license.setter
|
|
|
|
def license(self, license: GenericText):
|
|
|
|
self._license = license
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_extra_header(self) -> bool:
|
|
|
|
if self._include_extra_header is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_extra_header
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_extra_header.setter
|
|
|
|
def include_extra_header(self, include: bool):
|
|
|
|
self._include_extra_header = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_build_time(self) -> bool:
|
|
|
|
if self._include_build_time is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_build_time
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_build_time.setter
|
|
|
|
def include_build_time(self, include: bool):
|
|
|
|
self._include_build_time = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_pytex_version(self) -> bool:
|
|
|
|
if self._include_pytex_version is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_pytex_version
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_pytex_version.setter
|
|
|
|
def include_pytex_version(self, include: bool):
|
|
|
|
self._include_pytex_version = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_pytex_info_text(self) -> bool:
|
|
|
|
if self._include_pytex_info_text is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_pytex_info_text
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_pytex_info_text.setter
|
|
|
|
def include_pytex_info_text(self, include: bool):
|
|
|
|
self._include_pytex_info_text = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_repo_version(self) -> bool:
|
|
|
|
if self._include_repo_version is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_repo_version
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_repo_version.setter
|
|
|
|
def include_repo_version(self, include: bool):
|
|
|
|
self._include_repo_version = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_repo_info_text(self) -> bool:
|
|
|
|
if self._include_repo_info_text is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_repo_info_text
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_repo_info_text.setter
|
|
|
|
def include_repo_info_text(self, include: bool):
|
|
|
|
self._include_repo_info_text = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
2022-02-06 15:28:04 +01:00
|
|
|
def extra_header(self) -> GenericText:
|
2022-02-06 15:09:25 +01:00
|
|
|
if self._extra_header is None:
|
2022-02-06 15:28:04 +01:00
|
|
|
return GenericText([])
|
2022-02-06 15:09:25 +01:00
|
|
|
else:
|
|
|
|
return self._extra_header
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@extra_header.setter
|
|
|
|
def extra_header(self, extra_header: GenericText):
|
|
|
|
self._extra_header = extra_header
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def author(self) -> str:
|
|
|
|
if self._author is None:
|
|
|
|
return "MISSING AUTHOR"
|
|
|
|
else:
|
|
|
|
return self._author
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@author.setter
|
|
|
|
def author(self, author: str):
|
|
|
|
self._author = author
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def version(self) -> str:
|
|
|
|
if self._version is None:
|
|
|
|
return "0.0.0"
|
|
|
|
else:
|
|
|
|
return self._version
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@version.setter
|
|
|
|
def version(self, version: str):
|
|
|
|
self._version = version
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def pytex_info_text(self) -> GenericText:
|
|
|
|
if self._pytex_info_text is None:
|
|
|
|
return GenericText([])
|
|
|
|
else:
|
|
|
|
return self._pytex_info_text
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@pytex_info_text.setter
|
|
|
|
def pytex_info_text(self, info_text: GenericText):
|
|
|
|
self._pytex_info_text = info_text
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def repo_info_text(self) -> GenericText:
|
|
|
|
if self._repo_info_text is None:
|
|
|
|
return GenericText([])
|
|
|
|
else:
|
|
|
|
return self._repo_info_text
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@repo_info_text.setter
|
|
|
|
def repo_info_text(self, info_text: GenericText):
|
|
|
|
self._repo_info_text = info_text
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_drv(self) -> bool:
|
|
|
|
if self._include_drv is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_drv
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_drv.setter
|
|
|
|
def include_drv(self, include: bool):
|
|
|
|
self._include_drv = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
|
|
|
def include_ins(self) -> bool:
|
|
|
|
if self._include_ins is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_ins
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_ins.setter
|
|
|
|
def include_ins(self, include):
|
|
|
|
self._include_ins = include
|
|
|
|
|
2022-02-06 15:09:25 +01:00
|
|
|
@property
|
2022-02-06 22:58:43 +01:00
|
|
|
def docstrip_guards(self) -> List[str]:
|
2022-02-06 22:34:43 +01:00
|
|
|
if self._docstrip_guards is None:
|
2022-02-06 15:09:25 +01:00
|
|
|
return []
|
|
|
|
else:
|
2022-02-06 22:34:43 +01:00
|
|
|
return self._docstrip_guards
|
2022-02-06 15:09:25 +01:00
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@docstrip_guards.setter
|
|
|
|
def docstrip_guards(self, guards: List[str]):
|
|
|
|
self._docstrip_guards = guards
|
|
|
|
|
2022-02-06 16:52:24 +01:00
|
|
|
@property
|
|
|
|
def description(self) -> str:
|
|
|
|
if self._description is None:
|
|
|
|
return ''
|
|
|
|
else:
|
|
|
|
return self._description
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@description.setter
|
|
|
|
def description(self, description: str):
|
|
|
|
self._description = description
|
|
|
|
|
2022-02-06 22:29:44 +01:00
|
|
|
@property
|
|
|
|
def include_time(self) -> bool:
|
|
|
|
if self._include_time is None:
|
|
|
|
return False
|
|
|
|
else:
|
|
|
|
return self._include_time
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@include_time.setter
|
|
|
|
def include_time(self, include: bool):
|
|
|
|
self._include_time = include
|
|
|
|
|
2022-02-06 22:34:43 +01:00
|
|
|
@property
|
|
|
|
def doc_dependencies(self) -> List[str]:
|
|
|
|
if self._doc_dependencies is None:
|
|
|
|
return []
|
|
|
|
else:
|
|
|
|
return self._doc_dependencies
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@doc_dependencies.setter
|
|
|
|
def doc_dependencies(self, dependencies: List[str]):
|
|
|
|
self._doc_dependencies = dependencies
|
|
|
|
|
2022-02-06 22:34:43 +01:00
|
|
|
@property
|
|
|
|
def tex_dependencies(self) -> List[str]:
|
|
|
|
if self._tex_dependencies is None:
|
|
|
|
return []
|
|
|
|
else:
|
|
|
|
return self._tex_dependencies
|
|
|
|
|
2022-02-06 22:58:43 +01:00
|
|
|
@tex_dependencies.setter
|
|
|
|
def tex_dependencies(self, dependencies: List[str]):
|
|
|
|
self._tex_dependencies = dependencies
|
|
|
|
|
2022-02-04 11:39:15 +01:00
|
|
|
|
2022-02-04 11:46:06 +01:00
|
|
|
class DocFormattingConfig:
|
2022-02-04 11:39:15 +01:00
|
|
|
def __init__(self):
|
|
|
|
self._documents: Optional[List[str]] = None
|
|
|
|
self._dependencies: Optional[List[str]] = None
|