Skip to content

# Base

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

::

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

Provides the base of all WHOIS converter/extracter class.

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 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.

## `ConverterBase`

Provides the base of all converter class.

Source code in `PyFunceble/query/whois/converter/base.py`

     57
     58
     59
     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
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125

    class ConverterBase:
        """
        Provides the base of all converter class.
        """

        _data_to_convert: Optional[Any] = None

        def __init__(self, data_to_convert: Optional[Any] = None) -> None:
            if data_to_convert is not None:
                self.data_to_convert = data_to_convert

        def ensure_data_to_convert_is_given(func):  # pylint: disable=no-self-argument
            """
            Ensures that the data to convert is given before running the decorated method.

            :raise TypeError:
                If the subject is not a string.
            """

            @functools.wraps(func)
            def wrapper(self, *args, **kwargs):
                if not isinstance(self.data_to_convert, str):
                    raise TypeError(
                        f"<self.subject> should be {str}, "
                        f"{type(self.data_to_convert)} given."
                    )

                return func(self, *args, **kwargs)  # pylint: disable=not-callable

            return wrapper

        @property
        def data_to_convert(self) -> Optional[Any]:
            """
            Provides the current state of the :code:`_data_to_convert` attribute.
            """

            return self._data_to_convert

        @data_to_convert.setter
        def data_to_convert(self, value: Any) -> Any:
            """
            Sets the data to convert / to work with.

            :param value:
                The data to convert
            """

            self._data_to_convert = value

        def set_data_to_convert(self, value: Any) -> "ConverterBase":
            """
            Sets the data to convert / to work with.

            :param value:
                The data to convert
            """

            self.data_to_convert = value

            return self

        @ensure_data_to_convert_is_given
        def get_converted(self) -> Optional[Any]:
            """
            Provides the converted data.
            """

            raise NotImplementedError()

### `data_to_convert: Optional[Any]` `property` `writable`

Provides the current state of the :code:`_data_to_convert` attribute.

### `ensure_data_to_convert_is_given(func)`

Ensures that the data to convert is given before running the decorated method.

Raises:

Type | Description
--- | ---
`TypeError` | If the subject is not a string.

Source code in `PyFunceble/query/whois/converter/base.py`

    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86

    def ensure_data_to_convert_is_given(func):  # pylint: disable=no-self-argument
        """
        Ensures that the data to convert is given before running the decorated method.

        :raise TypeError:
            If the subject is not a string.
        """

        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            if not isinstance(self.data_to_convert, str):
                raise TypeError(
                    f"<self.subject> should be {str}, "
                    f"{type(self.data_to_convert)} given."
                )

            return func(self, *args, **kwargs)  # pylint: disable=not-callable

        return wrapper

### `get_converted()`

Provides the converted data.

Source code in `PyFunceble/query/whois/converter/base.py`

    119
    120
    121
    122
    123
    124
    125

    @ensure_data_to_convert_is_given
    def get_converted(self) -> Optional[Any]:
        """
        Provides the converted data.
        """

        raise NotImplementedError()

### `set_data_to_convert(value)`

Sets the data to convert / to work with.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `Any` | The data to convert | required

Source code in `PyFunceble/query/whois/converter/base.py`

    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117

    def set_data_to_convert(self, value: Any) -> "ConverterBase":
        """
        Sets the data to convert / to work with.

        :param value:
            The data to convert
        """

        self.data_to_convert = value

        return self