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

testgres/postgres_configuration/__init__.py

@@ -7,6 +7,16 @@ from .implementation.v00.configuration_std import PostgresConfiguration_Std as P
 from .implementation.v00.configuration_std import PostgresConfigurationReader_Std as PostgresConfigurationReader
 
 from .implementation.v00.configuration_std import PostgresConfigurationWriter_Std as PostgresConfigurationWriter
+
+from .abstract.v00.configuration import PostgresConfigurationOption
+from .abstract.v00.configuration import PostgresConfigurationInclude
+from .abstract.v00.configuration import PostgresConfigurationIncludeIfExists
+from .abstract.v00.configuration import PostgresConfigurationComment
+from .abstract.v00.configuration import PostgresConfigurationOptions
+from .abstract.v00.configuration import PostgresConfigurationFiles
+from .abstract.v00.configuration import AddIncludeIfExistsRule
+from .abstract.v00.configuration import PostgresConfigurationSetOptionValueResult
+from .abstract.v00.configuration import PostgresConfigurationSetOptionValueEventID
 # fmt: on
 
 # //////////////////////////////////////////////////////////////////////////////
@@ -16,6 +26,15 @@ __all__ = [
     "PostgresConfiguration",
     "PostgresConfigurationReader",
     "PostgresConfigurationWriter",
+    "PostgresConfigurationOption",
+    "PostgresConfigurationInclude",
+    "PostgresConfigurationIncludeIfExists",
+    "PostgresConfigurationComment",
+    "PostgresConfigurationOptions",
+    "PostgresConfigurationFiles",
+    "AddIncludeIfExistsRule",
+    "PostgresConfigurationSetOptionValueResult",
+    "PostgresConfigurationSetOptionValueEventID",
 ]
 
 

testgres/postgres_configuration/abstract/v00/configuration.py

@@ -8,6 +8,15 @@ from ...core.raise_error import RaiseError
 import typing
 import enum
 
+# //////////////////////////////////////////////////////////////////////////////
+# AddIncludeIfExistsRule
+
+
+class AddIncludeIfExistsRule(enum.Enum):
+    without_file = 0
+    with_file = 1
+
+
 # //////////////////////////////////////////////////////////////////////////////
 # class PostgresConfigurationObject
 
@@ -102,12 +111,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 +140,7 @@ class PostgresConfigurationOptionsIterator(
     def __iter__(self) -> PostgresConfigurationOptionsIterator:
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
+    # --------------------------------------------------------------------
     def __next__(self) -> PostgresConfigurationOption:
         RaiseError.MethodIsNotImplemented(__class__, "__next__")
 
@@ -161,7 +175,31 @@ 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")
+
+
+# //////////////////////////////////////////////////////////////////////////////
+# class PostgresConfigurationIncludeIfExists
+
+
+class PostgresConfigurationIncludeIfExists(PostgresConfigurationElement):
+    def __init__(self):
+        super().__init__()
+
+    # interface ----------------------------------------------------------
+    def get_File(self) -> typing.Optional[PostgresConfigurationFile]:
+        RaiseError.MethodIsNotImplemented(__class__, "get_File")
+
+    # --------------------------------------------------------------------
+    def Delete(
+        self,
+        withLine: bool,
+    ) -> None:
         assert type(withLine) is bool
         RaiseError.MethodIsNotImplemented(__class__, "Delete")
 
@@ -180,7 +218,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 +228,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,13 +241,28 @@ 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 != ""
         assert (offset is None) or (type(offset) is int)
         RaiseError.MethodIsNotImplemented(__class__, "AddInclude")
 
+    # --------------------------------------------------------------------
+    def AddIncludeIfExists(
+        self,
+        path: str,
+        offset: typing.Optional[int],
+        rule: AddIncludeIfExistsRule,
+    ) -> PostgresConfigurationIncludeIfExists:
+        assert type(path) is str
+        assert path != ""
+        assert (offset is None) or (type(offset) is int)
+        assert type(rule) is AddIncludeIfExistsRule
+        RaiseError.MethodIsNotImplemented(__class__, "AddIncludeIfExists")
+
     # --------------------------------------------------------------------
     def Clear(self) -> None:
         RaiseError.MethodIsNotImplemented(__class__, "Clear")
@@ -224,6 +282,7 @@ class PostgresConfigurationFileLinesIterator(
     def __iter__(self) -> PostgresConfigurationFileLinesIterator:
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
+    # --------------------------------------------------------------------
     def __next__(self) -> PostgresConfigurationFileLine:
         RaiseError.MethodIsNotImplemented(__class__, "__next__")
 
@@ -270,23 +329,44 @@ 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")
 
+    # --------------------------------------------------------------------
+    def AddIncludeIfExists(
+        self,
+        path: str,
+        rule: AddIncludeIfExistsRule,
+    ) -> PostgresConfigurationIncludeIfExists:
+        assert type(path) is str
+        assert path != ""
+        assert type(rule) is AddIncludeIfExistsRule
+        RaiseError.MethodIsNotImplemented(__class__, "AddIncludeIfExists")
+
     # --------------------------------------------------------------------
     #
     # Method for inserting, updating and deleting of an option.
@@ -299,7 +379,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 +395,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 +426,7 @@ class PostgresConfigurationFilesIterator(typing.Iterator[PostgresConfigurationFi
     def __iter__(self) -> PostgresConfigurationFilesIterator:
         RaiseError.MethodIsNotImplemented(__class__, "__iter__")
 
+    # --------------------------------------------------------------------
     def __next__(self) -> PostgresConfigurationFile:
         RaiseError.MethodIsNotImplemented(__class__, "__next__")
 
@@ -360,7 +448,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 +465,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 +496,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 +511,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