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

PyFunceble/query/{collection.py → platform.py}

@@ -11,7 +11,7 @@ The tool to check the availability or syntax of domain, IP or URL.
     ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
     ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
 
-Provides ans interface which let us interact with the Collection API.
+Provides ans interface which let us interact with the platform API.
 
 Author:
     Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
@@ -50,7 +50,10 @@ License:
     limitations under the License.
 """
 
+# pylint: disable=too-many-lines
+
 import json
+import os
 from typing import Generator, List, Optional, Union
 
 import requests
@@ -64,16 +67,17 @@ from PyFunceble.checker.syntax.status import SyntaxCheckerStatus
 from PyFunceble.helpers.environment_variable import EnvironmentVariableHelper
 
 
-class CollectionQueryTool:
+class PlatformQueryTool:
     """
-    Provides the interface to the collection dataset.
+    Provides the interface to interact with the platform.
 
     :param token:
         The token to use to communicate with the API.
 
         .. warning::
             If :code:`None` is given, the class constructor will try to load the
-            PYFUNCEBLE_COLLECTION_API_TOKEN environment variable.
+            :code:`PYFUNCEBLE_COLLECTION_API_TOKEN` or
+            :code:`PYFUNCEBLE_PLATFORM_API_TOKEN` environment variable.
 
     :param url_base:
         The base of the URL to communicate with.
@@ -93,11 +97,13 @@ class CollectionQueryTool:
         "727294758272947115272947112272947116272947116272947104"
     )
     STD_PREFERRED_STATUS_ORIGIN: str = "frequent"
+    STD_CHECKER_PRIORITY: str = ["none"]
+    STD_CHECKER_EXCLUDE: str = ["none"]
     STD_TIMEOUT: float = 5.0
 
     _token: Optional[str] = None
     """
-    The token to use while communicating with the collection API.
+    The token to use while communicating with the platform API.
     """
 
     _url_base: Optional[str] = None
@@ -110,6 +116,16 @@ class CollectionQueryTool:
     The preferred data origin
     """
 
+    _checker_priority: Optional[List[str]] = []
+    """
+    The checker to prioritize.
+    """
+
+    _checker_exclude: Optional[List[str]] = []
+    """
+    The checker to exclude.
+    """
+
     _is_modern_api: Optional[bool] = None
     """
     Whether we are working with the modern or legacy API.
@@ -128,19 +144,35 @@ class CollectionQueryTool:
         token: Optional[str] = None,
         preferred_status_origin: Optional[str] = None,
         timeout: Optional[float] = None,
+        checker_priority: Optional[List[str]] = None,
+        checker_exclude: Optional[List[str]] = None,
     ) -> None:
         if token is not None:
             self.token = token
         else:
             self.token = EnvironmentVariableHelper(
                 "PYFUNCEBLE_COLLECTION_API_TOKEN"
-            ).get_value(default="")
+            ).get_value(default="") or EnvironmentVariableHelper(
+                "PYFUNCEBLE_PLATFORM_API_TOKEN"
+            ).get_value(
+                default=""
+            )
 
         if preferred_status_origin is not None:
             self.preferred_status_origin = preferred_status_origin
         else:
             self.guess_and_set_preferred_status_origin()
 
+        if checker_priority is not None:
+            self.checker_priority = checker_priority
+        else:
+            self.guess_and_set_checker_priority()
+
+        if checker_exclude is not None:
+            self.checker_exclude = checker_exclude
+        else:
+            self.guess_and_set_checker_exclude()
+
         if timeout is not None:
             self.timeout = timeout
         else:
@@ -148,7 +180,11 @@ class CollectionQueryTool:
 
         self._url_base = EnvironmentVariableHelper(
             "PYFUNCEBLE_COLLECTION_API_URL"
-        ).get_value(default=None)
+        ).get_value(default=None) or EnvironmentVariableHelper(
+            "PYFUNCEBLE_PLATFORM_API_URL"
+        ).get_value(
+            default=None
+        )
 
         self.session = requests.Session()
         self.session.headers.update(
@@ -161,7 +197,7 @@ class CollectionQueryTool:
 
     def __contains__(self, value: str) -> bool:
         """
-        Checks if the given value is in the collection.
+        Checks if the given value is in the platform.
 
         :param value:
             The value to check.
@@ -204,7 +240,7 @@ class CollectionQueryTool:
 
         self._token = value
 
-    def set_token(self, value: str) -> "CollectionQueryTool":
+    def set_token(self, value: str) -> "PlatformQueryTool":
         """
         Sets the value of the :code:`_token` attribute.
 
@@ -248,7 +284,7 @@ class CollectionQueryTool:
 
         self._url_base = value.rstrip("/")
 
-    def set_url_base(self, value: str) -> "CollectionQueryTool":
+    def set_url_base(self, value: str) -> "PlatformQueryTool":
         """
         Sets the base of the URL to work with.
 
@@ -285,7 +321,7 @@ class CollectionQueryTool:
 
         self._is_modern_api = value
 
-    def set_is_modern_api(self, value: bool) -> "CollectionQueryTool":
+    def set_is_modern_api(self, value: bool) -> "PlatformQueryTool":
         """
         Sets the value of the :code:`_is_modern_api` attribute.
 
@@ -322,7 +358,7 @@ class CollectionQueryTool:
 
         self._timeout = value
 
-    def set_timeout(self, value: float) -> "CollectionQueryTool":
+    def set_timeout(self, value: float) -> "PlatformQueryTool":
         """
         Sets the value of the :code:`_timeout` attribute.
 
@@ -334,7 +370,7 @@ class CollectionQueryTool:
 
         return self
 
-    def guess_and_set_is_modern_api(self) -> "CollectionQueryTool":
+    def guess_and_set_is_modern_api(self) -> "PlatformQueryTool":
         """
         Try to guess if we are working with a legacy version.
         """
@@ -387,7 +423,7 @@ class CollectionQueryTool:
 
         self._preferred_status_origin = value
 
-    def set_preferred_status_origin(self, value: str) -> "CollectionQueryTool":
+    def set_preferred_status_origin(self, value: str) -> "PlatformQueryTool":
         """
         Sets the preferred status origin.
 
@@ -399,17 +435,17 @@ class CollectionQueryTool:
 
         return self
 
-    def guess_and_set_preferred_status_origin(self) -> "CollectionQueryTool":
+    def guess_and_set_preferred_status_origin(self) -> "PlatformQueryTool":
         """
         Try to guess the preferred status origin.
         """
 
         if PyFunceble.facility.ConfigLoader.is_already_loaded():
             if isinstance(
-                PyFunceble.storage.CONFIGURATION.collection.preferred_status_origin, str
+                PyFunceble.storage.CONFIGURATION.platform.preferred_status_origin, str
             ):
                 self.preferred_status_origin = (
-                    PyFunceble.storage.CONFIGURATION.collection.preferred_status_origin
+                    PyFunceble.storage.CONFIGURATION.platform.preferred_status_origin
                 )
             else:
                 self.preferred_status_origin = self.STD_PREFERRED_STATUS_ORIGIN
@@ -418,7 +454,147 @@ class CollectionQueryTool:
 
         return self
 
-    def guess_and_set_timeout(self) -> "CollectionQueryTool":
+    @property
+    def checker_priority(self) -> Optional[List[str]]:
+        """
+        Provides the value of the :code:`_checker_priority` attribute.
+        """
+
+        return self._checker_priority
+
+    @checker_priority.setter
+    def checker_priority(self, value: List[str]) -> None:
+        """
+        Sets the checker priority to set - order matters.
+
+        :param value:
+            The value to set.
+
+        :raise TypeError:
+            When the given :code:`value` is not a :py:class:`str`.
+
+        :raise ValueError:
+            When the given :code:`value` is not supported.
+        """
+
+        accepted = []
+
+        for checker_type in value:
+            if not isinstance(checker_type, str):
+                raise TypeError(
+                    f"<checker_type> ({checker_type}) should be {str}, "
+                    "{type(checker_type)} given."
+                )
+
+            if checker_type.lower() not in self.SUPPORTED_CHECKERS + ["none"]:
+                raise ValueError(f"<checker_type> ({checker_type}) is not supported.")
+
+            accepted.append(checker_type.lower())
+
+        self._checker_priority = accepted
+
+    def set_checker_priority(self, value: List[str]) -> "PlatformQueryTool":
+        """
+        Sets the checker priority.
+
+        :parma value:
+            The value to set.
+        """
+
+        self.checker_priority = value
+
+        return self
+
+    def guess_and_set_checker_priority(self) -> "PlatformQueryTool":
+        """
+        Try to guess the checker priority to use.
+        """
+
+        if "PYFUNCEBLE_PLATFORM_CHECKER_PRIORITY" in os.environ:
+            self.checker_priority = os.environ[
+                "PYFUNCEBLE_PLATFORM_CHECKER_PRIORITY"
+            ].split(",")
+        elif PyFunceble.facility.ConfigLoader.is_already_loaded():
+            if isinstance(PyFunceble.storage.PLATFORM.checker_priority, list):
+                self.checker_priority = PyFunceble.storage.PLATFORM.checker_priority
+            else:
+                self.checker_priority = self.STD_CHECKER_PRIORITY
+        else:
+            self.checker_priority = self.STD_CHECKER_PRIORITY
+
+        return self
+
+    @property
+    def checker_exclude(self) -> Optional[List[str]]:
+        """
+        Provides the value of the :code:`_checker_exclude` attribute.
+        """
+
+        return self._checker_exclude
+
+    @checker_exclude.setter
+    def checker_exclude(self, value: List[str]) -> None:
+        """
+        Sets the checker exclude.
+
+        :param value:
+            The value to set.
+
+        :raise TypeError:
+            When the given :code:`value` is not a :py:class:`str`.
+
+        :raise ValueError:
+            When the given :code:`value` is not supported.
+        """
+
+        accepted = []
+
+        for checker_type in value:
+            if not isinstance(checker_type, str):
+                raise TypeError(
+                    f"<checker_type> ({checker_type}) should be {str}, "
+                    "{type(checker_type)} given."
+                )
+
+            if checker_type.lower() not in self.SUPPORTED_CHECKERS + ["none"]:
+                raise ValueError(f"<checker_type> ({checker_type}) is not supported.")
+
+            accepted.append(checker_type.lower())
+
+        self._checker_exclude = accepted
+
+    def set_checker_exclude(self, value: List[str]) -> "PlatformQueryTool":
+        """
+        Sets the checker to exclude.
+
+        :parma value:
+            The value to set.
+        """
+
+        self.checker_exclude = value
+
+        return self
+
+    def guess_and_set_checker_exclude(self) -> "PlatformQueryTool":
+        """
+        Try to guess the checker to exclude.
+        """
+
+        if "PYFUNCEBLE_PLATFORM_CHECKER_EXCLUDE" in os.environ:
+            self.checker_exclude = os.environ[
+                "PYFUNCEBLE_PLATFORM_CHECKER_EXCLUDE"
+            ].split(",")
+        elif PyFunceble.facility.ConfigLoader.is_already_loaded():
+            if isinstance(PyFunceble.storage.PLATFORM.checker_exclude, list):
+                self.checker_exclude = PyFunceble.storage.PLATFORM.checker_exclude
+            else:
+                self.checker_exclude = self.STD_CHECKER_EXCLUDE
+        else:
+            self.checker_exclude = self.STD_CHECKER_EXCLUDE
+
+        return self
+
+    def guess_and_set_timeout(self) -> "PlatformQueryTool":
         """
         Try to guess the timeout to use.
         """
@@ -526,6 +702,14 @@ class CollectionQueryTool:
             "shuffle": True,
         }
 
+        if "none" in self.checker_priority:
+            params["shuffle"] = True
+        else:
+            params["checker_type_priority"] = ",".join(self.checker_priority)
+
+        if "none" not in self.checker_exclude:
+            params["checker_type_exclude"] = ",".join(self.checker_exclude)
+
         try:
             response = self.session.get(
                 url,
@@ -622,7 +806,7 @@ class CollectionQueryTool:
         ],
     ) -> Optional[dict]:
         """
-        Push the given status to the collection.
+        Push the given status to the platform.
 
         :param checker_status:
             The status to push.
@@ -680,7 +864,7 @@ class CollectionQueryTool:
 
     def guess_all_settings(
         self,
-    ) -> "CollectionQueryTool":  # pragma: no cover ## Underlying tested
+    ) -> "PlatformQueryTool":  # pragma: no cover ## Underlying tested
         """
         Try to guess all settings.
         """
@@ -699,7 +883,7 @@ class CollectionQueryTool:
         self, checker_type: str, data: Union[dict, str]
     ) -> Optional[dict]:
         """
-        Submits the given status to the collection.
+        Submits the given status to the platform.
 
         :param checker_type:
             The type of the checker.

PyFunceble/storage.py

@@ -61,7 +61,7 @@ from dotenv import load_dotenv
 from PyFunceble.storage_facility import get_config_directory
 
 PROJECT_NAME: str = "PyFunceble"
-PROJECT_VERSION: str = "4.2.17.dev (Blue Duckling: Ixora)"
+PROJECT_VERSION: str = "4.2.19.dev (Blue Duckling: Ixora)"
 
 DISTRIBUTED_CONFIGURATION_FILENAME: str = ".PyFunceble_production.yaml"
 DISTRIBUTED_DIR_STRUCTURE_FILENAME: str = "dir_structure_production.json"
@@ -126,7 +126,7 @@ STATUS: Optional[Box] = Box(
     frozen_box=True,
 )
 HTTP_CODES: Optional[Box] = Box({})
-COLLECTION: Optional[Box] = Box({})
+PLATFORM: Optional[Box] = Box({})
 LINKS: Optional[Box] = Box({})
 PROXY: Optional[Box] = Box({})
 

{PyFunceble_dev-4.2.17.dist-info → PyFunceble_dev-4.2.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyFunceble-dev
-Version: 4.2.17
+Version: 4.2.19
 Summary: The tool to check the availability or syntax of domain, IP or URL.
 Home-page: https://github.com/funilrys/PyFunceble
 Author: funilrys
@@ -21,74 +21,78 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved
 Requires-Python: >=3.8, <4
 License-File: LICENSE
+Requires-Dist: dnspython[doh] ~=2.6.0
+Requires-Dist: PyYAML
+Requires-Dist: setuptools >=65.5.1
 Requires-Dist: SQLAlchemy ~=2.0
+Requires-Dist: domain2idna ~=1.12.0
+Requires-Dist: PyMySQL
+Requires-Dist: python-dotenv
+Requires-Dist: alembic
 Requires-Dist: python-box[all] ~=6.0.0
-Requires-Dist: setuptools >=65.5.1
-Requires-Dist: packaging
-Requires-Dist: shtab
 Requires-Dist: requests[socks] <3
-Requires-Dist: PyYAML
-Requires-Dist: PyMySQL
-Requires-Dist: domain2idna ~=1.12.0
-Requires-Dist: dnspython[doh] ~=2.6.0
+Requires-Dist: cryptography ~=42.0
+Requires-Dist: packaging
 Requires-Dist: colorama
-Requires-Dist: python-dotenv
 Requires-Dist: inflection
-Requires-Dist: cryptography ~=42.0
-Requires-Dist: alembic
+Requires-Dist: shtab
 Provides-Extra: dev
 Requires-Dist: black ; extra == 'dev'
 Requires-Dist: isort ; extra == 'dev'
-Requires-Dist: pylint ; extra == 'dev'
 Requires-Dist: flake8 ; extra == 'dev'
+Requires-Dist: pylint ; extra == 'dev'
 Provides-Extra: docs
-Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
 Requires-Dist: alabaster <0.8,>=0.7 ; extra == 'docs'
+Requires-Dist: urllib3 >=2.2.2 ; extra == 'docs'
 Requires-Dist: sphinx >=3.4.3 ; extra == 'docs'
+Requires-Dist: requests >=2.32.0 ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
 Requires-Dist: Pygments >=2.0 ; extra == 'docs'
 Provides-Extra: full
-Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'full'
-Requires-Dist: setuptools >=65.5.1 ; extra == 'full'
-Requires-Dist: black ; extra == 'full'
-Requires-Dist: PyMySQL ; extra == 'full'
-Requires-Dist: dnspython[doh] ~=2.6.0 ; extra == 'full'
-Requires-Dist: coverage ; extra == 'full'
+Requires-Dist: pylint ; extra == 'full'
 Requires-Dist: alabaster <0.8,>=0.7 ; extra == 'full'
-Requires-Dist: inflection ; extra == 'full'
-Requires-Dist: cryptography ~=42.0 ; extra == 'full'
-Requires-Dist: sphinx >=3.4.3 ; extra == 'full'
-Requires-Dist: PyYAML ; extra == 'full'
-Requires-Dist: isort ; extra == 'full'
-Requires-Dist: sphinx-rtd-theme ; extra == 'full'
+Requires-Dist: domain2idna ~=1.12.0 ; extra == 'full'
+Requires-Dist: python-dotenv ; extra == 'full'
 Requires-Dist: python-box[all] ~=6.0.0 ; extra == 'full'
 Requires-Dist: requests[socks] <3 ; extra == 'full'
-Requires-Dist: Pygments >=2.0 ; extra == 'full'
-Requires-Dist: flake8 ; extra == 'full'
-Requires-Dist: pylint ; extra == 'full'
-Requires-Dist: colorama ; extra == 'full'
-Requires-Dist: python-dotenv ; extra == 'full'
 Requires-Dist: packaging ; extra == 'full'
+Requires-Dist: coverage ; extra == 'full'
+Requires-Dist: isort ; extra == 'full'
+Requires-Dist: PyYAML ; extra == 'full'
+Requires-Dist: sphinx-rtd-theme ; extra == 'full'
+Requires-Dist: Pygments >=2.0 ; extra == 'full'
 Requires-Dist: shtab ; extra == 'full'
-Requires-Dist: domain2idna ~=1.12.0 ; extra == 'full'
+Requires-Dist: black ; extra == 'full'
+Requires-Dist: dnspython[doh] ~=2.6.0 ; extra == 'full'
+Requires-Dist: setuptools >=65.5.1 ; extra == 'full'
+Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'full'
+Requires-Dist: PyMySQL ; extra == 'full'
+Requires-Dist: urllib3 >=2.2.2 ; extra == 'full'
+Requires-Dist: flake8 ; extra == 'full'
+Requires-Dist: cryptography ~=42.0 ; extra == 'full'
+Requires-Dist: sphinx >=3.4.3 ; extra == 'full'
+Requires-Dist: requests >=2.32.0 ; extra == 'full'
+Requires-Dist: inflection ; extra == 'full'
 Requires-Dist: tox ; extra == 'full'
 Requires-Dist: alembic ; extra == 'full'
+Requires-Dist: colorama ; extra == 'full'
 Provides-Extra: psql
-Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'psql'
-Requires-Dist: python-box[all] ~=6.0.0 ; extra == 'psql'
+Requires-Dist: dnspython[doh] ~=2.6.0 ; extra == 'psql'
+Requires-Dist: PyYAML ; extra == 'psql'
 Requires-Dist: psycopg2 ; extra == 'psql'
 Requires-Dist: setuptools >=65.5.1 ; extra == 'psql'
-Requires-Dist: packaging ; extra == 'psql'
-Requires-Dist: shtab ; extra == 'psql'
-Requires-Dist: requests[socks] <3 ; extra == 'psql'
-Requires-Dist: PyYAML ; extra == 'psql'
-Requires-Dist: PyMySQL ; extra == 'psql'
+Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'psql'
 Requires-Dist: domain2idna ~=1.12.0 ; extra == 'psql'
-Requires-Dist: dnspython[doh] ~=2.6.0 ; extra == 'psql'
-Requires-Dist: colorama ; extra == 'psql'
+Requires-Dist: PyMySQL ; extra == 'psql'
 Requires-Dist: python-dotenv ; extra == 'psql'
-Requires-Dist: inflection ; extra == 'psql'
-Requires-Dist: cryptography ~=42.0 ; extra == 'psql'
 Requires-Dist: alembic ; extra == 'psql'
+Requires-Dist: python-box[all] ~=6.0.0 ; extra == 'psql'
+Requires-Dist: requests[socks] <3 ; extra == 'psql'
+Requires-Dist: cryptography ~=42.0 ; extra == 'psql'
+Requires-Dist: packaging ; extra == 'psql'
+Requires-Dist: colorama ; extra == 'psql'
+Requires-Dist: inflection ; extra == 'psql'
+Requires-Dist: shtab ; extra == 'psql'
 Provides-Extra: test
 Requires-Dist: tox ; extra == 'test'
 Requires-Dist: coverage ; extra == 'test'