Source code for PyFunceble.converter.input_line2subject

# pylint:disable=line-too-long
"""
The tool to check the availability or syntax of domain, IP or URL.

::


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

Provides the default input line converter.

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://pyfunceble.readthedocs.io/en/dev/

Project homepage:
    https://pyfunceble.github.io/

License:
::


    Copyright 2017, 2018, 2019, 2020, 2022 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

        http://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.
"""

from typing import Any, List

from PyFunceble.checker.syntax.ip import IPSyntaxChecker
from PyFunceble.converter.base import ConverterBase


[docs]class InputLine2Subject(ConverterBase): """ Converts/Extract the subjcts to test from an inputed line. """ COMMENT: str = "#" PARTICULAR_COMMENT: List[str] = ["!"] SPACE: str = " " NSLOOKUP_SPACE: str = "\\032" TAB: str = "\t" @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(InputLine2Subject, self.__class__).data_to_convert.fset(self, value)
[docs] def get_converted(self) -> List[str]: """ Provides the subject to test. """ result = [] subject = self.data_to_convert.strip() if subject and ( not subject.startswith(self.COMMENT) and any(not subject.startswith(x) for x in self.PARTICULAR_COMMENT) ): if self.COMMENT in subject: subject = subject[: subject.find(self.COMMENT)].strip() if self.NSLOOKUP_SPACE in subject: # Comply with RFC 6367: # Note that nslookup escapes spaces as "\032" for display # purposes, but a graphical DNS-SD browser should not. subject = subject.replace(self.NSLOOKUP_SPACE, self.SPACE) if self.SPACE in subject or self.TAB in subject: splitted = subject.split() if IPSyntaxChecker(splitted[0]).is_valid(): # This is for the hosts format. # If the first entry is an IP, we will only extract # the entries after the first one. result.extend(splitted[1:]) else: # All other cases, we extract every entries. result.extend(splitted) else: result.append(subject) return result