PyFunceble-dev 4.2.18__py3-none-any.whl → 4.2.19__py3-none-any.whl

PyFunceble/cli/system/integrator.py

@@ -190,14 +190,38 @@ class SystemIntegrator(SystemBase):
                 "both disabled."
             )
 
-        if "url_base" in PyFunceble.storage.CONFIGURATION.collection:
+        if "url_base" in PyFunceble.storage.CONFIGURATION.platform:
             PyFunceble.cli.storage.EXTRA_MESSAGES.append(
                 f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}Your are still "
-                "defining the 'collection.url_base' configuration key which has "
+                "defining the 'platform.url_base' configuration key which has "
                 "been deprecated and deleted. Please remove it from your "
                 "configuration file."
             )
 
+        if (
+            "collection" in PyFunceble.storage.CONFIGURATION
+            or "collection" in PyFunceble.storage.CONFIGURATION.lookup
+        ):
+            PyFunceble.cli.storage.EXTRA_MESSAGES.append(
+                f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}The 'collection' "
+                "configuration key is not supported anymore. Please switch to "
+                "'platform'."
+            )
+
+        if "PYFUNCEBLE_COLLECTION_API_TOKEN" in os.environ:
+            PyFunceble.cli.storage.EXTRA_MESSAGES.append(
+                f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}The "
+                "'PYFUNCEBLE_COLLECTION_API_TOKEN' environment variable is not "
+                "supported anymore. Please switch to 'PYFUNCEBLE_PLATFORM_API_TOKEN'."
+            )
+
+        if "PYFUNCEBLE_COLLECTION_API_URL" in os.environ:
+            PyFunceble.cli.storage.EXTRA_MESSAGES.append(
+                f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}The "
+                "'PYFUNCEBLE_COLLECTION_API_URL' environment variable is not "
+                "supported anymore. Please switch to 'PYFUNCEBLE_PLATFORM_API_URL'."
+            )
+
     @SystemBase.ensure_args_is_given
     def check_deprecated(self) -> "SystemIntegrator":
         """

PyFunceble/cli/system/launcher.py

@@ -120,7 +120,7 @@ from PyFunceble.dataset.inactive.base import InactiveDatasetBase
 from PyFunceble.helpers.directory import DirectoryHelper
 from PyFunceble.helpers.download import DownloadHelper
 from PyFunceble.helpers.file import FileHelper
-from PyFunceble.query.collection import CollectionQueryTool
+from PyFunceble.query.platform import PlatformQueryTool
 
 
 class SystemLauncher(SystemBase):
@@ -499,7 +499,7 @@ class SystemLauncher(SystemBase):
                 cleanup_tool.clean_output_files()
                 running_file_helper.write(
                     f"{self.sessions_id[parent_dirname]} "
-                    f"{datetime.datetime.utcnow().isoformat()}",
+                    f"{datetime.datetime.now(datetime.timezone.utc).isoformat()}",
                     overwrite=True,
                 )
             else:
@@ -643,7 +643,7 @@ class SystemLauncher(SystemBase):
             testing.
             """
 
-            query_tool = CollectionQueryTool()
+            query_tool = PlatformQueryTool()
 
             max_breakoff = 120.0
             breakoff_multiplier = 0.5

PyFunceble/cli/utils/version.py

@@ -52,7 +52,7 @@ License:
 
 import os
 import sys
-from datetime import datetime
+from datetime import datetime, timezone
 
 import colorama
 from box import Box
@@ -292,7 +292,7 @@ def handle_messages(upstream_version: Box) -> None:
         authorized = True
 
     if authorized:
-        local_timezone = datetime.utcnow().astimezone().tzinfo
+        local_timezone = datetime.now(timezone.utc).astimezone().tzinfo
 
         for minimal_version, data in upstream_version.messages.items():
             if not version_utility.is_equal_to(
@@ -357,5 +357,7 @@ def print_central_messages(check_force_update: bool = False) -> None:
 
     handle_messages(upstream_version)
 
+    prefix = " - " if len(PyFunceble.cli.storage.EXTRA_MESSAGES) > 1 else ""
+
     for extra_message in PyFunceble.cli.storage.EXTRA_MESSAGES:
-        print_single_line(extra_message, force=True)
+        print_single_line(prefix + extra_message, force=True, end="\n")

PyFunceble/config/compare.py

@@ -135,6 +135,9 @@ class ConfigComparison:
         "whois_database": "cli_testing.whois_db",
         "wildcard": "cli_decoding.wildcard",
         "cli_decoding.adblock_aggressive": "cli_decoding.aggressive",
+        "lookup.collection": "lookup.platform",
+        "collection.push": "platform.push",
+        "collection.preferred_status_origin": "platform.preferred_status_origin",
     }
 
     OLD_TO_NEW_NEGATE: dict = {
@@ -144,7 +147,7 @@ class ConfigComparison:
     }
 
     DELETE_FLATTEN: List[str] = [
-        "collection.url_base",
+        "platform.url_base",
     ]
 
     NEW_STATUS_CODES: dict = {
@@ -267,8 +270,8 @@ class ConfigComparison:
             or "proxy" not in self.local_config
             or "follow_server_order" not in self.local_config["dns"]
             or "trust_server" not in self.local_config["dns"]
-            or "collection" not in self.local_config
-            or "collection" not in self.local_config["lookup"]
+            or "platform" not in self.local_config
+            or "platform" not in self.local_config["lookup"]
         ):
             return False
 
@@ -293,8 +296,8 @@ class ConfigComparison:
                     return False
 
         if (
-            "collection" in self.local_config
-            and "url_base" in self.local_config["collection"]
+            "platform" in self.local_config
+            and "url_base" in self.local_config["platform"]
         ):
             return False
 

PyFunceble/config/loader.py

@@ -435,8 +435,8 @@ class ConfigLoader:
         PyFunceble.storage.HTTP_CODES = Box(
             config["http_codes"],
         )
-        if "collection" in config and config["collection"]:
-            PyFunceble.storage.COLLECTION = Box(config["collection"])
+        if "platform" in config and config["platform"]:
+            PyFunceble.storage.PLATFORM = Box(config["platform"])
         PyFunceble.storage.LINKS = Box(config["links"])
 
         if "proxy" in config and config["proxy"]:
@@ -455,7 +455,7 @@ class ConfigLoader:
             )
             PyFunceble.storage.FLATTEN_CONFIGURATION = {}
             PyFunceble.storage.HTTP_CODES = Box({})
-            PyFunceble.storage.COLLECTION = Box({})
+            PyFunceble.storage.PLATFORM = Box({})
             PyFunceble.storage.LINKS = Box({})
             PyFunceble.storage.PROXY = Box({})
         except (AttributeError, TypeError):  # pragma: no cover ## Safety.

PyFunceble/data/infrastructure/.PyFunceble_production.yaml

@@ -240,8 +240,8 @@ lookup:
   # Activates the usage of the reputation data reputation.
   reputation: no
 
-  # Activate the usage of the collection.
-  collection: no
+  # Activate the usage of the platform to lookup status.
+  platform: no
 
   # Sets the timeout to apply to each of our lookup tools who support a timeout
   # option.
@@ -424,21 +424,66 @@ links:
   api_date_format: "https://pyfunceble.funilrys.com/api/date-format"
   api_no_referrer: "https://pyfunceble.funilrys.com/api/no-referrer"
 
-collection:
-  # Provides everything related to the collection.
+platform:
+  # Provides everything related to the platform.
 
-  # Activates the push of dataset into the collection.
+  # Activates the push of dataset into the platform.
   # WARNING: This is useless, if you don't have an API Token set as the
-  # COLLECTION_API_TOKEN environment variable.
+  # PYFUNCEBLE_PLATFORM_API_TOKEN environment variable.
   push: no
 
   # Sets the preferred pull origin.
   #
+  # When choosing `recommended`, the system will pull the recommended status
+  # that is provided and calculated by the platform.
+  #
   # When choosing, `frequent`, the system will pull the most frequent status
-  # that is provided and calculated by the collection.
+  # that is provided and calculated by the platform.
   #
   # When choosing, `latest`, the system will pull the latest status that is
-  # provided and available into the collection.
+  # provided and available into the platform.
   #
   # Available: frequent | latest | recommended
   preferred_status_origin: recommended
+
+  # Defines the checker type to prioritize when trying to fullfil platform
+  # contracts.
+  #
+  # Notes:
+  #   1. This is a list. The order matters.
+  #   2. One can overwrite this value, by settings a comma separated list of
+  #      checker type to prioritize through the PYFUNCEBLE_PLATFORM_CHECKER_PRIORITY
+  #      environment variable.
+  #   3. When set to `none`, the platform will throw a random contract at us.
+  #
+  # Example:
+  #   Prioritize availability checker until no contract is available, then
+  #   prioritize syntax checker until no contract is available, then prioritize
+  #   reputation checker until no contract is available.
+  #
+  #   - availability
+  #   - syntax
+  #   - reputation
+  #
+  # Available: none | availability | reputation | syntax
+  checker_priority:
+    - none
+
+  # Defines the checker type to exclude when trying to fullfil platform
+  # contracts.
+  #
+  # Notes:
+  #   1. This is a list.
+  #   2. One can overwrite this value, by settings a comma separated list of
+  #      checker type to exclude through the PYFUNCEBLE_PLATFORM_CHECKER_EXCLUDE
+  #      environment variable.
+  #   3. When set to `none`, no checker type will be excluded.
+  #
+  # Example:
+  #   Exclude the reputation checker from the list of checker to use to fullfil.
+  #
+  #   - reputation
+  #
+  # Available: none | availability | reputation | syntax
+  checker_exclude:
+    - none

PyFunceble/dataset/autocontinue/csv.py

@@ -52,7 +52,7 @@ License:
 
 import functools
 import os
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import Any, Generator, Optional, Tuple
 
 import PyFunceble.cli.storage
@@ -179,7 +179,7 @@ class CSVContinueDataset(CSVDatasetBase, ContinueDatasetBase):
         min_days = 365.25 * 20
 
         for data in self.get_filtered_content({"session_id": session_id}):
-            if (datetime.utcnow() - data["tested_at"]).days < min_days:
+            if (datetime.now(timezone.utc) - data["tested_at"]).days < min_days:
                 continue
 
             if not data["idna_subject"]:

PyFunceble/dataset/autocontinue/sql.py

@@ -50,7 +50,7 @@ License:
     limitations under the License.
 """
 
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Generator, Tuple
 
 import PyFunceble.cli.factory
@@ -94,7 +94,7 @@ class SQLDBContinueDataset(SQLDBDatasetBase, ContinueDatasetBase):
 
     @SQLDBDatasetBase.execute_if_authorized(None)
     def get_to_test(self, session_id: str) -> Generator[Tuple[str], str, None]:
-        twenty_years_ago = datetime.utcnow() - timedelta(days=365.25 * 20)
+        twenty_years_ago = datetime.now(timezone.utc) - timedelta(days=365.25 * 20)
 
         result = (
             self.db_session.query(self.ORM_OBJ)

PyFunceble/dataset/csv_base.py

@@ -52,7 +52,7 @@ License:
 
 import csv
 import tempfile
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Generator, Optional, Tuple
 
 import PyFunceble.facility
@@ -210,7 +210,9 @@ class CSVDatasetBase(DBDatasetBase):
                     try:
                         row["tested_at"] = datetime.fromisoformat(row["tested_at"])
                     except (TypeError, ValueError):
-                        row["tested_at"] = datetime.utcnow() - timedelta(days=365)
+                        row["tested_at"] = datetime.now(timezone.utc) - timedelta(
+                            days=365
+                        )
 
                 yield row
 

PyFunceble/dataset/inactive/csv.py

@@ -51,7 +51,7 @@ License:
 """
 
 import os
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Generator, Optional, Tuple
 
 import PyFunceble.cli.storage
@@ -77,7 +77,7 @@ class CSVInactiveDataset(CSVDatasetBase, InactiveDatasetBase):
     def get_to_retest(
         self, destination: str, checker_type: str, *, min_days: Optional[int]
     ) -> Generator[Tuple[str, str, Optional[int]], dict, None]:
-        days_ago = datetime.utcnow() - timedelta(days=min_days)
+        days_ago = datetime.now(timezone.utc) - timedelta(days=min_days)
 
         for dataset in self.get_filtered_content(
             {"destination": destination, "checker_type": checker_type}
@@ -86,7 +86,7 @@ class CSVInactiveDataset(CSVDatasetBase, InactiveDatasetBase):
                 try:
                     date_of_inclusion = datetime.fromisoformat(dataset["tested_at"])
                 except (TypeError, ValueError):
-                    date_of_inclusion = datetime.utcnow() - timedelta(days=365)
+                    date_of_inclusion = datetime.now(timezone.utc) - timedelta(days=365)
             else:
                 date_of_inclusion = dataset["tested_at"]
 

PyFunceble/dataset/inactive/sql.py

@@ -50,7 +50,7 @@ License:
     limitations under the License.
 """
 
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Generator, Optional, Tuple
 
 from PyFunceble.database.sqlalchemy.all_schemas import Inactive
@@ -71,7 +71,7 @@ class SQLDBInactiveDataset(SQLDBDatasetBase, InactiveDatasetBase):
     def get_to_retest(
         self, destination: str, checker_type: str, *, min_days: Optional[int]
     ) -> Generator[Tuple[str, str, Optional[int]], dict, None]:
-        days_ago = datetime.utcnow() - timedelta(days=min_days)
+        days_ago = datetime.now(timezone.utc) - timedelta(days=min_days)
 
         result = (
             self.db_session.query(self.ORM_OBJ)

PyFunceble/dataset/sql_base.py

@@ -51,7 +51,7 @@ License:
 """
 
 import functools
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import Any, Generator, Optional
 
 import sqlalchemy.exc
@@ -306,7 +306,7 @@ class SQLDBDatasetBase(DBDatasetBase):
                 raise exception
 
             y2k38_limit = datetime(2037, 12, 31, 0, 0)
-            new_date = datetime.fromtimestamp(float(row["epoch"]))
+            new_date = datetime.fromtimestamp(float(row["epoch"]), timezone.utc)
             new_date -= new_date - y2k38_limit
 
             row["epoch"] = new_date.timestamp()

PyFunceble/dataset/whois/base.py

@@ -50,7 +50,7 @@ License:
     limitations under the License.
 """
 
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import List, Union
 
 from PyFunceble.database.sqlalchemy.all_schemas import WhoisRecord
@@ -85,7 +85,9 @@ class WhoisDatasetBase(DBDatasetBase):
         else:
             return True
 
-        return datetime.utcnow() > datetime.fromtimestamp(float(to_check))
+        return datetime.now(timezone.utc) > datetime.fromtimestamp(
+            float(to_check), timezone.utc
+        )
 
     @DBDatasetBase.execute_if_authorized(None)
     def get_filtered_row(self, row: Union[dict, WhoisRecord]) -> dict:

PyFunceble/dataset/whois/sql.py

@@ -50,7 +50,7 @@ License:
     limitations under the License.
 """
 
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import Any, Generator, Optional, Union
 
 import sqlalchemy
@@ -161,7 +161,7 @@ class SQLDBWhoisDataset(SQLDBDatasetBase, WhoisDatasetBase):
         in the past.
         """
 
-        current_timestamp = int(datetime.utcnow().timestamp())
+        current_timestamp = int(datetime.now(timezone.utc).timestamp())
 
         try:
             self.db_session.query(self.ORM_OBJ).filter(

PyFunceble/downloader/base.py

@@ -226,7 +226,7 @@ class DownloaderBase:
         Sets the current datetime into our registry.
         """
 
-        current_datetime = datetime.datetime.utcnow()
+        current_datetime = datetime.datetime.now(datetime.timezone.utc)
 
         self.all_downtimes[self.DOWNTIME_INDEX] = {
             "iso": current_datetime.isoformat(),
@@ -253,19 +253,21 @@ class DownloaderBase:
             return True
 
         last_downloaded_time = datetime.datetime.fromtimestamp(
-            self.get_current_downtime()["timestamp"]
+            self.get_current_downtime()["timestamp"], datetime.timezone.utc
         )
 
         if (
             self.DOWNLOAD_FREQUENCY <= 0
-            and (datetime.datetime.utcnow() - last_downloaded_time).seconds < 3600
+            and (
+                datetime.datetime.now(datetime.timezone.utc) - last_downloaded_time
+            ).seconds
+            < 3600
         ):
             return False
 
-        if (
-            last_downloaded_time + datetime.timedelta(days=self.DOWNLOAD_FREQUENCY)
-            <= datetime.datetime.utcnow()
-        ):
+        if last_downloaded_time + datetime.timedelta(
+            days=self.DOWNLOAD_FREQUENCY
+        ) <= datetime.datetime.now(datetime.timezone.utc):
             return True
 
         return False