testgres.postgres-configuration 0.2.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

testgres/postgres_configuration/abstract/v00/configuration.py

@@ -21,7 +21,7 @@ class PostgresConfigurationObject:
         RaiseError.MethodIsNotImplemented(__class__, "get_Configuration")
 
     # --------------------------------------------------------------------
-    def get_Parent(self) -> PostgresConfigurationObject:
+    def get_Parent(self) -> typing.Optional[PostgresConfigurationObject]:
         RaiseError.MethodIsNotImplemented(__class__, "get_Parent")
 
 
@@ -49,7 +49,7 @@ class PostgresConfigurationSetOptionValueResult:
 
     # interface -----------------------------------------------------------
     @property
-    def Option(self) -> PostgresConfigurationOption:
+    def Option(self) -> typing.Optional[PostgresConfigurationOption]:
         RaiseError.GetPropertyIsNotImplemented(__class__, "Option")
 
     # ---------------------------------------------------------------------
@@ -80,7 +80,7 @@ class PostgresConfigurationComment(PostgresConfigurationElement):
         RaiseError.MethodIsNotImplemented(__class__, "get_Text")
 
     # --------------------------------------------------------------------
-    def Delete(self, withLineIfLast: bool):
+    def Delete(self, withLineIfLast: bool) -> None:
         assert type(withLineIfLast) is bool
         RaiseError.MethodIsNotImplemented(__class__, "Delete")
 
@@ -144,7 +144,7 @@ class PostgresConfigurationOptions(typing.Iterable[PostgresConfigurationOption])
         RaiseError.MethodIsNotImplemented(__class__, "__len__")
 
     # --------------------------------------------------------------------
-    def __iter__(self) -> PostgresConfigurationFileLinesIterator:
+    def __iter__(self) -> PostgresConfigurationOptionsIterator:
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
 
@@ -161,7 +161,7 @@ class PostgresConfigurationInclude(PostgresConfigurationElement):
         RaiseError.MethodIsNotImplemented(__class__, "get_File")
 
     # --------------------------------------------------------------------
-    def Delete(self, withLine: bool):
+    def Delete(self, withLine: bool) -> None:
         assert type(withLine) is bool
         RaiseError.MethodIsNotImplemented(__class__, "Delete")
 

testgres/postgres_configuration/core/bugcheck_error.py

@@ -9,7 +9,9 @@ import typing
 
 class BugCheckError:
     @staticmethod
-    def UnkObjectDataType(objectType: type):
+    def UnkObjectDataType(
+        objectType: type,
+    ) -> typing.NoReturn:
         assert objectType is not None
         assert type(objectType) is type
 
@@ -18,7 +20,10 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def MultipleDefOfOptionIsFound(optName: str, count: int):
+    def MultipleDefOfOptionIsFound(
+        optName: str,
+        count: int,
+    ) -> typing.NoReturn:
         assert type(optName) is str
         assert type(count) is int
 
@@ -31,7 +36,10 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def UnkOptObjectDataType(optName: str, optDataType: type):
+    def UnkOptObjectDataType(
+        optName: str,
+        optDataType: type,
+    ) -> typing.NoReturn:
         assert type(optName) is str
         assert type(optDataType) is type
 
@@ -44,7 +52,10 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def MultipleDefOfFileIsFound(fileName: str, count: int):
+    def MultipleDefOfFileIsFound(
+        fileName: str,
+        count: int,
+    ) -> typing.NoReturn:
         assert type(fileName) is str
         assert type(count) is int
 
@@ -57,7 +68,10 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def UnkFileObjectDataType(fileName: str, fileDataType: type):
+    def UnkFileObjectDataType(
+        fileName: str,
+        fileDataType: type,
+    ) -> typing.NoReturn:
         assert type(fileName) is str
         assert type(fileDataType) is type
 
@@ -68,7 +82,10 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def UnkFileDataStatus(filePath: str, fileStatus: typing.Any):
+    def UnkFileDataStatus(
+        filePath: str,
+        fileStatus: typing.Any,
+    ) -> typing.NoReturn:
         assert type(filePath) is str
         assert fileStatus is not None
 
@@ -79,7 +96,10 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def FileIsNotFoundInIndex(fileKey: str, filePath: str):
+    def FileIsNotFoundInIndex(
+        fileKey: str,
+        filePath: str,
+    ) -> typing.NoReturn:
         assert type(fileKey) is str
         assert type(filePath) is str
 
@@ -90,7 +110,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionIsNotFoundInIndex(optName: str):
+    def OptionIsNotFoundInIndex(
+        optName: str,
+    ) -> typing.NoReturn:
         assert type(optName) is str
 
         errMsg = "[BUG CHECK] Option [{0}] is not found in index.".format(optName)
@@ -98,7 +120,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionIsNotFoundInFileLine(optName: str):
+    def OptionIsNotFoundInFileLine(
+        optName: str,
+    ) -> typing.NoReturn:
         assert type(optName) is str
 
         errMsg = "[BUG CHECK] Option [{0}] is not found in file line.".format(optName)
@@ -106,25 +130,27 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def CommentIsNotFoundInFileLine():
+    def CommentIsNotFoundInFileLine() -> typing.NoReturn:
         errMsg = "[BUG CHECK] Comment is not found in file line."
         raise Exception(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
-    def IncludeIsNotFoundInFileLine():
+    def IncludeIsNotFoundInFileLine() -> typing.NoReturn:
         errMsg = "[BUG CHECK] Include is not found in file line."
         raise Exception(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
-    def FileLineIsNotFoundInFile():
+    def FileLineIsNotFoundInFile() -> typing.NoReturn:
         errMsg = "[BUG CHECK] FileLine is not found in file."
         raise Exception(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToPrepareSetValueIsNotDefined(name: str):
+    def OptionHandlerToPrepareSetValueIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = "[BUG CHECK] OptionHandlerToPrepareSetValue for [{0}] is not defined.".format(
@@ -134,7 +160,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToPrepareGetValueIsNotDefined(name: str):
+    def OptionHandlerToPrepareGetValueIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = "[BUG CHECK] OptionHandlerToPrepareGetValue for [{0}] is not defined.".format(
@@ -144,7 +172,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToPrepareSetValueItemIsNotDefined(name: str):
+    def OptionHandlerToPrepareSetValueItemIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = "[BUG CHECK] OptionHandlerToPrepareSetValueItem for [{0}] is not defined.".format(
@@ -154,7 +184,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToSetValueIsNotDefined(name: str):
+    def OptionHandlerToSetValueIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = "[BUG CHECK] OptionHandlerToSetValue for [{0}] is not defined.".format(
@@ -164,7 +196,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToGetValueIsNotDefined(name: str):
+    def OptionHandlerToGetValueIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = "[BUG CHECK] OptionHandlerToGetValue for [{0}] is not defined.".format(
@@ -174,7 +208,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToAddOptionIsNotDefined(name: str):
+    def OptionHandlerToAddOptionIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = (
@@ -186,7 +222,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToSetValueItemIsNotDefined(name: str):
+    def OptionHandlerToSetValueItemIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = (
@@ -198,7 +236,9 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def OptionHandlerToWriteIsNotDefined(name: str):
+    def OptionHandlerToWriteIsNotDefined(
+        name: str,
+    ) -> typing.NoReturn:
         assert type(name) is str
 
         errMsg = "[BUG CHECK] OptionHandlerToWrite for [{0}] is not defined.".format(
@@ -208,7 +248,11 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def UnexpectedSituation(bugcheckSrc: str, bugcheckPoint: str, explain: str):
+    def UnexpectedSituation(
+        bugcheckSrc: str,
+        bugcheckPoint: str,
+        explain: str,
+    ) -> typing.NoReturn:
         assert type(bugcheckSrc) is str
         assert type(bugcheckPoint) is str
         assert explain is None or type(explain) is str
@@ -227,7 +271,10 @@ class BugCheckError:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def UnknownOptionValueType(optionName: str, typeOfOptionValue: type):
+    def UnknownOptionValueType(
+        optionName: str,
+        typeOfOptionValue: type,
+    ) -> typing.NoReturn:
         assert type(optionName) is str
         assert optionName != ""
         assert type(typeOfOptionValue) is type

testgres/postgres_configuration/core/handlers.py

@@ -266,8 +266,8 @@ class OptionHandlerToAddOption(OptionHandler):
         super().__init__()
 
     # interface ----------------------------------------------------------
-    def AddOption(self, ctx: OptionHandlerCtxToSetValue) -> typing.Any:
-        assert type(ctx) is OptionHandlerCtxToSetValue
+    def AddOption(self, ctx: OptionHandlerCtxToAddOption) -> typing.Any:
+        assert type(ctx) is OptionHandlerCtxToAddOption
         RaiseError.MethodIsNotImplemented(__class__, "AddOption")
 
 

testgres/postgres_configuration/core/helpers.py

@@ -12,41 +12,40 @@ import typing
 
 
 class Helpers:
+    @staticmethod
     def ExtractOptionDataName(option: typing.Union[str, OptionData]) -> str:
         assert type(option) is str or type(option) is OptionData
 
-        typeOption = type(option)
-
-        if typeOption is str:
+        if type(option) is str:
             return option
 
-        if typeOption is OptionData:
+        if type(option) is OptionData:
             return option.m_Name
 
-        BugCheckError.UnkObjectDataType(typeOption)
+        BugCheckError.UnkObjectDataType(type(option))
 
     # --------------------------------------------------------------------
+    @staticmethod
     def ExtractFirstOptionFromIndexItem(
         optionName: str, indexItem: typing.Union[OptionData, typing.List[OptionData]]
     ) -> OptionData:
         assert type(optionName) is str
 
-        typeOfIndexItem = type(indexItem)
-
-        if typeOfIndexItem is OptionData:
+        if type(indexItem) is OptionData:
             assert indexItem.m_Name == optionName
             return indexItem
 
-        if typeOfIndexItem is list:
+        if type(indexItem) is list:
             assert len(indexItem) > 1
             assert indexItem[0] is not None
             assert type(indexItem[0]) is OptionData
             assert indexItem[0].m_Name == optionName
             return indexItem[0]
 
-        BugCheckError.UnkOptObjectDataType(optionName, typeOfIndexItem)
+        BugCheckError.UnkOptObjectDataType(optionName, type(indexItem))
 
     # --------------------------------------------------------------------
+    @staticmethod
     def DoesContainerContainsValue__NotNullAndExact(
         container: typing.Iterable, value: typing.Any
     ) -> bool:
@@ -64,6 +63,7 @@ class Helpers:
         return False
 
     # --------------------------------------------------------------------
+    @staticmethod
     def NormalizeFilePath(
         cfgOsOps: ConfigurationOsOps, baseFolder: str, filePath: str
     ) -> str:

testgres/postgres_configuration/core/model.py

@@ -195,8 +195,8 @@ class FileLineData(ObjectData):
 
 
 class FileStatus(enum.Enum):
-    IS_NEW: int = 0
-    EXISTS: int = 1
+    IS_NEW = 0
+    EXISTS = 1
 
 
 # //////////////////////////////////////////////////////////////////////////////
@@ -204,6 +204,8 @@ class FileStatus(enum.Enum):
 
 
 class FileData(ObjectData):
+    T_OPTIONS_BY_NAME = typing.Dict[str, OptionData]
+
     m_Parent: ConfigurationData
 
     m_Status: FileStatus
@@ -212,7 +214,7 @@ class FileData(ObjectData):
     m_Path: str
     m_Lines: typing.List[FileLineData]
 
-    m_OptionsByName: typing.Dict[str, OptionData]
+    m_OptionsByName: T_OPTIONS_BY_NAME
 
     # --------------------------------------------------------------------
     def __init__(self, parent: ConfigurationData, path: str):
@@ -256,15 +258,33 @@ class FileData(ObjectData):
 
 
 class ConfigurationData(ObjectData):
+    T_OPTION_OR_OPTIONS = typing.Union[
+        OptionData,
+        typing.List[OptionData],
+    ]
+
+    T_ALL_OPTIONS_BY_NAME = typing.Dict[
+        str,
+        T_OPTION_OR_OPTIONS,
+    ]
+
+    T_FILE_OR_FILES = typing.Union[
+        FileData,
+        typing.List[FileData],
+    ]
+
+    T_ALL_FILES_BY_NAME = typing.Dict[
+        str,
+        T_FILE_OR_FILES,
+    ]
+
     m_DataDir: str
     m_OsOps: ConfigurationOsOps
 
     m_Files: typing.List[FileData]
 
-    m_AllOptionsByName: typing.Dict[
-        str, typing.Union[OptionData, typing.List[OptionData]]
-    ]
-    m_AllFilesByName: typing.Dict[str, typing.Union[FileData, typing.List[FileData]]]
+    m_AllOptionsByName: T_ALL_OPTIONS_BY_NAME
+    m_AllFilesByName: T_ALL_FILES_BY_NAME
 
     # --------------------------------------------------------------------
     def __init__(self, data_dir: str, osOps: ConfigurationOsOps):