testgres.postgres-configuration 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

testgres/postgres_configuration/abstract/v00/configuration.py

@@ -102,12 +102,16 @@ class PostgresConfigurationOption(PostgresConfigurationElement):
         RaiseError.MethodIsNotImplemented(__class__, "get_Value")
 
     # --------------------------------------------------------------------
-    def set_Value(self, value: typing.Any) -> PostgresConfigurationSetOptionValueResult:
+    def set_Value(
+        self,
+        value: typing.Any,
+    ) -> PostgresConfigurationSetOptionValueResult:
         RaiseError.MethodIsNotImplemented(__class__, "set_Value")
 
     # --------------------------------------------------------------------
     def set_ValueItem(
-        self, value_item: typing.Any
+        self,
+        value_item: typing.Any,
     ) -> PostgresConfigurationSetOptionValueResult:
         assert value_item is not None
         RaiseError.MethodIsNotImplemented(__class__, "set_ValueItem")
@@ -127,6 +131,7 @@ class PostgresConfigurationOptionsIterator(
     def __iter__(self) -> PostgresConfigurationOptionsIterator:
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
+    # --------------------------------------------------------------------
     def __next__(self) -> PostgresConfigurationOption:
         RaiseError.MethodIsNotImplemented(__class__, "__next__")
 
@@ -161,7 +166,10 @@ class PostgresConfigurationInclude(PostgresConfigurationElement):
         RaiseError.MethodIsNotImplemented(__class__, "get_File")
 
     # --------------------------------------------------------------------
-    def Delete(self, withLine: bool) -> None:
+    def Delete(
+        self,
+        withLine: bool,
+    ) -> None:
         assert type(withLine) is bool
         RaiseError.MethodIsNotImplemented(__class__, "Delete")
 
@@ -180,7 +188,9 @@ class PostgresConfigurationFileLine(PostgresConfigurationObject):
 
     # --------------------------------------------------------------------
     def AddComment(
-        self, text: str, offset: typing.Optional[int]
+        self,
+        text: str,
+        offset: typing.Optional[int],
     ) -> PostgresConfigurationComment:
         assert type(text) is str
         assert (offset is None) or (type(offset) is int)
@@ -188,7 +198,10 @@ class PostgresConfigurationFileLine(PostgresConfigurationObject):
 
     # --------------------------------------------------------------------
     def AddOption(
-        self, name: str, value: typing.Any, offset: typing.Optional[int]
+        self,
+        name: str,
+        value: typing.Any,
+        offset: typing.Optional[int],
     ) -> PostgresConfigurationOption:
         assert type(name) is str
         assert name != ""
@@ -198,7 +211,9 @@ class PostgresConfigurationFileLine(PostgresConfigurationObject):
 
     # --------------------------------------------------------------------
     def AddInclude(
-        self, path: str, offset: typing.Optional[int]
+        self,
+        path: str,
+        offset: typing.Optional[int],
     ) -> PostgresConfigurationInclude:
         assert type(path) is str
         assert path != ""
@@ -224,6 +239,7 @@ class PostgresConfigurationFileLinesIterator(
     def __iter__(self) -> PostgresConfigurationFileLinesIterator:
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
+    # --------------------------------------------------------------------
     def __next__(self) -> PostgresConfigurationFileLine:
         RaiseError.MethodIsNotImplemented(__class__, "__next__")
 
@@ -270,19 +286,29 @@ class PostgresConfigurationFile(PostgresConfigurationObject):
         RaiseError.MethodIsNotImplemented(__class__, "AddEmptyLine")
 
     # --------------------------------------------------------------------
-    def AddComment(self, text: str) -> PostgresConfigurationComment:
+    def AddComment(
+        self,
+        text: str,
+    ) -> PostgresConfigurationComment:
         assert type(text) is str
         RaiseError.MethodIsNotImplemented(__class__, "AddComment")
 
     # --------------------------------------------------------------------
-    def AddOption(self, name: str, value: typing.Any) -> PostgresConfigurationOption:
+    def AddOption(
+        self,
+        name: str,
+        value: typing.Any,
+    ) -> PostgresConfigurationOption:
         assert type(name) is str
         assert name != ""
         assert value is not None
         RaiseError.MethodIsNotImplemented(__class__, "AddOption")
 
     # --------------------------------------------------------------------
-    def AddInclude(self, path: str) -> PostgresConfigurationInclude:
+    def AddInclude(
+        self,
+        path: str,
+    ) -> PostgresConfigurationInclude:
         assert type(path) is str
         assert path != ""
         RaiseError.MethodIsNotImplemented(__class__, "AddInclude")
@@ -299,7 +325,9 @@ class PostgresConfigurationFile(PostgresConfigurationObject):
     #  PostgresConfigurationSetOptionValueResult object.
     #
     def SetOptionValue(
-        self, name: str, value: typing.Any
+        self,
+        name: str,
+        value: typing.Any,
     ) -> PostgresConfigurationSetOptionValueResult:
         assert type(name) is str
         assert name != ""
@@ -313,13 +341,18 @@ class PostgresConfigurationFile(PostgresConfigurationObject):
     #  - Value of option.
     #  - None if option is not found in this file.
     #
-    def GetOptionValue(self, name: str) -> typing.Any:
+    def GetOptionValue(
+        self,
+        name: str,
+    ) -> typing.Any:
         assert type(name) is str
         RaiseError.MethodIsNotImplemented(__class__, "GetOptionValue")
 
     # --------------------------------------------------------------------
     def SetOptionValueItem(
-        self, name: str, value_item: typing.Any
+        self,
+        name: str,
+        value_item: typing.Any,
     ) -> PostgresConfigurationSetOptionValueResult:
         assert type(name) is str
         assert name != ""
@@ -339,6 +372,7 @@ class PostgresConfigurationFilesIterator(typing.Iterator[PostgresConfigurationFi
     def __iter__(self) -> PostgresConfigurationFilesIterator:
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
+    # --------------------------------------------------------------------
     def __next__(self) -> PostgresConfigurationFile:
         RaiseError.MethodIsNotImplemented(__class__, "__next__")
 
@@ -360,7 +394,10 @@ class PostgresConfigurationFiles(typing.Iterable[PostgresConfigurationFile]):
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
     # --------------------------------------------------------------------
-    def GetFileByName(self, file_name: str) -> PostgresConfigurationFile:
+    def GetFileByName(
+        self,
+        file_name: str,
+    ) -> PostgresConfigurationFile:
         assert file_name is not None
         RaiseError.MethodIsNotImplemented(__class__, "GetFileByName")
 
@@ -374,13 +411,20 @@ class PostgresConfiguration(PostgresConfigurationObject):
         pass
 
     # interface ----------------------------------------------------------
-    def AddTopLevelFile(self, path: str) -> PostgresConfigurationFile:
+    def AddTopLevelFile(
+        self,
+        path: str,
+    ) -> PostgresConfigurationFile:
         assert type(path) is str
         assert path != ""
         RaiseError.MethodIsNotImplemented(__class__, "AddTopLevelFile")
 
     # --------------------------------------------------------------------
-    def AddOption(self, name: str, value: typing.Any) -> PostgresConfigurationOption:
+    def AddOption(
+        self,
+        name: str,
+        value: typing.Any,
+    ) -> PostgresConfigurationOption:
         assert type(name) is str
         assert name != ""
         assert value is not None
@@ -398,7 +442,9 @@ class PostgresConfiguration(PostgresConfigurationObject):
     #  PostgresConfigurationSetOptionValueResult object.
     #
     def SetOptionValue(
-        self, name: str, value: typing.Any
+        self,
+        name: str,
+        value: typing.Any,
     ) -> PostgresConfigurationSetOptionValueResult:
         assert type(name) is str
         RaiseError.MethodIsNotImplemented(__class__, "SetOptionValue")
@@ -411,13 +457,18 @@ class PostgresConfiguration(PostgresConfigurationObject):
     #  - Value of option.
     #  - None if option is not found.
     #
-    def GetOptionValue(self, name: str) -> typing.Any:
+    def GetOptionValue(
+        self,
+        name: str,
+    ) -> typing.Any:
         assert type(name) is str
         RaiseError.MethodIsNotImplemented(__class__, "GetOptionValue")
 
     # --------------------------------------------------------------------
     def SetOptionValueItem(
-        self, name: str, value_item: typing.Any
+        self,
+        name: str,
+        value_item: typing.Any,
     ) -> PostgresConfigurationSetOptionValueResult:
         assert type(name) is str
         assert value_item is not None

testgres/postgres_configuration/core/bugcheck_error.py

@@ -1,6 +1,8 @@
 # //////////////////////////////////////////////////////////////////////////////
 # Postgres Pro. PostgreSQL Configuration Python Library.
 
+from ..exceptions import PostgresConfigBugCheckException
+
 import typing
 
 # //////////////////////////////////////////////////////////////////////////////
@@ -13,10 +15,12 @@ class BugCheckError:
         objectType: type,
     ) -> typing.NoReturn:
         assert objectType is not None
-        assert type(objectType) is type
+        assert isinstance(objectType, type)
 
-        errMsg = "[BUG CHECK] Unknown object data type [{0}].".format(objectType)
-        raise Exception(errMsg)
+        errMsg = "Unknown object data type [{0}].".format(
+            objectType,
+        )
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -27,12 +31,11 @@ class BugCheckError:
         assert type(optName) is str
         assert type(count) is int
 
-        errMsg = (
-            "[BUG CHECK] Multiple definitition of option [{0}] is found - {1}.".format(
-                optName, count
-            )
+        errMsg = "Multiple definitition of option [{0}] is found - {1}.".format(
+            optName,
+            count,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -41,14 +44,13 @@ class BugCheckError:
         optDataType: type,
     ) -> typing.NoReturn:
         assert type(optName) is str
-        assert type(optDataType) is type
+        assert isinstance(optDataType, type)
 
-        errMsg = (
-            "[BUG CHECK] Unknown type of the option object data [{0}] - {1}.".format(
-                optName, optDataType.__name__
-            )
+        errMsg = "Unknown type of the option object data [{0}] - {1}.".format(
+            optName,
+            optDataType.__name__,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -59,12 +61,11 @@ class BugCheckError:
         assert type(fileName) is str
         assert type(count) is int
 
-        errMsg = (
-            "[BUG CHECK] Multiple definitition of file [{0}] is found - {1}.".format(
-                fileName, count
-            )
+        errMsg = "Multiple definitition of file [{0}] is found - {1}.".format(
+            fileName,
+            count,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -73,12 +74,13 @@ class BugCheckError:
         fileDataType: type,
     ) -> typing.NoReturn:
         assert type(fileName) is str
-        assert type(fileDataType) is type
+        assert isinstance(fileDataType, type)
 
-        errMsg = "[BUG CHECK] Unknown type of the file object data [{0}] - {1}.".format(
-            fileName, fileDataType.__name__
+        errMsg = "Unknown type of the file object data [{0}] - {1}.".format(
+            fileName,
+            fileDataType.__name__,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -89,10 +91,11 @@ class BugCheckError:
         assert type(filePath) is str
         assert fileStatus is not None
 
-        errMsg = "[BUG CHECK] Unknown file data status [{0}] - {1}.".format(
-            filePath, fileStatus
+        errMsg = "Unknown file data status [{0}] - {1}.".format(
+            filePath,
+            fileStatus,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -103,10 +106,20 @@ class BugCheckError:
         assert type(fileKey) is str
         assert type(filePath) is str
 
-        errMsg = "[BUG CHECK] File [{0}][{1}] is not found in index.".format(
-            fileKey, filePath
+        errMsg = "File [{0}][{1}] is not found in index.".format(
+            fileKey,
+            filePath,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
+
+    # --------------------------------------------------------------------
+    @staticmethod
+    def FileIsAlreadyRegistered(
+        file_path: str,
+    ) -> typing.NoReturn:
+        errMsg = "File [{}] is already registered.".format(file_path)
+
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -115,8 +128,8 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(optName) is str
 
-        errMsg = "[BUG CHECK] Option [{0}] is not found in index.".format(optName)
-        raise Exception(errMsg)
+        errMsg = "Option [{0}] is not found in index.".format(optName)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -125,26 +138,26 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(optName) is str
 
-        errMsg = "[BUG CHECK] Option [{0}] is not found in file line.".format(optName)
-        raise Exception(errMsg)
+        errMsg = "Option [{0}] is not found in file line.".format(optName)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
     def CommentIsNotFoundInFileLine() -> typing.NoReturn:
-        errMsg = "[BUG CHECK] Comment is not found in file line."
-        raise Exception(errMsg)
+        errMsg = "Comment is not found in file line."
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
     def IncludeIsNotFoundInFileLine() -> typing.NoReturn:
-        errMsg = "[BUG CHECK] Include is not found in file line."
-        raise Exception(errMsg)
+        errMsg = "Include is not found in file line."
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
     def FileLineIsNotFoundInFile() -> typing.NoReturn:
-        errMsg = "[BUG CHECK] FileLine is not found in file."
-        raise Exception(errMsg)
+        errMsg = "FileLine is not found in file."
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -153,10 +166,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = "[BUG CHECK] OptionHandlerToPrepareSetValue for [{0}] is not defined.".format(
-            name
+        errMsg = "OptionHandlerToPrepareSetValue for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -165,10 +178,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = "[BUG CHECK] OptionHandlerToPrepareGetValue for [{0}] is not defined.".format(
-            name
+        errMsg = "OptionHandlerToPrepareGetValue for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -177,10 +190,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = "[BUG CHECK] OptionHandlerToPrepareSetValueItem for [{0}] is not defined.".format(
-            name
+        errMsg = "OptionHandlerToPrepareSetValueItem for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -189,10 +202,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = "[BUG CHECK] OptionHandlerToSetValue for [{0}] is not defined.".format(
-            name
+        errMsg = "OptionHandlerToSetValue for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -201,10 +214,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = "[BUG CHECK] OptionHandlerToGetValue for [{0}] is not defined.".format(
-            name
+        errMsg = "OptionHandlerToGetValue for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -213,12 +226,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = (
-            "[BUG CHECK] OptionHandlerToAddOption for [{0}] is not defined.".format(
-                name
-            )
+        errMsg = "OptionHandlerToAddOption for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -227,12 +238,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = (
-            "[BUG CHECK] OptionHandlerToSetValueItem for [{0}] is not defined.".format(
-                name
-            )
+        errMsg = "OptionHandlerToSetValueItem for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -241,10 +250,10 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(name) is str
 
-        errMsg = "[BUG CHECK] OptionHandlerToWrite for [{0}] is not defined.".format(
-            name
+        errMsg = "OptionHandlerToWrite for [{0}] is not defined.".format(
+            name,
         )
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -257,8 +266,9 @@ class BugCheckError:
         assert type(bugcheckPoint) is str
         assert explain is None or type(explain) is str
 
-        errMsg = "[BUG CHECK] Unexpected situation in [{0}][{1}].".format(
-            bugcheckSrc, bugcheckPoint
+        errMsg = "Unexpected situation in [{0}][{1}].".format(
+            bugcheckSrc,
+            bugcheckPoint,
         )
 
         if explain is not None and explain != "":
@@ -267,7 +277,7 @@ class BugCheckError:
 
         assert errMsg[-1] == "."
 
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
 
     # --------------------------------------------------------------------
     @staticmethod
@@ -277,13 +287,33 @@ class BugCheckError:
     ) -> typing.NoReturn:
         assert type(optionName) is str
         assert optionName != ""
-        assert type(typeOfOptionValue) is type
+        assert isinstance(typeOfOptionValue, type)
+
+        errMsg = "Unknown value type [{1}] of option [{0}].".format(
+            optionName,
+            typeOfOptionValue.__name__,
+        )
+
+        __class__.Helper__Raise(errMsg)
+
+    # --------------------------------------------------------------------
+    @staticmethod
+    def UnsupportedPgConfStrategy(
+        strategy: typing.Any,
+    ) -> typing.NoReturn:
 
-        errMsg = "[BUG CHECK] Unknown value type [{1}] of option [{0}].".format(
-            optionName, typeOfOptionValue.__name__
+        errMsg = "Unsupported data strategy {!r}.".format(
+            strategy,
         )
 
-        raise Exception(errMsg)
+        __class__.Helper__Raise(errMsg)
+
+    # Helper methods -----------------------------------------------------
+    @staticmethod
+    def Helper__Raise(msg: str) -> typing.NoReturn:
+        assert type(msg) is str
+        assert msg != ""
+        raise PostgresConfigBugCheckException(msg)
 
 
 # //////////////////////////////////////////////////////////////////////////////

testgres/postgres_configuration/core/data_verificator.py

@@ -9,7 +9,7 @@ from .raise_error import RaiseError
 
 class DataVerificator:
     @staticmethod
-    def CheckOptionName(name: str):
+    def CheckOptionName(name: str) -> None:
         if name is None:
             RaiseError.OptionNameIsNone()
 
@@ -20,6 +20,7 @@ class DataVerificator:
             RaiseError.OptionNameIsEmpty()
 
         # TODO: Add an extended verification of an option name
+        return
 
     # --------------------------------------------------------------------
     sm_InvalidCommentSymbols: str = "\n\r\0"
@@ -41,7 +42,7 @@ class DataVerificator:
 
     # --------------------------------------------------------------------
     @staticmethod
-    def CheckCommentText(text: str):
+    def CheckCommentText(text: str) -> None:
         assert text is not None
         assert type(text) is str
 
@@ -51,15 +52,18 @@ class DataVerificator:
             RaiseError.CommentTextContainsInvalidSymbols()
 
         # OK
+        return
 
     # --------------------------------------------------------------------
     @staticmethod
-    def CheckStringOfFilePath(text: str):
+    def CheckStringOfFilePath(text: str) -> None:
         assert text is not None
         assert type(text) is str
 
         if text == "":
             RaiseError.FilePathIsEmpty()
 
+        return
+
 
 # //////////////////////////////////////////////////////////////////////////////