Skip to content

# Base

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides the base of all WHOIS related dataset.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

## `WhoisDatasetBase`

Bases: `DBDatasetBase`

Provides the base of all Whois related interface.

Source code in `PyFunceble/dataset/whois/base.py`

     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111

    class WhoisDatasetBase(DBDatasetBase):
        """
        Provides the base of all Whois related interface.
        """

        FIELDS: List[str] = [
            "subject",
            "idna_subject",
            "expiration_date",
            "epoch",
            "registrar",
        ]

        COMPARISON_FIELDS: List[str] = ["subject", "idna_subject"]

        @staticmethod
        def is_expired(row: Union[dict, WhoisRecord]) -> bool:
            """
            Given a row, we look if the row is expired.
            """

            if isinstance(row, WhoisRecord):
                to_check = row.epoch
            elif "epoch" in row:
                to_check = row["epoch"]
            else:
                return True

            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:
            """
            Removes all unkowns fields (not declared) from the given row.

            :param row:
                The row to work with.
            """

            if isinstance(row, WhoisDatasetBase):
                row = row.to_dict()

            result = super().get_filtered_row(row)

            if "epoch" in result and isinstance(result["epoch"], float):
                # We do this here because we have to convert to a string in
                # order to be able to write into the CSV file.
                result["epoch"] = str(result["epoch"])

            return result

### `get_filtered_row(row)`

Removes all unkowns fields (not declared) from the given row.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`row` | `Union[dict, WhoisRecord]` | The row to work with. | required

Source code in `PyFunceble/dataset/whois/base.py`

     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111

    @DBDatasetBase.execute_if_authorized(None)
    def get_filtered_row(self, row: Union[dict, WhoisRecord]) -> dict:
        """
        Removes all unkowns fields (not declared) from the given row.

        :param row:
            The row to work with.
        """

        if isinstance(row, WhoisDatasetBase):
            row = row.to_dict()

        result = super().get_filtered_row(row)

        if "epoch" in result and isinstance(result["epoch"], float):
            # We do this here because we have to convert to a string in
            # order to be able to write into the CSV file.
            result["epoch"] = str(result["epoch"])

        return result

### `is_expired(row)` `staticmethod`

Given a row, we look if the row is expired.

Source code in `PyFunceble/dataset/whois/base.py`

    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90

    @staticmethod
    def is_expired(row: Union[dict, WhoisRecord]) -> bool:
        """
        Given a row, we look if the row is expired.
        """

        if isinstance(row, WhoisRecord):
            to_check = row.epoch
        elif "epoch" in row:
            to_check = row["epoch"]
        else:
            return True

        return datetime.now(timezone.utc) > datetime.fromtimestamp(
            float(to_check), timezone.utc
        )