PyFunceble-dev 4.3.0a10__tar.gz → 4.3.0a12__tar.gz

{pyfunceble_dev-4.3.0a10 → pyfunceble_dev-4.3.0a12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyFunceble-dev
-Version: 4.3.0a10
+Version: 4.3.0a12
 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: python-box[all]~=6.0.0
-Requires-Dist: colorama
-Requires-Dist: requests[socks]<3
-Requires-Dist: setuptools>=65.5.1
 Requires-Dist: dnspython[DOH]~=2.6.0
-Requires-Dist: alembic
 Requires-Dist: packaging
+Requires-Dist: python-box[all]~=6.0.0
+Requires-Dist: PyYAML
 Requires-Dist: python-dotenv
+Requires-Dist: PyMySQL
 Requires-Dist: SQLAlchemy~=2.0
+Requires-Dist: alembic
+Requires-Dist: domain2idna~=1.12.0
+Requires-Dist: colorama
 Requires-Dist: inflection
+Requires-Dist: requests[socks]<3
 Requires-Dist: shtab
-Requires-Dist: domain2idna~=1.12.0
-Requires-Dist: PyYAML
-Requires-Dist: PyMySQL
+Requires-Dist: setuptools>=65.5.1
 Provides-Extra: docs
-Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "docs"
-Requires-Dist: mkdocstrings[python]~=0.26; extra == "docs"
-Requires-Dist: pymdown-extensions~=10.9; extra == "docs"
-Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "docs"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "docs"
+Requires-Dist: mkdocs-literate-nav~=0.6; extra == "docs"
 Requires-Dist: mkdocs-gen-files~=0.5; extra == "docs"
-Requires-Dist: mkdocs-material~=9.5; extra == "docs"
+Requires-Dist: pymdown-extensions~=10.9; extra == "docs"
+Requires-Dist: zipp>=3.19.1; extra == "docs"
 Requires-Dist: mkdocs-section-index~=0.3; extra == "docs"
+Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "docs"
+Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "docs"
+Requires-Dist: mkdocstrings[python]~=0.26; extra == "docs"
 Requires-Dist: mkdocs~=1.5; extra == "docs"
-Requires-Dist: mkdocs-literate-nav~=0.6; extra == "docs"
-Requires-Dist: zipp>=3.19.1; extra == "docs"
-Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "docs"
+Requires-Dist: mkdocs-material~=9.5; extra == "docs"
 Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
+Requires-Dist: black; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: isort; extra == "dev"
 Provides-Extra: test
-Requires-Dist: tox; extra == "test"
 Requires-Dist: coverage; extra == "test"
+Requires-Dist: tox; extra == "test"
 Provides-Extra: psql
-Requires-Dist: python-box[all]~=6.0.0; extra == "psql"
-Requires-Dist: psycopg2; extra == "psql"
-Requires-Dist: colorama; extra == "psql"
-Requires-Dist: requests[socks]<3; extra == "psql"
-Requires-Dist: setuptools>=65.5.1; 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: PyYAML; extra == "psql"
 Requires-Dist: python-dotenv; extra == "psql"
+Requires-Dist: psycopg2; extra == "psql"
+Requires-Dist: PyMySQL; extra == "psql"
 Requires-Dist: SQLAlchemy~=2.0; extra == "psql"
+Requires-Dist: alembic; extra == "psql"
+Requires-Dist: domain2idna~=1.12.0; extra == "psql"
+Requires-Dist: colorama; extra == "psql"
 Requires-Dist: inflection; extra == "psql"
+Requires-Dist: requests[socks]<3; extra == "psql"
 Requires-Dist: shtab; extra == "psql"
-Requires-Dist: domain2idna~=1.12.0; extra == "psql"
-Requires-Dist: PyYAML; extra == "psql"
-Requires-Dist: PyMySQL; extra == "psql"
+Requires-Dist: setuptools>=65.5.1; extra == "psql"
 Provides-Extra: psql-binary
-Requires-Dist: python-box[all]~=6.0.0; extra == "psql-binary"
-Requires-Dist: colorama; extra == "psql-binary"
-Requires-Dist: requests[socks]<3; extra == "psql-binary"
-Requires-Dist: setuptools>=65.5.1; extra == "psql-binary"
 Requires-Dist: dnspython[DOH]~=2.6.0; extra == "psql-binary"
-Requires-Dist: alembic; extra == "psql-binary"
 Requires-Dist: packaging; extra == "psql-binary"
+Requires-Dist: python-box[all]~=6.0.0; extra == "psql-binary"
+Requires-Dist: PyYAML; extra == "psql-binary"
 Requires-Dist: python-dotenv; extra == "psql-binary"
-Requires-Dist: psycopg2-binary; extra == "psql-binary"
+Requires-Dist: PyMySQL; extra == "psql-binary"
 Requires-Dist: SQLAlchemy~=2.0; extra == "psql-binary"
+Requires-Dist: alembic; extra == "psql-binary"
+Requires-Dist: psycopg2-binary; extra == "psql-binary"
+Requires-Dist: domain2idna~=1.12.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: shtab; extra == "psql-binary"
-Requires-Dist: domain2idna~=1.12.0; extra == "psql-binary"
-Requires-Dist: PyYAML; extra == "psql-binary"
-Requires-Dist: PyMySQL; extra == "psql-binary"
+Requires-Dist: setuptools>=65.5.1; extra == "psql-binary"
 Provides-Extra: postgresql
-Requires-Dist: python-box[all]~=6.0.0; extra == "postgresql"
-Requires-Dist: psycopg2; extra == "postgresql"
-Requires-Dist: colorama; extra == "postgresql"
-Requires-Dist: requests[socks]<3; extra == "postgresql"
-Requires-Dist: setuptools>=65.5.1; 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: PyYAML; extra == "postgresql"
 Requires-Dist: python-dotenv; extra == "postgresql"
+Requires-Dist: psycopg2; extra == "postgresql"
+Requires-Dist: PyMySQL; extra == "postgresql"
 Requires-Dist: SQLAlchemy~=2.0; extra == "postgresql"
+Requires-Dist: alembic; extra == "postgresql"
+Requires-Dist: domain2idna~=1.12.0; extra == "postgresql"
+Requires-Dist: colorama; extra == "postgresql"
 Requires-Dist: inflection; extra == "postgresql"
+Requires-Dist: requests[socks]<3; extra == "postgresql"
 Requires-Dist: shtab; extra == "postgresql"
-Requires-Dist: domain2idna~=1.12.0; extra == "postgresql"
-Requires-Dist: PyYAML; extra == "postgresql"
-Requires-Dist: PyMySQL; extra == "postgresql"
+Requires-Dist: setuptools>=65.5.1; extra == "postgresql"
 Provides-Extra: postgresql-binary
-Requires-Dist: python-box[all]~=6.0.0; extra == "postgresql-binary"
-Requires-Dist: colorama; extra == "postgresql-binary"
-Requires-Dist: requests[socks]<3; extra == "postgresql-binary"
-Requires-Dist: setuptools>=65.5.1; extra == "postgresql-binary"
 Requires-Dist: dnspython[DOH]~=2.6.0; extra == "postgresql-binary"
-Requires-Dist: alembic; extra == "postgresql-binary"
 Requires-Dist: packaging; extra == "postgresql-binary"
+Requires-Dist: python-box[all]~=6.0.0; extra == "postgresql-binary"
+Requires-Dist: PyYAML; extra == "postgresql-binary"
 Requires-Dist: python-dotenv; extra == "postgresql-binary"
-Requires-Dist: psycopg2-binary; extra == "postgresql-binary"
+Requires-Dist: PyMySQL; extra == "postgresql-binary"
 Requires-Dist: SQLAlchemy~=2.0; extra == "postgresql-binary"
+Requires-Dist: alembic; extra == "postgresql-binary"
+Requires-Dist: psycopg2-binary; extra == "postgresql-binary"
+Requires-Dist: domain2idna~=1.12.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: shtab; extra == "postgresql-binary"
-Requires-Dist: domain2idna~=1.12.0; extra == "postgresql-binary"
-Requires-Dist: PyYAML; extra == "postgresql-binary"
-Requires-Dist: PyMySQL; extra == "postgresql-binary"
+Requires-Dist: setuptools>=65.5.1; extra == "postgresql-binary"
 Provides-Extra: full
-Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "full"
-Requires-Dist: mkdocstrings[python]~=0.26; extra == "full"
-Requires-Dist: isort; extra == "full"
-Requires-Dist: packaging; extra == "full"
-Requires-Dist: shtab; extra == "full"
-Requires-Dist: requests[socks]<3; extra == "full"
-Requires-Dist: tox; extra == "full"
-Requires-Dist: mkdocs-gen-files~=0.5; extra == "full"
-Requires-Dist: mkdocs-section-index~=0.3; extra == "full"
-Requires-Dist: alembic; extra == "full"
-Requires-Dist: mkdocs-literate-nav~=0.6; extra == "full"
-Requires-Dist: python-box[all]~=6.0.0; extra == "full"
+Requires-Dist: PyMySQL; extra == "full"
 Requires-Dist: black; extra == "full"
-Requires-Dist: domain2idna~=1.12.0; extra == "full"
-Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "full"
 Requires-Dist: colorama; extra == "full"
-Requires-Dist: python-dotenv; extra == "full"
+Requires-Dist: tox; extra == "full"
+Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "full"
+Requires-Dist: setuptools>=65.5.1; extra == "full"
+Requires-Dist: dnspython[DOH]~=2.6.0; extra == "full"
+Requires-Dist: mkdocs-material~=9.5; extra == "full"
+Requires-Dist: mkdocs-literate-nav~=0.6; extra == "full"
 Requires-Dist: SQLAlchemy~=2.0; extra == "full"
-Requires-Dist: zipp>=3.19.1; extra == "full"
+Requires-Dist: pylint; extra == "full"
+Requires-Dist: mkdocs~=1.5; extra == "full"
+Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "full"
+Requires-Dist: packaging; extra == "full"
 Requires-Dist: PyYAML; extra == "full"
 Requires-Dist: coverage; extra == "full"
+Requires-Dist: mkdocs-gen-files~=0.5; extra == "full"
 Requires-Dist: pymdown-extensions~=10.9; extra == "full"
-Requires-Dist: mkdocs-material~=9.5; extra == "full"
-Requires-Dist: setuptools>=65.5.1; extra == "full"
-Requires-Dist: dnspython[DOH]~=2.6.0; extra == "full"
-Requires-Dist: flake8; extra == "full"
-Requires-Dist: mkdocs~=1.5; extra == "full"
-Requires-Dist: pylint; extra == "full"
 Requires-Dist: inflection; extra == "full"
+Requires-Dist: flake8; extra == "full"
+Requires-Dist: requests[socks]<3; extra == "full"
+Requires-Dist: mkdocstrings[python]~=0.26; extra == "full"
+Requires-Dist: python-box[all]~=6.0.0; extra == "full"
 Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "full"
-Requires-Dist: PyMySQL; extra == "full"
+Requires-Dist: python-dotenv; extra == "full"
+Requires-Dist: alembic; extra == "full"
+Requires-Dist: domain2idna~=1.12.0; extra == "full"
+Requires-Dist: zipp>=3.19.1; extra == "full"
+Requires-Dist: mkdocs-section-index~=0.3; extra == "full"
+Requires-Dist: shtab; extra == "full"
+Requires-Dist: isort; extra == "full"
 Provides-Extra: all
-Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "all"
-Requires-Dist: mkdocstrings[python]~=0.26; extra == "all"
-Requires-Dist: isort; extra == "all"
-Requires-Dist: packaging; extra == "all"
-Requires-Dist: shtab; extra == "all"
-Requires-Dist: requests[socks]<3; extra == "all"
-Requires-Dist: tox; extra == "all"
-Requires-Dist: mkdocs-gen-files~=0.5; extra == "all"
-Requires-Dist: mkdocs-section-index~=0.3; extra == "all"
-Requires-Dist: alembic; extra == "all"
-Requires-Dist: mkdocs-literate-nav~=0.6; extra == "all"
-Requires-Dist: python-box[all]~=6.0.0; extra == "all"
+Requires-Dist: PyMySQL; extra == "all"
 Requires-Dist: black; extra == "all"
-Requires-Dist: domain2idna~=1.12.0; extra == "all"
-Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "all"
 Requires-Dist: colorama; extra == "all"
-Requires-Dist: python-dotenv; extra == "all"
+Requires-Dist: tox; extra == "all"
+Requires-Dist: mkdocs-git-authors-plugin~=0.9; extra == "all"
+Requires-Dist: setuptools>=65.5.1; extra == "all"
+Requires-Dist: dnspython[DOH]~=2.6.0; extra == "all"
+Requires-Dist: mkdocs-material~=9.5; extra == "all"
+Requires-Dist: mkdocs-literate-nav~=0.6; extra == "all"
 Requires-Dist: SQLAlchemy~=2.0; extra == "all"
-Requires-Dist: zipp>=3.19.1; extra == "all"
+Requires-Dist: pylint; extra == "all"
+Requires-Dist: mkdocs~=1.5; extra == "all"
+Requires-Dist: mkdocs-macros-plugin~=1.2; extra == "all"
+Requires-Dist: packaging; extra == "all"
 Requires-Dist: PyYAML; extra == "all"
 Requires-Dist: coverage; extra == "all"
-Requires-Dist: pymdown-extensions~=10.9; extra == "all"
-Requires-Dist: mkdocs-material~=9.5; extra == "all"
-Requires-Dist: setuptools>=65.5.1; extra == "all"
-Requires-Dist: dnspython[DOH]~=2.6.0; extra == "all"
 Requires-Dist: psycopg2-binary; extra == "all"
-Requires-Dist: flake8; extra == "all"
-Requires-Dist: mkdocs~=1.5; extra == "all"
-Requires-Dist: pylint; extra == "all"
+Requires-Dist: mkdocs-gen-files~=0.5; extra == "all"
+Requires-Dist: pymdown-extensions~=10.9; extra == "all"
 Requires-Dist: inflection; extra == "all"
+Requires-Dist: flake8; extra == "all"
+Requires-Dist: requests[socks]<3; extra == "all"
+Requires-Dist: mkdocstrings[python]~=0.26; extra == "all"
+Requires-Dist: python-box[all]~=6.0.0; extra == "all"
 Requires-Dist: mkdocs-git-revision-date-localized-plugin~=1.2; extra == "all"
-Requires-Dist: PyMySQL; extra == "all"
+Requires-Dist: python-dotenv; extra == "all"
+Requires-Dist: alembic; extra == "all"
+Requires-Dist: domain2idna~=1.12.0; extra == "all"
+Requires-Dist: zipp>=3.19.1; extra == "all"
+Requires-Dist: mkdocs-section-index~=0.3; extra == "all"
+Requires-Dist: shtab; extra == "all"
+Requires-Dist: isort; extra == "all"
 
 ![image](https://raw.githubusercontent.com/PyFunceble/logo/dev/Green/HD/RM.png)
 

{pyfunceble_dev-4.3.0a10 → pyfunceble_dev-4.3.0a12}/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,6 +848,16 @@ def get_output_control_group_data() -> List[Tuple[List[str], dict]]:
                 "default": "all",
             },
         ),
+        (
+            ["--display-datetime-fmt"],
+            {
+                "dest": "cli_testing.display_mode.datetime_format",
+                "type": str,
+                "help": "Sets the datetime format to use when displaying the\n"
+                "datetime of the test. %s"
+                % get_configured_value("cli_testing.display_mode.datetime_format"),
+            },
+        ),
         (
             [
                 "--dots",

{pyfunceble_dev-4.3.0a10 → pyfunceble_dev-4.3.0a12}/PyFunceble/cli/filesystem/printer/base.py

@@ -53,7 +53,7 @@ License:
 import copy
 import functools
 import string
-from typing import Dict, List, Optional
+from typing import Any, Callable, Dict, List, Optional
 
 
 class PrinterBase:
@@ -81,14 +81,15 @@ class PrinterBase:
         "minutes": 2,
         "seconds": 6,
         "registrar": 30,
+        "tested_at": 19,
     }
 
     TEMPLATES: Dict[str, string.Template] = {
         "all": string.Template(
             "$idna_subject $status $status_source $expiration_date $registrar "
-            "$http_status_code $checker_type"
+            "$http_status_code $checker_type $tested_at"
         ),
-        "less": string.Template("$idna_subject $status $status_source"),
+        "less": string.Template("$idna_subject $status $status_source $tested_at"),
         "simple": string.Template("$idna_subject $status"),
         "percentage": string.Template("$status $percentage $amount"),
         "hosts": string.Template("$ip $idna_subject"),
@@ -114,8 +115,11 @@ class PrinterBase:
         "minutes": "Minutes",
         "seconds": "Seconds",
         "registrar": "Registrar",
+        "tested_at": "Tested At",
     }
 
+    extra_formatters: Dict[str, Callable[..., Any]] = {}
+
     _template_to_use: Optional[str] = None
     _dataset: Optional[Dict[str, str]] = None
     _skip_column: Optional[List[str]] = []
@@ -126,6 +130,7 @@ class PrinterBase:
         *,
         dataset: Optional[Dict[str, str]] = None,
         skip_column: Optional[List[str]] = None,
+        extra_formatters: Optional[Dict[str, Callable[..., Any]]] = None,
     ) -> None:
         if template_to_use is not None:
             self.template_to_use = template_to_use
@@ -136,6 +141,9 @@ class PrinterBase:
         if skip_column is not None:
             self.skip_column = skip_column
 
+        if extra_formatters is not None:
+            self.extra_formatters.update(extra_formatters)
+
     def ensure_template_to_use_is_given(func):  # pylint: disable=no-self-argument
         """
         Ensures that the template to use is given before launching the
@@ -315,9 +323,11 @@ class PrinterBase:
                     continue
 
                 if key in self.skip_column:
-                    self.TEMPLATES[self.template_to_use].template = self.TEMPLATES[
-                        self.template_to_use
-                    ].template.replace(f"${key} ", "")
+                    self.TEMPLATES[self.template_to_use].template = (
+                        self.TEMPLATES[self.template_to_use]
+                        .template.replace(f"${key} ", "")
+                        .replace(f" ${key}", "")
+                    )
                     continue
 
                 to_print_data[0][key] = f"{value:<{self.STD_LENGTH[key]}}"
@@ -354,6 +364,9 @@ class PrinterBase:
             if not value and value != 0:
                 value = self.STD_UNKNOWN
 
+            if key in self.extra_formatters:
+                value = self.extra_formatters[key](value)
+
             if self.template_to_use not in ignore_length:
                 to_print[key] = f"{value:<{self.STD_LENGTH[key]}}"
             else:

{pyfunceble_dev-4.3.0a10 → pyfunceble_dev-4.3.0a12}/PyFunceble/cli/processes/workers/producer.py

@@ -106,12 +106,25 @@ class ProducerWorker(WorkerBase):
 
     def __post_init__(self) -> None:
         skip_columns = []
+        extra_formatters = {}
 
         if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.registrar:
             skip_columns.append("registrar")
 
-        self.stdout_printer = StdoutPrinter(skip_column=skip_columns)
-        self.file_printer = FilePrinter(skip_column=skip_columns)
+        if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.datetime:
+            skip_columns.append("tested_at")
+        else:
+            # pylint: disable=line-too-long
+            extra_formatters["tested_at"] = lambda x: x.strftime(
+                PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.datetime_format
+            )
+
+        self.stdout_printer = StdoutPrinter(
+            skip_column=skip_columns, extra_formatters=extra_formatters
+        )
+        self.file_printer = FilePrinter(
+            skip_column=skip_columns, extra_formatters=extra_formatters
+        )
         self.whois_dataset = get_whois_dataset_object(db_session=self.db_session)
         self.inactive_dataset = get_inactive_dataset_object(db_session=self.db_session)
         self.continue_dataset = get_continue_databaset_object(

{pyfunceble_dev-4.3.0a10 → pyfunceble_dev-4.3.0a12}/PyFunceble/data/infrastructure/.PyFunceble_production.yaml

@@ -377,6 +377,20 @@ cli_testing:
     # CLI Argument: --max-registrar
     max_registrar: 15
 
+    # Enable/Disable the printing of the datetime of the test.
+    #
+    # CLI Argument: --display-datetime
+    datetime: no
+
+    # The format to use when displaying the datetime of the test.
+    #
+    # WARNING:
+    #   This parameter is only taken into consideration when `datetime` is set
+    #   to `yes`.
+    #
+    # CLI Argument: --display-datetime-fmt
+    datetime_format: "%Y-%m-%d %H:%M:%S"
+
   testing_mode:
     # Provides and select the testing mode.
     #
@@ -615,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.0a10 → pyfunceble_dev-4.3.0a12}/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.0a10 → pyfunceble_dev-4.3.0a12}/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.0a10.dev (Blue Duckling: Tulip)"
+PROJECT_VERSION: str = "4.3.0a12.dev (Blue Duckling: Tulip)"
 
 DISTRIBUTED_CONFIGURATION_FILENAME: str = ".PyFunceble_production.yaml"