Skip to content

Cidr2subject

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

::

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

Provides the converter of CIDR to subjects.

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.

CIDR2Subject

Bases: ConverterBase

Converts/Extracts the subjects of from the given CIDR.

Source code in PyFunceble/converter/cidr2subject.py
class CIDR2Subject(ConverterBase):
    """
    Converts/Extracts the subjects of from the given CIDR.
    """

    ip_syntax_checker: Optional[IPSyntaxChecker] = None

    def __init__(
        self,
        data_to_convert: Optional[Any] = None,
        *,
        ip_syntax_checker: Optional[IPSyntaxChecker] = None,
    ) -> None:
        super().__init__(data_to_convert=data_to_convert)

        if ip_syntax_checker is None:
            self.ip_syntax_checker = IPSyntaxChecker()
        else:
            self.ip_syntax_checker = ip_syntax_checker

    @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`
        """

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

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

    def get_converted(self) -> List[str]:
        """
        Provides the subject-s to test.
        """

        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 = set()

        subject = data.strip()

        if subject:
            try:
                self.ip_syntax_checker.set_subject(subject)
                if self.ip_syntax_checker.is_valid_v4_range():
                    result.update(
                        str(x) for x in IPv4Network(self.ip_syntax_checker.subject)
                    )
                elif self.ip_syntax_checker.is_valid_v6_range():
                    # Not Implemented yet.
                    result.add(subject)
                else:
                    result.add(subject)
            except ValueError:
                result.add(subject)

        return list(result)

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/cidr2subject.py
def convert(self, data: Any, *, aggressive: bool = False) -> List[str]:
    """
    Converts the given dataset.

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

    _ = aggressive
    result = set()

    subject = data.strip()

    if subject:
        try:
            self.ip_syntax_checker.set_subject(subject)
            if self.ip_syntax_checker.is_valid_v4_range():
                result.update(
                    str(x) for x in IPv4Network(self.ip_syntax_checker.subject)
                )
            elif self.ip_syntax_checker.is_valid_v6_range():
                # Not Implemented yet.
                result.add(subject)
            else:
                result.add(subject)
        except ValueError:
            result.add(subject)

    return list(result)

data_to_convert(value)

Overrites the default behavior.

Raises:

Type Description
TypeError

When the given data to convert is not class:str

Source code in PyFunceble/converter/cidr2subject.py
@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`
    """

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

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

get_converted()

Provides the subject-s to test.

Source code in PyFunceble/converter/cidr2subject.py
def get_converted(self) -> List[str]:
    """
    Provides the subject-s to test.
    """

    return self.convert(self.data_to_convert)