Skip to content

# Subject2complements

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

::

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

Provides an easy way to convert and get the complements of a subject.

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.

## `Subject2Complements`

Bases: `ConverterBase`

Converts a given wildcard into a testable subject.

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

     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
    156

    class Subject2Complements(ConverterBase):
        """
        Converts a given wildcard into a testable subject.
        """

        _include_given: bool = False

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

            super().__init__(data_to_convert=data_to_convert)

        @ConverterBase.data_to_convert.setter
        def data_to_convert(self, value: Any) -> None:
            """
            Overrites the default behavior.

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

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

            # pylint: disable=no-member
            super(Subject2Complements, self.__class__).data_to_convert.fset(self, value)

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

            return self._include_given

        @include_given.setter
        def include_given(self, value: bool) -> None:
            """
            Provides a way to activate/deactivate the inclusion of the given
            subject into the result.

            :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._include_given = value

        def set_include_given(self, value: bool) -> "Subject2Complements":
            """
            Provides a way to activate/deactivate the inclusion of the given
            subject into the result.
            """

            self.include_given = value

            return self

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

            return self.convert(self.data_to_convert)

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

            :param data:
                The data to convert.
            """

            _ = aggressive
            result = []

            checker = DomainSyntaxChecker(data)

            if self.include_given and data not in result:
                result.append(data)

            if data.startswith("www."):
                result.append(data[4:])
            elif checker.is_valid_second_level():
                result.append(f"www.{data}")

            return result

### `include_given: bool` `property` `writable`

Provides the state of the :code:`_include_given` 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/subject2complements.py`

    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156

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

        :param data:
            The data to convert.
        """

        _ = aggressive
        result = []

        checker = DomainSyntaxChecker(data)

        if self.include_given and data not in result:
            result.append(data)

        if data.startswith("www."):
            result.append(data[4:])
        elif checker.is_valid_second_level():
            result.append(f"www.{data}")

        return result

### `data_to_convert(value)`

Overrites the default behavior.

Raises:

Type | Description
--- | ---
`TypeError` | When the given data to convert is not class:`str` or a class:`list`.

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

    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93

    @ConverterBase.data_to_convert.setter
    def data_to_convert(self, value: Any) -> None:
        """
        Overrites the default behavior.

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

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

        # pylint: disable=no-member
        super(Subject2Complements, self.__class__).data_to_convert.fset(self, value)

### `get_converted()`

Provides the converted data.

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

    128
    129
    130
    131
    132
    133

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

        return self.convert(self.data_to_convert)

### `set_include_given(value)`

Provides a way to activate/deactivate the inclusion of the given subject into the result.

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

    118
    119
    120
    121
    122
    123
    124
    125
    126

    def set_include_given(self, value: bool) -> "Subject2Complements":
        """
        Provides a way to activate/deactivate the inclusion of the given
        subject into the result.
        """

        self.include_given = value

        return self