PyFunceble-dev 4.3.0a11__tar.gz → 4.3.0a13__tar.gz

{pyfunceble_dev-4.3.0a11 → pyfunceble_dev-4.3.0a13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyFunceble-dev
-Version: 4.3.0a11
+Version: 4.3.0a13
 Summary: The tool to check the availability or syntax of domain, IP or URL.
 Home-page: https://github.com/funilrys/PyFunceble
 Author: funilrys
@@ -22,169 +22,169 @@ Classifier: License :: OSI Approved
 Requires-Python: >=3.9, <4
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: SQLAlchemy~=2.0
+Requires-Dist: requests[socks]<3
+Requires-Dist: domain2idna~=1.12.0
+Requires-Dist: setuptools>=65.5.1
 Requires-Dist: python-dotenv
+Requires-Dist: shtab
 Requires-Dist: PyYAML
-Requires-Dist: dnspython[DOH]~=2.6.0
-Requires-Dist: colorama
+Requires-Dist: packaging
 Requires-Dist: inflection
-Requires-Dist: requests[socks]<3
+Requires-Dist: python-box[all]~=6.0.0
 Requires-Dist: PyMySQL
-Requires-Dist: domain2idna~=1.12.0
+Requires-Dist: dnspython[DOH]~=2.6.0
 Requires-Dist: alembic
-Requires-Dist: packaging
-Requires-Dist: python-box[all]~=6.0.0
-Requires-Dist: shtab
-Requires-Dist: setuptools>=65.5.1
+Requires-Dist: SQLAlchemy~=2.0
+Requires-Dist: colorama
 Provides-Extra: docs
-Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "docs"
-Requires-Dist: mkdocs-gen-files~=0.5; extra == "docs"
 Requires-Dist: mkdocs-literate-nav~=0.6; extra == "docs"
-Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "docs"
-Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "docs"
-Requires-Dist: mkdocs-material~=9.5; extra == "docs"
-Requires-Dist: mkdocs~=1.5; extra == "docs"
+Requires-Dist: mkdocs-gen-files~=0.5; extra == "docs"
+Requires-Dist: mkdocstrings[python]~=0.26; extra == "docs"
 Requires-Dist: zipp>=3.19.1; extra == "docs"
+Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "docs"
 Requires-Dist: pymdown-extensions~=10.9; extra == "docs"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "docs"
+Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "docs"
+Requires-Dist: mkdocs~=1.5; extra == "docs"
 Requires-Dist: mkdocs-section-index~=0.3; extra == "docs"
-Requires-Dist: mkdocstrings[python]~=0.26; extra == "docs"
+Requires-Dist: mkdocs-material~=9.5; extra == "docs"
 Provides-Extra: dev
-Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
 Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
-Requires-Dist: isort; extra == "dev"
 Provides-Extra: test
 Requires-Dist: coverage; extra == "test"
 Requires-Dist: tox; extra == "test"
 Provides-Extra: psql
-Requires-Dist: SQLAlchemy~=2.0; extra == "psql"
+Requires-Dist: requests[socks]<3; extra == "psql"
+Requires-Dist: domain2idna~=1.12.0; extra == "psql"
+Requires-Dist: setuptools>=65.5.1; extra == "psql"
 Requires-Dist: python-dotenv; extra == "psql"
+Requires-Dist: shtab; extra == "psql"
 Requires-Dist: PyYAML; extra == "psql"
-Requires-Dist: dnspython[DOH]~=2.6.0; extra == "psql"
-Requires-Dist: colorama; extra == "psql"
-Requires-Dist: inflection; extra == "psql"
-Requires-Dist: requests[socks]<3; extra == "psql"
+Requires-Dist: packaging; extra == "psql"
 Requires-Dist: psycopg2; extra == "psql"
+Requires-Dist: inflection; extra == "psql"
+Requires-Dist: python-box[all]~=6.0.0; extra == "psql"
 Requires-Dist: PyMySQL; extra == "psql"
-Requires-Dist: domain2idna~=1.12.0; extra == "psql"
+Requires-Dist: dnspython[DOH]~=2.6.0; extra == "psql"
 Requires-Dist: alembic; extra == "psql"
-Requires-Dist: packaging; extra == "psql"
-Requires-Dist: python-box[all]~=6.0.0; extra == "psql"
-Requires-Dist: shtab; extra == "psql"
-Requires-Dist: setuptools>=65.5.1; extra == "psql"
+Requires-Dist: SQLAlchemy~=2.0; extra == "psql"
+Requires-Dist: colorama; extra == "psql"
 Provides-Extra: psql-binary
-Requires-Dist: SQLAlchemy~=2.0; extra == "psql-binary"
-Requires-Dist: python-dotenv; extra == "psql-binary"
-Requires-Dist: PyYAML; extra == "psql-binary"
 Requires-Dist: psycopg2-binary; extra == "psql-binary"
-Requires-Dist: dnspython[DOH]~=2.6.0; extra == "psql-binary"
-Requires-Dist: colorama; extra == "psql-binary"
-Requires-Dist: inflection; extra == "psql-binary"
 Requires-Dist: requests[socks]<3; extra == "psql-binary"
-Requires-Dist: PyMySQL; extra == "psql-binary"
 Requires-Dist: domain2idna~=1.12.0; extra == "psql-binary"
-Requires-Dist: alembic; extra == "psql-binary"
+Requires-Dist: setuptools>=65.5.1; extra == "psql-binary"
+Requires-Dist: python-dotenv; extra == "psql-binary"
+Requires-Dist: shtab; extra == "psql-binary"
+Requires-Dist: PyYAML; extra == "psql-binary"
 Requires-Dist: packaging; extra == "psql-binary"
+Requires-Dist: inflection; extra == "psql-binary"
 Requires-Dist: python-box[all]~=6.0.0; extra == "psql-binary"
-Requires-Dist: shtab; extra == "psql-binary"
-Requires-Dist: setuptools>=65.5.1; extra == "psql-binary"
+Requires-Dist: PyMySQL; extra == "psql-binary"
+Requires-Dist: dnspython[DOH]~=2.6.0; extra == "psql-binary"
+Requires-Dist: alembic; extra == "psql-binary"
+Requires-Dist: SQLAlchemy~=2.0; extra == "psql-binary"
+Requires-Dist: colorama; extra == "psql-binary"
 Provides-Extra: postgresql
-Requires-Dist: SQLAlchemy~=2.0; extra == "postgresql"
+Requires-Dist: requests[socks]<3; extra == "postgresql"
+Requires-Dist: domain2idna~=1.12.0; extra == "postgresql"
+Requires-Dist: setuptools>=65.5.1; extra == "postgresql"
 Requires-Dist: python-dotenv; extra == "postgresql"
+Requires-Dist: shtab; extra == "postgresql"
 Requires-Dist: PyYAML; extra == "postgresql"
-Requires-Dist: dnspython[DOH]~=2.6.0; extra == "postgresql"
-Requires-Dist: colorama; extra == "postgresql"
-Requires-Dist: inflection; extra == "postgresql"
-Requires-Dist: requests[socks]<3; extra == "postgresql"
+Requires-Dist: packaging; extra == "postgresql"
 Requires-Dist: psycopg2; extra == "postgresql"
+Requires-Dist: inflection; extra == "postgresql"
+Requires-Dist: python-box[all]~=6.0.0; extra == "postgresql"
 Requires-Dist: PyMySQL; extra == "postgresql"
-Requires-Dist: domain2idna~=1.12.0; extra == "postgresql"
+Requires-Dist: dnspython[DOH]~=2.6.0; extra == "postgresql"
 Requires-Dist: alembic; extra == "postgresql"
-Requires-Dist: packaging; extra == "postgresql"
-Requires-Dist: python-box[all]~=6.0.0; extra == "postgresql"
-Requires-Dist: shtab; extra == "postgresql"
-Requires-Dist: setuptools>=65.5.1; extra == "postgresql"
+Requires-Dist: SQLAlchemy~=2.0; extra == "postgresql"
+Requires-Dist: colorama; extra == "postgresql"
 Provides-Extra: postgresql-binary
-Requires-Dist: SQLAlchemy~=2.0; extra == "postgresql-binary"
-Requires-Dist: python-dotenv; extra == "postgresql-binary"
-Requires-Dist: PyYAML; extra == "postgresql-binary"
 Requires-Dist: psycopg2-binary; extra == "postgresql-binary"
-Requires-Dist: dnspython[DOH]~=2.6.0; extra == "postgresql-binary"
-Requires-Dist: colorama; extra == "postgresql-binary"
-Requires-Dist: inflection; extra == "postgresql-binary"
 Requires-Dist: requests[socks]<3; extra == "postgresql-binary"
-Requires-Dist: PyMySQL; extra == "postgresql-binary"
 Requires-Dist: domain2idna~=1.12.0; extra == "postgresql-binary"
-Requires-Dist: alembic; extra == "postgresql-binary"
+Requires-Dist: setuptools>=65.5.1; extra == "postgresql-binary"
+Requires-Dist: python-dotenv; extra == "postgresql-binary"
+Requires-Dist: shtab; extra == "postgresql-binary"
+Requires-Dist: PyYAML; extra == "postgresql-binary"
 Requires-Dist: packaging; extra == "postgresql-binary"
+Requires-Dist: inflection; extra == "postgresql-binary"
 Requires-Dist: python-box[all]~=6.0.0; extra == "postgresql-binary"
-Requires-Dist: shtab; extra == "postgresql-binary"
-Requires-Dist: setuptools>=65.5.1; extra == "postgresql-binary"
+Requires-Dist: PyMySQL; extra == "postgresql-binary"
+Requires-Dist: dnspython[DOH]~=2.6.0; extra == "postgresql-binary"
+Requires-Dist: alembic; extra == "postgresql-binary"
+Requires-Dist: SQLAlchemy~=2.0; extra == "postgresql-binary"
+Requires-Dist: colorama; extra == "postgresql-binary"
 Provides-Extra: full
-Requires-Dist: black; extra == "full"
-Requires-Dist: python-dotenv; extra == "full"
-Requires-Dist: colorama; extra == "full"
-Requires-Dist: mkdocs-material~=9.5; extra == "full"
-Requires-Dist: zipp>=3.19.1; extra == "full"
-Requires-Dist: alembic; extra == "full"
-Requires-Dist: packaging; extra == "full"
-Requires-Dist: setuptools>=65.5.1; extra == "full"
-Requires-Dist: mkdocs-literate-nav~=0.6; extra == "full"
-Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "full"
-Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "full"
 Requires-Dist: requests[socks]<3; extra == "full"
+Requires-Dist: python-dotenv; extra == "full"
+Requires-Dist: pymdown-extensions~=10.9; extra == "full"
+Requires-Dist: PyYAML; extra == "full"
+Requires-Dist: tox; extra == "full"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "full"
 Requires-Dist: mkdocs~=1.5; extra == "full"
 Requires-Dist: python-box[all]~=6.0.0; extra == "full"
-Requires-Dist: SQLAlchemy~=2.0; extra == "full"
-Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "full"
-Requires-Dist: mkdocs-gen-files~=0.5; extra == "full"
-Requires-Dist: PyYAML; extra == "full"
 Requires-Dist: dnspython[DOH]~=2.6.0; extra == "full"
-Requires-Dist: PyMySQL; extra == "full"
-Requires-Dist: domain2idna~=1.12.0; extra == "full"
-Requires-Dist: pymdown-extensions~=10.9; extra == "full"
-Requires-Dist: coverage; extra == "full"
+Requires-Dist: mkdocs-literate-nav~=0.6; extra == "full"
+Requires-Dist: zipp>=3.19.1; extra == "full"
 Requires-Dist: flake8; extra == "full"
 Requires-Dist: mkdocstrings[python]~=0.26; extra == "full"
-Requires-Dist: inflection; extra == "full"
-Requires-Dist: pylint; extra == "full"
-Requires-Dist: tox; extra == "full"
+Requires-Dist: setuptools>=65.5.1; extra == "full"
+Requires-Dist: black; extra == "full"
+Requires-Dist: packaging; extra == "full"
+Requires-Dist: coverage; extra == "full"
+Requires-Dist: alembic; extra == "full"
+Requires-Dist: SQLAlchemy~=2.0; extra == "full"
+Requires-Dist: domain2idna~=1.12.0; extra == "full"
+Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "full"
+Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "full"
+Requires-Dist: PyMySQL; extra == "full"
+Requires-Dist: colorama; extra == "full"
+Requires-Dist: mkdocs-gen-files~=0.5; extra == "full"
 Requires-Dist: shtab; extra == "full"
-Requires-Dist: mkdocs-section-index~=0.3; extra == "full"
+Requires-Dist: inflection; extra == "full"
 Requires-Dist: isort; extra == "full"
+Requires-Dist: mkdocs-section-index~=0.3; extra == "full"
+Requires-Dist: mkdocs-material~=9.5; extra == "full"
+Requires-Dist: pylint; extra == "full"
 Provides-Extra: all
-Requires-Dist: black; extra == "all"
-Requires-Dist: python-dotenv; extra == "all"
-Requires-Dist: colorama; extra == "all"
-Requires-Dist: mkdocs-material~=9.5; extra == "all"
-Requires-Dist: zipp>=3.19.1; extra == "all"
-Requires-Dist: alembic; extra == "all"
-Requires-Dist: packaging; extra == "all"
-Requires-Dist: setuptools>=65.5.1; extra == "all"
-Requires-Dist: mkdocs-literate-nav~=0.6; extra == "all"
-Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "all"
-Requires-Dist: psycopg2-binary; extra == "all"
-Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "all"
 Requires-Dist: requests[socks]<3; extra == "all"
+Requires-Dist: python-dotenv; extra == "all"
+Requires-Dist: pymdown-extensions~=10.9; extra == "all"
+Requires-Dist: PyYAML; extra == "all"
+Requires-Dist: tox; extra == "all"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "all"
 Requires-Dist: mkdocs~=1.5; extra == "all"
 Requires-Dist: python-box[all]~=6.0.0; extra == "all"
-Requires-Dist: SQLAlchemy~=2.0; extra == "all"
-Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "all"
-Requires-Dist: mkdocs-gen-files~=0.5; extra == "all"
-Requires-Dist: PyYAML; extra == "all"
 Requires-Dist: dnspython[DOH]~=2.6.0; extra == "all"
-Requires-Dist: PyMySQL; extra == "all"
-Requires-Dist: domain2idna~=1.12.0; extra == "all"
-Requires-Dist: pymdown-extensions~=10.9; extra == "all"
-Requires-Dist: coverage; extra == "all"
+Requires-Dist: psycopg2-binary; extra == "all"
+Requires-Dist: mkdocs-literate-nav~=0.6; extra == "all"
+Requires-Dist: zipp>=3.19.1; extra == "all"
 Requires-Dist: flake8; extra == "all"
 Requires-Dist: mkdocstrings[python]~=0.26; extra == "all"
-Requires-Dist: inflection; extra == "all"
-Requires-Dist: pylint; extra == "all"
-Requires-Dist: tox; extra == "all"
+Requires-Dist: setuptools>=65.5.1; extra == "all"
+Requires-Dist: black; extra == "all"
+Requires-Dist: packaging; extra == "all"
+Requires-Dist: coverage; extra == "all"
+Requires-Dist: alembic; extra == "all"
+Requires-Dist: SQLAlchemy~=2.0; extra == "all"
+Requires-Dist: domain2idna~=1.12.0; extra == "all"
+Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "all"
+Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "all"
+Requires-Dist: PyMySQL; extra == "all"
+Requires-Dist: colorama; extra == "all"
+Requires-Dist: mkdocs-gen-files~=0.5; extra == "all"
 Requires-Dist: shtab; extra == "all"
-Requires-Dist: mkdocs-section-index~=0.3; extra == "all"
+Requires-Dist: inflection; extra == "all"
 Requires-Dist: isort; extra == "all"
+Requires-Dist: mkdocs-section-index~=0.3; extra == "all"
+Requires-Dist: mkdocs-material~=9.5; extra == "all"
+Requires-Dist: pylint; extra == "all"
 
 ![image](https://raw.githubusercontent.com/PyFunceble/logo/dev/Green/HD/RM.png)
 

{pyfunceble_dev-4.3.0a11 → pyfunceble_dev-4.3.0a13}/PyFunceble/cli/entry_points/pyfunceble/cli.py

@@ -103,6 +103,9 @@ def get_configured_value(
     else:
         result = PyFunceble.facility.ConfigLoader.get_configured_value(entry)
 
+    if isinstance(result, str) and "%" in result:
+        result = result.replace("%", "%%")
+
     if negate:
         result = not result
 
@@ -587,6 +590,18 @@ def get_test_control_group_data() -> List[Tuple[List[str], dict]]:
                 "get the latest (automatically) for you.",
             },
         ),
+        (
+            [
+                "--user-agent-reference",
+            ],
+            {
+                "dest": "user_agent.reference",
+                "type": str,
+                "help": "Sets the reference to append to the user agent.\n\n"
+                "This is useful when you want to add a reference to the "
+                "user agent. %s" % get_configured_value("user_agent.reference"),
+            },
+        ),
         (
             [
                 "-vsc",
@@ -833,15 +848,6 @@ def get_output_control_group_data() -> List[Tuple[List[str], dict]]:
                 "default": "all",
             },
         ),
-        (
-            ["--display-datetime"],
-            {
-                "dest": "cli_testing.display_mode.datetime",
-                "action": "store_true",
-                "help": "Activates or disables the display of the datetime of the\n"
-                "test. %s" % get_configured_value("cli_testing.display_mode.datetime"),
-            },
-        ),
         (
             ["--display-datetime-fmt"],
             {

{pyfunceble_dev-4.3.0a11 → pyfunceble_dev-4.3.0a13}/PyFunceble/config/loader.py

@@ -92,11 +92,12 @@ class ConfigLoader:
     _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
+    _path_to_overwrite_config: Optional[str] = None
 
     _custom_config: dict = {}
     _merge_upstream: bool = False
     _config_dir: Optional[str] = None
+    __config_loaded: bool = False
 
     file_helper: FileHelper = FileHelper()
     dict_helper: DictHelper = DictHelper()
@@ -115,18 +116,8 @@ class ConfigLoader:
         else:
             self.config_dir = PyFunceble.storage.CONFIG_DIRECTORY
 
-        self.path_to_config = os.path.join(
-            self.config_dir,
-            PyFunceble.storage.CONFIGURATION_FILENAME,
-        )
-
         self.path_to_remote_config = None
 
-        self.path_to_overwrite_config = os.path.join(
-            self.config_dir,
-            ".PyFunceble.overwrite.yaml",
-        )
-
         if merge_upstream is not None:
             self.merge_upstream = merge_upstream
         elif EnvironmentVariableHelper("PYFUNCEBLE_AUTO_CONFIGURATION").exists():
@@ -206,14 +197,82 @@ class ConfigLoader:
 
         return config
 
-    @staticmethod
-    def is_already_loaded() -> bool:
+    def is_already_loaded(self) -> bool:
         """
         Checks if the configuration was already loaded.
         """
 
         return bool(PyFunceble.storage.CONFIGURATION)
 
+    def __is_completely_loaded(self) -> bool:
+        """
+        Checks if the configuration was completely loaded.
+        """
+
+        return self.is_already_loaded() and bool(self.__config_loaded)
+
+    @property
+    def path_to_config(self) -> Optional[str]:
+        """
+        Provides the current state of the :code:`_path_to_config` attribute.
+        """
+
+        if self._path_to_config is None:
+            self._path_to_config = os.path.join(
+                self.config_dir,
+                PyFunceble.storage.CONFIGURATION_FILENAME,
+            )
+
+        return self._path_to_config
+
+    @path_to_config.setter
+    def path_to_config(self, value: str) -> None:
+        """
+        Sets the path to the configuration file.
+
+        :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._path_to_config = value
+
+    @property
+    def path_to_overwrite_config(self) -> Optional[str]:
+        """
+        Provides the current state of the :code:`_path_to_overwrite_config` attribute.
+        """
+
+        if self._path_to_overwrite_config is None:
+            self._path_to_overwrite_config = os.path.join(
+                self.config_dir,
+                ".PyFunceble.overwrite.yaml",
+            )
+
+        return self._path_to_overwrite_config
+
+    @path_to_overwrite_config.setter
+    def path_to_overwrite_config(self, value: str) -> None:
+        """
+        Sets the path to the overwrite configuration file.
+
+        :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._path_to_overwrite_config = value
+
     @property
     def config_dir(self) -> Optional[str]:
         """
@@ -239,6 +298,9 @@ class ConfigLoader:
             raise TypeError(f"<value> should be {str}, {type(value)} given.")
 
         self._config_dir = value
+        # Reset the path to the configuration file.
+        self._path_to_config = None
+        self._path_to_overwrite_config = None
 
     def set_config_dir(self, value: str) -> "ConfigLoader":
         """
@@ -385,9 +447,8 @@ class ConfigLoader:
 
         return self
 
-    @classmethod
     def download_dynamic_infrastructure_files(
-        cls,
+        self,
     ) -> "ConfigLoader":
         """
         Downloads all the dynamicly (generated) infrastructure files.
@@ -400,7 +461,7 @@ class ConfigLoader:
 
         ## pragma: no cover ## Underlying download methods already tested.
 
-        if not cls.is_already_loaded():
+        if not self.is_already_loaded():
             IANADownloader().start()
             PublicSuffixDownloader().start()
             UserAgentsDownloader().start()
@@ -494,7 +555,7 @@ class ConfigLoader:
             config,
         )
 
-        if not self.is_already_loaded():
+        if not self.__is_completely_loaded():
             self.install_missing_infrastructure_files()
             self.download_dynamic_infrastructure_files()
             download_remote_config(
@@ -593,6 +654,8 @@ class ConfigLoader:
         # Early load user agents to allow usage of defined user agents.
         UserAgentDataset().get_latest()
 
+        self.__config_loaded = True
+
         return self
 
     def destroy(self, keep_custom: bool = False) -> "ConfigLoader":
@@ -620,4 +683,6 @@ class ConfigLoader:
             # This is not a mistake.
             self._custom_config = {}
 
+        self.__config_loaded = False
+
         return self

{pyfunceble_dev-4.3.0a11 → pyfunceble_dev-4.3.0a13}/PyFunceble/data/infrastructure/.PyFunceble_production.yaml

@@ -629,6 +629,17 @@ user_agent:
   # CLI Argument: -ua | --user-agent
   custom: null
 
+  # Set the reference to add to the User-Agent.
+  # This is useful when you want to add a reference (e.g. a link) to the User-Agent.
+  #
+  # The reference will be added at the end of the User-Agent in the following format:
+  # {user_agent}; +{reference}
+  #
+  # When set to `null`, no reference will be added.
+  #
+  # CLI Argument: --user-agent-reference
+  reference: null
+
 proxy:
   # Provides everything related to the proxy usage and configuration.
   #

{pyfunceble_dev-4.3.0a11 → pyfunceble_dev-4.3.0a13}/PyFunceble/dataset/user_agent.py

@@ -196,6 +196,30 @@ class UserAgentDataset(DatasetBase):
             and bool(self[browser_short_name.lower()][platform.lower()])
         )
 
+    def format_user_agent(
+        self, user_agent: str, *, reference: Optional[str] = None
+    ) -> str:
+        """
+        Given a user agent and a reference, it returns the formatted user agent
+        that we have to use.
+
+        :param user_agent:
+            The user agent to format.
+        :param reference:
+            The reference to append to the user agent.
+
+        :return:
+            The formatted user agent.
+        """
+
+        user_agent = user_agent.strip()
+
+        if reference:
+            if user_agent.endswith(";"):
+                return f"{user_agent} +{reference}"
+            return f"{user_agent}; +{reference}"
+        return user_agent
+
     def get_latest(self) -> str:
         """
         Provides the latest user agent for the given platform.
@@ -205,12 +229,19 @@ class UserAgentDataset(DatasetBase):
             (if exists).
         """
 
+        reference = None
+
         if PyFunceble.storage.CONFIGURATION:
+            reference = PyFunceble.storage.CONFIGURATION.user_agent.reference
+
             if (
                 PyFunceble.storage.CONFIGURATION.user_agent
                 and PyFunceble.storage.CONFIGURATION.user_agent.custom
             ):
-                return PyFunceble.storage.CONFIGURATION.user_agent.custom
+                return self.format_user_agent(
+                    PyFunceble.storage.CONFIGURATION.user_agent.custom,
+                    reference=reference,
+                )
 
             self.set_preferred(
                 PyFunceble.storage.CONFIGURATION.user_agent.browser,
@@ -220,6 +251,9 @@ class UserAgentDataset(DatasetBase):
         result = self[self.preferred_browser][self.preferred_platform]
 
         if isinstance(result, (list, tuple)):
-            return secrets.choice(result)
+            return self.format_user_agent(
+                secrets.choice(result),
+                reference=reference,
+            )
 
-        return result
+        return self.format_user_agent(result, reference=reference)

{pyfunceble_dev-4.3.0a11 → pyfunceble_dev-4.3.0a13}/PyFunceble/storage.py

@@ -60,7 +60,7 @@ from dotenv import load_dotenv
 from PyFunceble.storage_facility import get_config_directory
 
 PROJECT_NAME: str = "PyFunceble"
-PROJECT_VERSION: str = "4.3.0a11.dev (Blue Duckling: Tulip)"
+PROJECT_VERSION: str = "4.3.0a13.dev (Blue Duckling: Tulip)"
 
 DISTRIBUTED_CONFIGURATION_FILENAME: str = ".PyFunceble_production.yaml"