Skip to content

Wildcard2subject

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

::

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

Provides an easy way to convert wildcard subject into a testable 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.

Wildcard2Subject

Bases: ConverterBase

Converts a given wildcard into a testable subject.

Source code in PyFunceble/converter/wildcard2subject.py
class Wildcard2Subject(ConverterBase):
    """
    Converts a given wildcard into a testable subject.
    """

    WILDCARD: str = "*."

    @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(Wildcard2Subject, self.__class__).data_to_convert.fset(self, value)

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

        return self.convert(self.data_to_convert)

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

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

        _ = aggressive
        subject = data.strip()

        if not subject:
            return None

        if subject.startswith(self.WILDCARD):
            return subject[2:]

        return subject

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

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

    _ = aggressive
    subject = data.strip()

    if not subject:
        return None

    if subject.startswith(self.WILDCARD):
        return subject[2:]

    return subject

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/wildcard2subject.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(Wildcard2Subject, self.__class__).data_to_convert.fset(self, value)

get_converted()

Provides the converted data.

Source code in PyFunceble/converter/wildcard2subject.py
def get_converted(self) -> str:
    """
    Provides the converted data.
    """

    return self.convert(self.data_to_convert)