PyFunceble-dev 4.2.28a1__py3-none-any.whl → 4.3.0a1__py3-none-any.whl

PyFunceble/config/loader.py

@@ -60,6 +60,7 @@ except ImportError:  # pragma: no cover ## Retro compatibility
     import importlib_resources as package_resources
 
 from box import Box
+from dotenv import load_dotenv
 from yaml.error import MarkedYAMLError
 
 import PyFunceble.cli.storage
@@ -69,6 +70,7 @@ from PyFunceble.downloader.iana import IANADownloader
 from PyFunceble.downloader.public_suffix import PublicSuffixDownloader
 from PyFunceble.downloader.user_agents import UserAgentsDownloader
 from PyFunceble.helpers.dict import DictHelper
+from PyFunceble.helpers.download import DownloadHelper
 from PyFunceble.helpers.environment_variable import EnvironmentVariableHelper
 from PyFunceble.helpers.file import FileHelper
 from PyFunceble.helpers.merge import Merge
@@ -86,31 +88,42 @@ class ConfigLoader:
             :code:`PYFUNCEBLE_AUTO_CONFIGURATION` environment variable.
     """
 
-    path_to_config: Optional[str] = None
+    _path_to_config: Optional[str] = None
+    _remote_config_location: Optional[str] = None
     path_to_default_config: Optional[str] = None
     path_to_overwrite_config: Optional[str] = None
 
     _custom_config: dict = {}
     _merge_upstream: bool = False
+    _config_dir: Optional[str] = None
 
     file_helper: FileHelper = FileHelper()
     dict_helper: DictHelper = DictHelper()
 
-    def __init__(self, merge_upstream: Optional[bool] = None) -> None:
+    def __init__(
+        self, merge_upstream: Optional[bool] = None, *, config_dir: Optional[str] = None
+    ) -> None:
         with package_resources.path(
             "PyFunceble.data.infrastructure",
             PyFunceble.storage.DISTRIBUTED_CONFIGURATION_FILENAME,
         ) as file_path:
             self.path_to_default_config = str(file_path)
 
+        if config_dir is not None:
+            self.config_dir = config_dir
+        else:
+            self.config_dir = PyFunceble.storage.CONFIG_DIRECTORY
+
         self.path_to_config = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY,
+            self.config_dir,
             PyFunceble.storage.CONFIGURATION_FILENAME,
         )
 
+        self.path_to_remote_config = None
+
         self.path_to_overwrite_config = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY,
-            PyFunceble.storage.CONFIGURATION_OVERWRITE_FILENAME,
+            self.config_dir,
+            ".PyFunceble.overwrite.yaml",
         )
 
         if merge_upstream is not None:
@@ -132,7 +145,7 @@ class ConfigLoader:
             result = func(self, *args, **kwargs)  # pylint: disable=not-callable
 
             if self.is_already_loaded():
-                self.start()
+                self.reload(keep_custom=True)
 
             return result
 
@@ -200,6 +213,44 @@ class ConfigLoader:
 
         return bool(PyFunceble.storage.CONFIGURATION)
 
+    @property
+    def config_dir(self) -> Optional[str]:
+        """
+        Provides the current state of the :code:`_config_dir` attribute.
+        """
+
+        return self._config_dir
+
+    @config_dir.setter
+    @reload_config
+    def config_dir(self, value: str) -> None:
+        """
+        Sets the configuration directory.
+
+        :param value:
+            The value to set.
+
+        :raise TypeError:
+            When value is not a :py:class:`str`.
+        """
+
+        if not isinstance(value, str):
+            raise TypeError(f"<value> should be {str}, {type(value)} given.")
+
+        self._config_dir = value
+
+    def set_config_dir(self, value: str) -> "ConfigLoader":
+        """
+        Sets the configuration directory.
+
+        :param value:
+            The value to set.
+        """
+
+        self.config_dir = value
+
+        return self
+
     @property
     def custom_config(self) -> dict:
         """
@@ -274,23 +325,44 @@ class ConfigLoader:
 
         return self
 
-    def config_file_exist(
-        self,
-    ) -> bool:  # pragma: no cover ## Existance checker already tested.
+    @property
+    def remote_config_location(self) -> Optional[str]:
         """
-        Checks if the config file exists.
+        Provides the current state of the :code:`_remote_config_location` attribute.
         """
 
-        return FileHelper(self.path_to_config).exists()
+        return self._remote_config_location
 
-    def default_config_file_exist(
-        self,
-    ) -> bool:  # pragma: no cover ## Existance checker already tested.
+    @remote_config_location.setter
+    def remote_config_location(self, value: Optional[str]) -> None:
         """
-        Checks if the default configuration file exists.
+        Updates the value of :code:`_remote_config_location` attribute.
+
+        :raise TypeError:
+            When :code:`value` is not a :py:class:`str`.
         """
 
-        return self.file_helper.set_path(self.path_to_default_config).exists()
+        if value is not None and not isinstance(value, str):
+            raise TypeError(f"<value> should be {str}, {type(value)} given.")
+
+        if not value.startswith("http") and not value.startswith("https"):
+            self.path_to_remote_config = os.path.realpath(value)
+        else:
+            self.path_to_remote_config = os.path.join(
+                self.config_dir,
+                ".PyFunceble.remote.yaml",
+            )
+
+        self._remote_config_location = value
+
+    def set_remote_config_location(self, value: Optional[str]) -> "ConfigLoader":
+        """
+        Updates the value of :code:`_remote_config_location` attribute.
+        """
+
+        self.remote_config_location = value
+
+        return self
 
     def install_missing_infrastructure_files(
         self,
@@ -347,9 +419,34 @@ class ConfigLoader:
 
             return config and "days_between_inactive_db_clean" in config
 
+        def download_remote_config(src: str, dest: str = None) -> None:
+            """
+            Downloads the remote configuration.
+
+            :param src:
+                The source to download from.
+            :param dest:
+                The destination to download
+            """
+
+            if src and (src.startswith("http") or src.startswith("https")):
+                if dest is None:
+                    destination = os.path.join(
+                        self.config_dir,
+                        os.path.basename(dest),
+                    )
+                else:
+                    destination = dest
+
+                DownloadHelper(src).download_text(destination=destination)
+
         if not self.is_already_loaded():
             self.install_missing_infrastructure_files()
             self.download_dynamic_infrastructure_files()
+            download_remote_config(
+                self.remote_config_location, self.path_to_remote_config
+            )
+            download_remote_config(self.path_to_config)
 
         try:
             config = self.dict_helper.from_yaml_file(self.path_to_config)
@@ -377,15 +474,22 @@ class ConfigLoader:
 
             self.dict_helper.set_subject(config).to_yaml_file(self.path_to_config)
 
+        if (
+            self.path_to_remote_config
+            and self.file_helper.set_path(self.path_to_remote_config).exists()
+        ):
+            remote_data = self.dict_helper.from_yaml_file(self.path_to_remote_config)
+
+            if isinstance(remote_data, dict):
+                config = Merge(remote_data).into(config)
+
         if self.file_helper.set_path(self.path_to_overwrite_config).exists():
             overwrite_data = self.dict_helper.from_yaml_file(
                 self.path_to_overwrite_config
             )
 
             if isinstance(overwrite_data, dict):
-                config = Merge(
-                    self.dict_helper.from_yaml_file(self.path_to_overwrite_config)
-                ).into(config)
+                config = Merge(overwrite_data).into(config)
         else:  # pragma: no cover  ## Just make it visible to end-user.
             self.file_helper.write("")
 
@@ -415,11 +519,26 @@ class ConfigLoader:
 
         return PyFunceble.storage.FLATTEN_CONFIGURATION[entry]
 
+    def reload(self, keep_custom: bool = False) -> "ConfigLoader":
+        """
+        Reloads the configuration.
+
+        :param bool keep_custom:
+            If set to :code:`True`, we keep the custom configuration, otherwise
+            we delete it.
+        """
+
+        self.destroy(keep_custom=keep_custom)
+        self.start()
+
     def start(self) -> "ConfigLoader":
         """
         Starts the loading processIs.
         """
 
+        load_dotenv(os.path.join(self.config_dir, ".env"))
+        load_dotenv(os.path.join(self.config_dir, PyFunceble.storage.ENV_FILENAME))
+
         config = self.get_config_file_content()
 
         if self.custom_config:
@@ -445,9 +564,13 @@ class ConfigLoader:
 
         return self
 
-    def destroy(self) -> "ConfigLoader":
+    def destroy(self, keep_custom: bool = False) -> "ConfigLoader":
         """
         Destroys everything loaded.
+
+        :param bool keep_custom:
+            If set to :code:`True`, we keep the custom configuration, otherwise
+            we delete it.
         """
 
         try:
@@ -462,7 +585,8 @@ class ConfigLoader:
         except (AttributeError, TypeError):  # pragma: no cover ## Safety.
             pass
 
-        # This is not a mistake.
-        self._custom_config = {}
+        if not keep_custom:
+            # This is not a mistake.
+            self._custom_config = {}
 
         return self

PyFunceble/database/credential/base.py

@@ -100,6 +100,8 @@ class CredentialBase:
     _password: Optional[str] = None
     _charset: Optional[str] = None
 
+    _config_dir: Optional[str] = None
+
     def __init__(
         self,
         *,
@@ -109,6 +111,7 @@ class CredentialBase:
         username: Optional[str] = None,
         password: Optional[str] = None,
         charset: Optional[str] = None,
+        config_dir: Optional[str] = None,
     ) -> None:
         if host is not None:
             self.host = host
@@ -140,11 +143,14 @@ class CredentialBase:
         else:
             self.charset = self.STD_CHARSET
 
+        if config_dir is not None:
+            self.config_dir = config_dir
+        else:
+            self.config_dir = PyFunceble.storage.CONFIG_DIRECTORY
+
         self.dotenv_locations = [
             os.path.realpath(PyFunceble.storage.ENV_FILENAME),
-            os.path.join(
-                PyFunceble.storage.CONFIG_DIRECTORY, PyFunceble.storage.ENV_FILENAME
-            ),
+            os.path.join(self.config_dir, PyFunceble.storage.ENV_FILENAME),
         ]
 
     def ensure_protocol_is_given(func):  # pylint: disable=no-self-argument
@@ -165,6 +171,43 @@ class CredentialBase:
 
         return wrapper
 
+    @property
+    def config_dir(self) -> Optional[str]:
+        """
+        Provides the current state of the :code:`_config_dir` attribute.
+        """
+
+        return self._config_dir
+
+    @config_dir.setter
+    def config_dir(self, value: str) -> None:
+        """
+        Sets the configuration directory.
+
+        :param value:
+            The value to set.
+
+        :raise TypeError:
+            When value is not a :py:class:`str`.
+        """
+
+        if not isinstance(value, str):
+            raise TypeError(f"<value> should be {str}, {type(value)} given.")
+
+        self._config_dir = value
+
+    def set_config_dir(self, value: str) -> "CredentialBase":
+        """
+        Sets the configuration directory.
+
+        :param value:
+            The value to set.
+        """
+
+        self.config_dir = value
+
+        return self
+
     @property
     def host(self) -> Optional[str]:
         """

PyFunceble/dataset/base.py

@@ -65,7 +65,7 @@ class DatasetBase:
     """
 
     STORAGE_INDEX: Optional[str] = None
-    DOWNLOADER: Optional[DownloaderBase] = None
+    downloader: Optional[DownloaderBase] = None
 
     source_file: Optional[str] = None
 
@@ -129,9 +129,9 @@ class DatasetBase:
         file_helper = FileHelper(self.source_file)
 
         if not file_helper.exists() and bool(
-            self.DOWNLOADER
+            self.downloader
         ):  # pragma: no cover ## This is just a safety endpoint.
-            self.DOWNLOADER.start()
+            self.downloader.start()
 
             if not file_helper.exists():
                 raise FileNotFoundError(file_helper.path)

PyFunceble/dataset/csv_base.py

@@ -208,7 +208,9 @@ class CSVDatasetBase(DBDatasetBase):
             for row in reader:
                 if "tested_at" in row:
                     try:
-                        row["tested_at"] = datetime.fromisoformat(row["tested_at"])
+                        row["tested_at"] = datetime.fromisoformat(
+                            row["tested_at"]
+                        ).astimezone(timezone.utc)
                     except (TypeError, ValueError):
                         row["tested_at"] = datetime.now(timezone.utc) - timedelta(
                             days=365

PyFunceble/dataset/db_base.py

@@ -53,6 +53,7 @@ License:
 import functools
 from typing import Any, Generator, List, Optional
 
+import PyFunceble.storage
 from PyFunceble.dataset.base import DatasetBase
 
 
@@ -77,7 +78,13 @@ class DBDatasetBase(DatasetBase):
         *,
         authorized: Optional[bool] = None,
         remove_unneeded_fields: Optional[bool] = None,
+        config_dir: Optional[str] = None,
     ) -> None:
+        if config_dir is not None:
+            self.config_dir = config_dir
+        else:
+            self.config_dir = PyFunceble.storage.CONFIG_DIRECTORY
+
         if authorized is not None:
             self.set_authorized(authorized)
 
@@ -108,6 +115,43 @@ class DBDatasetBase(DatasetBase):
 
         return inner_metdhod
 
+    @property
+    def config_dir(self) -> Optional[str]:
+        """
+        Provides the current state of the :code:`_config_dir` attribute.
+        """
+
+        return self._config_dir
+
+    @config_dir.setter
+    def config_dir(self, value: str) -> None:
+        """
+        Sets the configuration directory.
+
+        :param value:
+            The value to set.
+
+        :raise TypeError:
+            When value is not a :py:class:`str`.
+        """
+
+        if not isinstance(value, str):
+            raise TypeError(f"<value> should be {str}, {type(value)} given.")
+
+        self._config_dir = value
+
+    def set_config_dir(self, value: str) -> "DBDatasetBase":
+        """
+        Sets the configuration directory.
+
+        :param value:
+            The value to set.
+        """
+
+        self.config_dir = value
+
+        return self
+
     @property
     def authorized(self) -> Optional[bool]:
         """

PyFunceble/dataset/iana.py

@@ -50,10 +50,8 @@ License:
     limitations under the License.
 """
 
-import os
 from typing import Any, Optional
 
-import PyFunceble.storage
 from PyFunceble.dataset.base import DatasetBase
 from PyFunceble.downloader.iana import IANADownloader
 
@@ -64,12 +62,11 @@ class IanaDataset(DatasetBase):
     """
 
     STORAGE_INDEX: str = "IANA"
-    DOWNLOADER: IANADownloader = IANADownloader()
+    downloader: Optional[IANADownloader] = None
 
     def __init__(self) -> None:
-        self.source_file = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY, PyFunceble.storage.IANA_DUMP_FILENAME
-        )
+        self.downloader = IANADownloader()
+        self.source_file = self.downloader.destination
 
     def __contains__(self, value: Any) -> bool:
         if value.startswith("."):

PyFunceble/dataset/inactive/csv.py

@@ -68,7 +68,7 @@ class CSVInactiveDataset(CSVDatasetBase, InactiveDatasetBase):
 
     def __post_init__(self) -> None:
         self.source_file = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY, PyFunceble.cli.storage.INACTIVE_DB_FILE
+            self.config_dir, PyFunceble.cli.storage.INACTIVE_DB_FILE
         )
 
         return super().__post_init__()
@@ -84,7 +84,9 @@ class CSVInactiveDataset(CSVDatasetBase, InactiveDatasetBase):
         ):
             if not isinstance(dataset["tested_at"], datetime):
                 try:
-                    date_of_inclusion = datetime.fromisoformat(dataset["tested_at"])
+                    date_of_inclusion = datetime.fromisoformat(
+                        dataset["tested_at"]
+                    ).astimezone(timezone.utc)
                 except (TypeError, ValueError):
                     date_of_inclusion = datetime.now(timezone.utc) - timedelta(days=365)
             else:

PyFunceble/dataset/ipv4_reputation.py

@@ -50,10 +50,8 @@ License:
     limitations under the License.
 """
 
-import os
 from typing import Any, Optional
 
-import PyFunceble.storage
 from PyFunceble.dataset.base import DatasetBase
 from PyFunceble.downloader.ipv4_reputation import IPV4ReputationDownloader
 from PyFunceble.helpers.file import FileHelper
@@ -65,13 +63,11 @@ class IPV4ReputationDataset(DatasetBase):
     """
 
     STORAGE_INDEX: Optional[str] = None
-    DOWNLOADER: IPV4ReputationDownloader = IPV4ReputationDownloader()
+    downloader: Optional[IPV4ReputationDownloader] = None
 
     def __init__(self) -> None:
-        self.source_file = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY,
-            PyFunceble.storage.IPV4_REPUTATION_FILENAME,
-        )
+        self.downloader = IPV4ReputationDownloader()
+        self.source_file = self.downloader.destination
 
     def __contains__(self, value: Any) -> bool:
         with self.get_content() as file_stream:
@@ -95,9 +91,9 @@ class IPV4ReputationDataset(DatasetBase):
 
         file_helper = FileHelper(self.source_file)
 
-        if not file_helper.exists() and bool(self.DOWNLOADER):  # pragma: no cover
+        if not file_helper.exists() and bool(self.downloader):  # pragma: no cover
             ## pragma reason: Safety.
-            self.DOWNLOADER.start()
+            self.downloader.start()
 
             if not file_helper.exists():
                 raise FileNotFoundError(file_helper.path)

PyFunceble/dataset/public_suffix.py

@@ -50,10 +50,8 @@ License:
     limitations under the License.
 """
 
-import os
-from typing import Any, List
+from typing import Any, List, Optional
 
-import PyFunceble.storage
 from PyFunceble.dataset.base import DatasetBase
 from PyFunceble.downloader.public_suffix import PublicSuffixDownloader
 
@@ -64,13 +62,11 @@ class PublicSuffixDataset(DatasetBase):
     """
 
     STORAGE_INDEX: str = "PUBLIC_SUFFIX"
-    DOWNLOADER: PublicSuffixDownloader = PublicSuffixDownloader()
+    downloader: Optional[PublicSuffixDownloader] = None
 
     def __init__(self) -> None:
-        self.source_file = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY,
-            PyFunceble.storage.PUBLIC_SUFFIX_DUMP_FILENAME,
-        )
+        self.downloader = PublicSuffixDownloader()
+        self.source_file = self.downloader.destination
 
     def __contains__(self, value: Any) -> bool:
         if value.startswith("."):

PyFunceble/dataset/user_agent.py

@@ -50,9 +50,8 @@ License:
     limitations under the License.
 """
 
-import os
 import secrets
-from typing import Any
+from typing import Any, Optional
 from warnings import warn
 
 import PyFunceble.storage
@@ -66,16 +65,14 @@ class UserAgentDataset(DatasetBase):
     """
 
     STORAGE_INDEX: str = "USER_AGENTS"
-    DOWNLOADER: UserAgentsDownloader = UserAgentsDownloader()
+    downloader: Optional[UserAgentsDownloader] = None
 
     preferred_browser: str = "chrome"
     preferred_platform: str = "linux"
 
     def __init__(self) -> None:
-        self.source_file = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY,
-            PyFunceble.storage.USER_AGENT_FILENAME,
-        )
+        self.downloader = UserAgentsDownloader()
+        self.source_file = self.downloader.destination
 
     def __contains__(self, value: Any) -> bool:
         content = self.get_content()

PyFunceble/dataset/whois/csv.py

@@ -67,7 +67,7 @@ class CSVWhoisDataset(CSVDatasetBase, WhoisDatasetBase):
 
     def __post_init__(self) -> None:
         self.source_file = os.path.join(
-            PyFunceble.storage.CONFIG_DIRECTORY, PyFunceble.cli.storage.WHOIS_DB_FILE
+            self.config_dir, PyFunceble.cli.storage.WHOIS_DB_FILE
         )
 
         return super().__post_init__()