Skip to content

# Base

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

::

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

Provides the base of all syntax checker classes.

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.

## `SyntaxCheckerBase`

Bases: `CheckerBase`

Provides the base of all our syntax checker classes.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | Optional, The subject to work with. | `None`

Source code in `PyFunceble/checker/syntax/base.py`

     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

    class SyntaxCheckerBase(CheckerBase):
        """
        Provides the base of all our syntax checker classes.

        :param str subject:
            Optional, The subject to work with.
        """

        db_session: Optional[Session] = None

        status: Optional[SyntaxCheckerStatus] = None

        params: Optional[SyntaxCheckerParams] = None

        def __init__(
            self,
            subject: Optional[str] = None,
            db_session: Optional[Session] = None,
        ) -> None:
            self.params = SyntaxCheckerParams()

            self.status = SyntaxCheckerStatus()
            self.status.params = self.params

            super().__init__(subject=subject, db_session=db_session)

        def subject_propagator(self) -> "CheckerBase":
            """
            Propagate the currently set subject.

            .. warning::
                You are not invited to run this method directly.
            """

            if self.status.subject_kind is None:
                self.status = SyntaxCheckerStatus()
                self.params = SyntaxCheckerParams()
                self.status.params = self.params

            return super().subject_propagator()

        @CheckerBase.ensure_subject_is_given
        @CheckerBase.update_status_date_after_query
        def query_status(self) -> "SyntaxCheckerBase":
            """
            Queries the status.
            """

            if self.is_valid():
                self.status.status = PyFunceble.storage.STATUS.valid
            else:
                self.status.status = PyFunceble.storage.STATUS.invalid

            self.status.status_source = "SYNTAX"

            return self

        @CheckerBase.ensure_subject_is_given
        def is_valid(self) -> bool:
            raise NotImplementedError()

        # pylint: disable=useless-super-delegation
        def get_status(
            self,
        ) -> Optional[SyntaxCheckerStatus]:  # pragma: no cover ## Safety.
            return super().get_status()

### `query_status()`

Queries the status.

Source code in `PyFunceble/checker/syntax/base.py`

    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118

    @CheckerBase.ensure_subject_is_given
    @CheckerBase.update_status_date_after_query
    def query_status(self) -> "SyntaxCheckerBase":
        """
        Queries the status.
        """

        if self.is_valid():
            self.status.status = PyFunceble.storage.STATUS.valid
        else:
            self.status.status = PyFunceble.storage.STATUS.invalid

        self.status.status_source = "SYNTAX"

        return self

### `subject_propagator()`

Propagate the currently set subject.

.. warning:: You are not invited to run this method directly.

Source code in `PyFunceble/checker/syntax/base.py`

     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102

    def subject_propagator(self) -> "CheckerBase":
        """
        Propagate the currently set subject.

        .. warning::
            You are not invited to run this method directly.
        """

        if self.status.subject_kind is None:
            self.status = SyntaxCheckerStatus()
            self.params = SyntaxCheckerParams()
            self.status.params = self.params

        return super().subject_propagator()