Skip to content

# Base

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

::

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

Provides the base of all our converter 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, 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.

## `ConverterBase`

Provides the base of all converter class.

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

     56
     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
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155

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

        _aggressive: bool = False
        _data_to_convert: Optional[Any] = None

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

            if aggressive is not None:
                self.aggressive = aggressive

        @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) -> None:
            """
            Sets the data to convert / to work with.

            :param value:
                The value to set.
            """

            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 value to set.
            """

            self.data_to_convert = value

            return self

        @property
        def aggressive(self) -> bool:
            """
            Provides the state of the :code:`_aggressive` attribute.
            """

            return self._aggressive

        @aggressive.setter
        def aggressive(self, value: bool) -> None:
            """
            Provides a way to activate/deactivate the aggressive decoding.

            :raise TypeError:
                When the given data to convert is not :py:class:`str`
            """

            if not isinstance(value, bool):
                raise TypeError(f"<value> should be {bool}, {type(value)} given.")

            self._aggressive = value

        def set_aggressive(self, value: bool) -> "ConverterBase":
            """
            Provides a way to activate/deactivate the aggressive decoding.
            """

            self.aggressive = value

            return self

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

            raise NotImplementedError()

        def convert(self, data: Any, *, aggressive: bool = False) -> Optional[Any]:
            """
            Converts the given dataset.

            :param data:
                The data to convert.
            :param aggressive.
                Whether we should aggressively extract datasets.
            """

            raise NotImplementedError()

### `aggressive` `property` `writable`

Provides the state of the :code:`_aggressive` attribute.

### `data_to_convert` `property` `writable`

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

### `convert(data, *, aggressive=False)`

Converts the given dataset.

Parameters:

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

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

    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155

    def convert(self, data: Any, *, aggressive: bool = False) -> Optional[Any]:
        """
        Converts the given dataset.

        :param data:
            The data to convert.
        :param aggressive.
            Whether we should aggressively extract datasets.
        """

        raise NotImplementedError()

### `get_converted()`

Provides the converted data.

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

    138
    139
    140
    141
    142
    143

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

        raise NotImplementedError()

### `set_aggressive(value)`

Provides a way to activate/deactivate the aggressive decoding.

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

    129
    130
    131
    132
    133
    134
    135
    136

    def set_aggressive(self, value: bool) -> "ConverterBase":
        """
        Provides a way to activate/deactivate the aggressive decoding.
        """

        self.aggressive = value

        return self

### `set_data_to_convert(value)`

Sets the data to convert / to work with.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `Any` | The value to set. | required

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

     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105

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

        :param value:
            The value to set.
        """

        self.data_to_convert = value

        return self