Skip to content

Base

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

::

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

Provides the base of all checker.

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.

NetInfoBase

Provides the base of network information classes.

Source code in PyFunceble/query/netinfo/base.py
class NetInfoBase:
    """
    Provides the base of network information classes.
    """

    _subject: Optional[str] = None
    base: Optional[str] = None

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

    def ensure_subject_is_given(func):  # pylint: disable=no-self-argument
        """
        Ensures that the subject 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.subject, str):
                raise TypeError(
                    f"<self.subject> should be {str}, {type(self.subject)} given."
                )

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

        return wrapper

    @property
    def subject(self) -> Optional[str]:
        """
        Provides the current state of the :code:`_subject` attribute.
        """

        return self._subject

    @subject.setter
    def subject(self, value: str) -> None:
        """
        Sets the subject to work with.

        :param value:
            The subject to set.

        :raise TypeError:
            When the given :code:`value` is not a :py:class:`str`.
        :raise ValueError:
            When the given :code:`value` is empty.
        """

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

        if not value:
            raise ValueError("<value> should not be empty.")

        self._subject = value

    def set_subject(self, value: str) -> "NetInfoBase":
        """
        Sets the subject to work with.

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

        self.subject = value

        return self

    @ensure_subject_is_given
    def get_info(self) -> Any:
        """
        Provides the wanted network information.
        """

        raise NotImplementedError()

subject: Optional[str] property writable

Provides the current state of the :code:_subject attribute.

ensure_subject_is_given(func)

Ensures that the subject is given before running the decorated method.

Raises:

Type Description
TypeError

If the subject is not a string.

Source code in PyFunceble/query/netinfo/base.py
def ensure_subject_is_given(func):  # pylint: disable=no-self-argument
    """
    Ensures that the subject 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.subject, str):
            raise TypeError(
                f"<self.subject> should be {str}, {type(self.subject)} given."
            )

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

    return wrapper

get_info()

Provides the wanted network information.

Source code in PyFunceble/query/netinfo/base.py
@ensure_subject_is_given
def get_info(self) -> Any:
    """
    Provides the wanted network information.
    """

    raise NotImplementedError()

set_subject(value)

Sets the subject to work with.

Parameters:

Name Type Description Default
value str

The subject to set.

required
Source code in PyFunceble/query/netinfo/base.py
def set_subject(self, value: str) -> "NetInfoBase":
    """
    Sets the subject to work with.

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

    self.subject = value

    return self