PyFunceble-dev 4.2.7__py3-none-any.whl → 4.2.10__py3-none-any.whl

PyFunceble/data/alembic/mysql/versions/d8893cd406db_allow_whois_record_to_be_empty_null.py

@@ -5,6 +5,7 @@ Revises: 35c79626ecb9
 Create Date: 2020-08-22 17:27:52.087506
 
 """
+
 from alembic import op
 from sqlalchemy.dialects import mysql
 

PyFunceble/data/alembic/mysql/versions/e04e8301d1a2_deletion_of_the_mined_table.py

@@ -5,6 +5,7 @@ Revises: d8893cd406db
 Create Date: 2020-12-07 12:33:43.650514
 
 """
+
 import sqlalchemy as sa
 from alembic import op
 from sqlalchemy.dialects import mysql

PyFunceble/data/alembic/postgresql/versions/a32ac5d66eee_initial_version.py

@@ -5,6 +5,7 @@ Revises:
 Create Date: 2022-12-28 07:20:50.310072
 
 """
+
 import sqlalchemy as sa
 from alembic import op
 

PyFunceble/data/infrastructure/.PyFunceble_production.yaml

@@ -173,6 +173,9 @@ cli_testing:
     # Activates the reputation test.
     reputation: no
 
+    # BETA: Activates the platform contribution test.
+    platform_contribution: no
+
   days_between:
     # Provides everything which is x days periodic.
 

PyFunceble/query/collection.py

@@ -51,7 +51,7 @@ License:
 """
 
 import json
-from typing import List, Optional, Union
+from typing import Generator, List, Optional, Union
 
 import requests
 import requests.exceptions
@@ -88,6 +88,7 @@ class CollectionQueryTool:
 
     STD_URL_BASE: str = "http://localhost:8001"
     STD_PREFERRED_STATUS_ORIGIN: str = "frequent"
+    STD_TIMEOUT: float = 5.0
 
     _token: Optional[str] = None
     """
@@ -109,6 +110,11 @@ class CollectionQueryTool:
     Whether we are working with the modern or legacy API.
     """
 
+    _timeout: float = 5.0
+    """
+    The timeout to use while communicating with the API.
+    """
+
     session: Optional[requests.Session] = None
 
     def __init__(
@@ -117,6 +123,7 @@ class CollectionQueryTool:
         token: Optional[str] = None,
         url_base: Optional[str] = None,
         preferred_status_origin: Optional[str] = None,
+        timeout: Optional[float] = None,
     ) -> None:
         if token is not None:
             self.token = token
@@ -135,6 +142,11 @@ class CollectionQueryTool:
         else:
             self.guess_and_set_preferred_status_origin()
 
+        if timeout is not None:
+            self.timeout = timeout
+        else:
+            self.guess_and_set_timeout()
+
         self.session = requests.Session()
         self.session.headers.update(
             {
@@ -283,6 +295,43 @@ class CollectionQueryTool:
 
         return self
 
+    @property
+    def timeout(self) -> float:
+        """
+        Provides the value of the :code:`_timeout` attribute.
+        """
+
+        return self._timeout
+
+    @timeout.setter
+    def timeout(self, value: float) -> None:
+        """
+        Sets the value of the :code:`_timeout` attribute.
+
+        :param value:
+            The value to set.
+
+        :raise TypeError:
+            When the given :code:`value` is not a :py:class:`float`.
+        """
+
+        if not isinstance(value, (int, float)):
+            raise TypeError(f"<value> should be {float}, {type(value)} given.")
+
+        self._timeout = value
+
+    def set_timeout(self, value: float) -> "CollectionQueryTool":
+        """
+        Sets the value of the :code:`_timeout` attribute.
+
+        :param value:
+            The value to set.
+        """
+
+        self.timeout = value
+
+        return self
+
     def guess_and_set_url_base(self) -> "CollectionQueryTool":
         """
         Try to guess the URL base to work with.
@@ -307,16 +356,22 @@ class CollectionQueryTool:
         Try to guess if we are working with a legacy version.
         """
 
-        try:
-            response = self.session.get(
-                f"{self.url_base}/v1/stats/subject",
-            )
+        if self.token:
+            try:
+                response = self.session.get(
+                    f"{self.url_base}/v1/stats/subject",
+                    timeout=self.timeout,
+                )
 
-            response.raise_for_status()
+                response.raise_for_status()
 
+                self.is_modern_api = False
+            except (requests.RequestException, json.decoder.JSONDecodeError):
+                self.is_modern_api = True
+        else:
             self.is_modern_api = False
-        except (requests.RequestException, json.decoder.JSONDecodeError):
-            self.is_modern_api = True
+
+        return self
 
     @property
     def preferred_status_origin(self) -> Optional[str]:
@@ -380,7 +435,19 @@ class CollectionQueryTool:
 
         return self
 
-    def ensure_is_modern_api_is_set(func):  # pylint: disable=no-self-argument
+    def guess_and_set_timeout(self) -> "CollectionQueryTool":
+        """
+        Try to guess the timeout to use.
+        """
+
+        if PyFunceble.facility.ConfigLoader.is_already_loaded():
+            self.timeout = PyFunceble.storage.CONFIGURATION.lookup.timeout
+        else:
+            self.timeout = self.STD_TIMEOUT
+
+        return self
+
+    def ensure_modern_api(func):  # pylint: disable=no-self-argument
         """
         Ensures that the :code:`is_modern_api` attribute is set before running
         the decorated method.
@@ -394,7 +461,7 @@ class CollectionQueryTool:
 
         return wrapper
 
-    @ensure_is_modern_api_is_set
+    @ensure_modern_api
     def pull(self, subject: str) -> Optional[dict]:
         """
         Pulls all data related to the subject or :py:class:`None`
@@ -426,6 +493,7 @@ class CollectionQueryTool:
             response = self.session.post(
                 url,
                 json={"subject": subject},
+                timeout=self.timeout,
             )
 
             response_json = response.json()
@@ -452,7 +520,113 @@ class CollectionQueryTool:
 
         return None
 
-    @ensure_is_modern_api_is_set
+    @ensure_modern_api
+    def pull_contract(self, amount: int = 1) -> Generator[dict, None, None]:
+        """
+        Pulls the next amount of contracts.
+
+        :param int amount:
+            The amount of data to pull.
+
+        :return:
+            The response of the query.
+        """
+
+        PyFunceble.facility.Logger.info("Starting to pull next contract")
+
+        url = f"{self.url_base}/v1/contracts/next"
+        params = {
+            "limit": amount,
+            "shuffle": True,
+        }
+
+        try:
+            response = self.session.get(
+                url,
+                params=params,
+                timeout=self.timeout,
+            )
+
+            response_json = response.json()
+
+            if response.status_code == 200:
+                PyFunceble.facility.Logger.debug(
+                    "Successfully pulled next %r contracts. Response: %r", response_json
+                )
+
+                PyFunceble.facility.Logger.info("Finished to pull next contract")
+
+                yield response_json
+        except (requests.RequestException, json.decoder.JSONDecodeError):
+            response_json = [{"subject": {}}]
+
+        PyFunceble.facility.Logger.debug(
+            "Failed to pull next contract. Response: %r", response_json
+        )
+        PyFunceble.facility.Logger.info("Finished to pull next contracts")
+
+        yield response_json
+
+    @ensure_modern_api
+    def deliver_contract(self, contract: dict, contract_data: dict) -> Optional[dict]:
+        """
+        Delivers the given contract data.
+
+        :param contract:
+            The contract to deliver.
+        :param contract_data:
+            The data to deliver.
+
+        :return:
+            The response of the query.
+        """
+
+        PyFunceble.facility.Logger.info(
+            "Starting to deliver contract data: %r", contract
+        )
+
+        contract_id = contract["id"]
+        contract_data = (
+            contract_data.to_json()
+            if not isinstance(contract_data, dict)
+            else contract_data
+        )
+        url = f"{self.url_base}/v1/contracts/{contract_id}/delivery"
+
+        try:
+            response = self.session.post(
+                url,
+                data=contract_data.encode("utf-8"),
+                timeout=self.timeout,
+            )
+
+            response_json = response.json()
+
+            if response.status_code == 200:
+                PyFunceble.facility.Logger.debug(
+                    "Successfully delivered contract: %r. Response: %r",
+                    contract_data,
+                    response_json,
+                )
+
+                PyFunceble.facility.Logger.info(
+                    "Finished to deliver contract: %r", contract_data
+                )
+
+                return response_json
+        except (requests.RequestException, json.decoder.JSONDecodeError):
+            response_json = {}
+
+        PyFunceble.facility.Logger.debug(
+            "Failed to deliver contract: %r. Response: %r", contract_data, response_json
+        )
+        PyFunceble.facility.Logger.info(
+            "Finished to deliver contract: %r", contract_data
+        )
+
+        return None
+
+    @ensure_modern_api
     def push(
         self,
         checker_status: Union[
@@ -574,11 +748,26 @@ class CollectionQueryTool:
                 response = self.session.post(
                     url,
                     json=data,
+                    timeout=self.timeout,
+                )
+            elif isinstance(
+                data,
+                (
+                    AvailabilityCheckerStatus,
+                    SyntaxCheckerStatus,
+                    ReputationCheckerStatus,
+                ),
+            ):
+                response = self.session.post(
+                    url,
+                    json=data.to_dict(),
+                    timeout=self.timeout,
                 )
             else:
                 response = self.session.post(
                     url,
                     data=data,
+                    timeout=self.timeout,
                 )
 
             response_json = response.json()
@@ -622,6 +811,12 @@ class CollectionQueryTool:
         if not self.token:
             return None
 
+        if isinstance(
+            data,
+            (AvailabilityCheckerStatus, SyntaxCheckerStatus, ReputationCheckerStatus),
+        ):
+            data = data.to_dict()
+
         if not isinstance(data, dict):  # pragma: no cover ## Should never happen
             raise TypeError(f"<data> should be {dict}, {type(data)} given.")
 
@@ -633,6 +828,7 @@ class CollectionQueryTool:
             response = self.session.post(
                 url,
                 json=data,
+                timeout=self.timeout,
             )
 
             response_json = response.json()

PyFunceble/query/requests/adapter/https.py

@@ -113,12 +113,12 @@ class RequestHTTPSAdapter(RequestAdapterBase):
                 )
 
             if parsed_url.scheme == "https":
-                self.poolmanager.connection_pool_kw[
-                    "server_hostname"
-                ] = parsed_url.hostname
-                self.poolmanager.connection_pool_kw[
-                    "assert_hostname"
-                ] = parsed_url.hostname
+                self.poolmanager.connection_pool_kw["server_hostname"] = (
+                    parsed_url.hostname
+                )
+                self.poolmanager.connection_pool_kw["assert_hostname"] = (
+                    parsed_url.hostname
+                )
 
             # Ensure that the Hosts header is present. Otherwise, connection might
             # not work.

PyFunceble/query/whois/converter/digit2digits.py

@@ -49,6 +49,7 @@ License:
     See the License for the specific language governing permissions and
     limitations under the License.
 """
+
 # pylint: enable=line-too-long
 
 from typing import Any

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.7.dev (Blue Duckling: Ixora)"
+PROJECT_VERSION: str = "4.2.10.dev (Blue Duckling: Ixora)"
 
 DISTRIBUTED_CONFIGURATION_FILENAME: str = ".PyFunceble_production.yaml"
 DISTRIBUTED_DIR_STRUCTURE_FILENAME: str = "dir_structure_production.json"
@@ -79,7 +79,9 @@ IPV4_REPUTATION_FILENAME: str = "ipv4_reputation.data"
 IANA_DUMP_LINK: str = (
     "https://raw.githubusercontent.com/PyFunceble/iana/master/iana-domains-db.json"
 )
-PUBLIC_SUFFIX_DUMP_LINK: str = "https://raw.githubusercontent.com/PyFunceble/public-suffix/master/public-suffix.json"
+PUBLIC_SUFFIX_DUMP_LINK: str = (
+    "https://raw.githubusercontent.com/PyFunceble/public-suffix/master/public-suffix.json"
+)
 USER_AGENT_DUMP_LINK: str = (
     "https://raw.githubusercontent.com/PyFunceble/user_agents/master/user_agents.json"
 )

{PyFunceble_dev-4.2.7.dist-info → PyFunceble_dev-4.2.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyFunceble-dev
-Version: 4.2.7
+Version: 4.2.10
 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,74 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved
 Requires-Python: >=3.8, <4
 License-File: LICENSE
-Requires-Dist: inflection
+Requires-Dist: dnspython[doh] ~=2.6.0
+Requires-Dist: shtab
 Requires-Dist: domain2idna ~=1.12.0
-Requires-Dist: python-dotenv
-Requires-Dist: dnspython[doh] ~=2.0.0
+Requires-Dist: inflection
 Requires-Dist: PyMySQL
-Requires-Dist: python-box[all] ~=6.0.0
+Requires-Dist: SQLAlchemy ~=2.0
+Requires-Dist: python-dotenv
+Requires-Dist: colorama
+Requires-Dist: alembic
 Requires-Dist: requests[socks] <3
-Requires-Dist: cryptography >=3.3.2
+Requires-Dist: setuptools >=65.5.1
 Requires-Dist: packaging
 Requires-Dist: PyYAML
-Requires-Dist: shtab
-Requires-Dist: alembic
-Requires-Dist: setuptools >=65.5.1
-Requires-Dist: SQLAlchemy ~=2.0
-Requires-Dist: colorama
+Requires-Dist: python-box[all] ~=6.0.0
+Requires-Dist: cryptography ~=42.0
 Provides-Extra: dev
-Requires-Dist: flake8 ; extra == 'dev'
 Requires-Dist: isort ; extra == 'dev'
-Requires-Dist: pylint ; extra == 'dev'
 Requires-Dist: black ; extra == 'dev'
+Requires-Dist: pylint ; extra == 'dev'
+Requires-Dist: flake8 ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: alabaster <0.8,>=0.7 ; extra == 'docs'
-Requires-Dist: sphinx >=3.4.3 ; extra == 'docs'
-Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
 Requires-Dist: Pygments >=2.0 ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
+Requires-Dist: sphinx >=3.4.3 ; extra == 'docs'
 Provides-Extra: full
-Requires-Dist: alembic ; extra == 'full'
 Requires-Dist: PyMySQL ; extra == 'full'
-Requires-Dist: sphinx-rtd-theme ; extra == 'full'
 Requires-Dist: isort ; extra == 'full'
-Requires-Dist: black ; extra == 'full'
+Requires-Dist: Pygments >=2.0 ; extra == 'full'
 Requires-Dist: flake8 ; extra == 'full'
-Requires-Dist: tox ; extra == 'full'
-Requires-Dist: dnspython[doh] ~=2.0.0 ; extra == 'full'
-Requires-Dist: python-box[all] ~=6.0.0 ; extra == 'full'
-Requires-Dist: cryptography >=3.3.2 ; extra == 'full'
-Requires-Dist: packaging ; extra == 'full'
-Requires-Dist: coverage ; extra == 'full'
-Requires-Dist: setuptools >=65.5.1 ; extra == 'full'
 Requires-Dist: alabaster <0.8,>=0.7 ; extra == 'full'
-Requires-Dist: colorama ; extra == 'full'
-Requires-Dist: pylint ; extra == 'full'
+Requires-Dist: dnspython[doh] ~=2.6.0 ; extra == 'full'
 Requires-Dist: domain2idna ~=1.12.0 ; extra == 'full'
 Requires-Dist: python-dotenv ; extra == 'full'
+Requires-Dist: colorama ; extra == 'full'
+Requires-Dist: packaging ; extra == 'full'
+Requires-Dist: pylint ; extra == 'full'
+Requires-Dist: tox ; extra == 'full'
+Requires-Dist: black ; extra == 'full'
+Requires-Dist: coverage ; extra == 'full'
 Requires-Dist: requests[socks] <3 ; extra == 'full'
-Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'full'
+Requires-Dist: PyYAML ; extra == 'full'
+Requires-Dist: python-box[all] ~=6.0.0 ; extra == 'full'
+Requires-Dist: shtab ; extra == 'full'
 Requires-Dist: sphinx >=3.4.3 ; extra == 'full'
-Requires-Dist: Pygments >=2.0 ; extra == 'full'
+Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'full'
 Requires-Dist: inflection ; extra == 'full'
-Requires-Dist: shtab ; extra == 'full'
-Requires-Dist: PyYAML ; extra == 'full'
+Requires-Dist: alembic ; extra == 'full'
+Requires-Dist: setuptools >=65.5.1 ; extra == 'full'
+Requires-Dist: sphinx-rtd-theme ; extra == 'full'
+Requires-Dist: cryptography ~=42.0 ; extra == 'full'
 Provides-Extra: psql
-Requires-Dist: inflection ; extra == 'psql'
+Requires-Dist: dnspython[doh] ~=2.6.0 ; extra == 'psql'
+Requires-Dist: shtab ; extra == 'psql'
 Requires-Dist: domain2idna ~=1.12.0 ; extra == 'psql'
-Requires-Dist: python-dotenv ; extra == 'psql'
-Requires-Dist: psycopg2 ; extra == 'psql'
-Requires-Dist: dnspython[doh] ~=2.0.0 ; extra == 'psql'
+Requires-Dist: inflection ; extra == 'psql'
 Requires-Dist: PyMySQL ; extra == 'psql'
-Requires-Dist: python-box[all] ~=6.0.0 ; extra == 'psql'
+Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'psql'
+Requires-Dist: python-dotenv ; extra == 'psql'
+Requires-Dist: colorama ; extra == 'psql'
+Requires-Dist: alembic ; extra == 'psql'
 Requires-Dist: requests[socks] <3 ; extra == 'psql'
-Requires-Dist: cryptography >=3.3.2 ; extra == 'psql'
+Requires-Dist: setuptools >=65.5.1 ; extra == 'psql'
+Requires-Dist: psycopg2 ; extra == 'psql'
 Requires-Dist: packaging ; extra == 'psql'
 Requires-Dist: PyYAML ; extra == 'psql'
-Requires-Dist: shtab ; extra == 'psql'
-Requires-Dist: alembic ; extra == 'psql'
-Requires-Dist: setuptools >=65.5.1 ; extra == 'psql'
-Requires-Dist: SQLAlchemy ~=2.0 ; extra == 'psql'
-Requires-Dist: colorama ; extra == 'psql'
+Requires-Dist: python-box[all] ~=6.0.0 ; extra == 'psql'
+Requires-Dist: cryptography ~=42.0 ; extra == 'psql'
 Provides-Extra: test
 Requires-Dist: tox ; extra == 'test'
 Requires-Dist: coverage ; extra == 'test'