Skip to content

File

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

::

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

Provides the file printer.

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.

FilePrinter

Bases: PrinterBase

Provides the file printer.

Source code in PyFunceble/cli/filesystem/printer/file.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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
class FilePrinter(PrinterBase):
    """
    Provides the file printer.
    """

    STD_FILE_GENERATION: str = (
        f"# Generated by {PyFunceble.storage.PROJECT_NAME} "
        f"(v{PyFunceble.storage.PROJECT_VERSION.split()[0]}) "
        f"/ {PyFunceble.storage.SHORT_REPO_LINK}\n"
    )

    file_helper: FileHelper = FileHelper()

    _destination: Optional[str] = None
    allow_coloration: bool = True

    def __init__(
        self,
        template_to_use: Optional[str] = None,
        *,
        dataset: Optional[Dict[str, str]] = None,
        destination: Optional[str] = None,
        **kwargs,
    ) -> None:
        if destination is not None:
            self.destination = destination

        super().__init__(template_to_use=template_to_use, dataset=dataset, **kwargs)

    def ensure_destination_is_given(func):  # pylint: disable=no-self-argument
        """
        Ensures that the destination is given before launching the
        decorated method.

        :raise TypeError:
            When the current :code:`self.template_to_use` is not set.
        """

        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            if not isinstance(self.destination, str):
                raise TypeError("<self.destination> is not given.")

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

        return wrapper

    def propagate_destination(func):  # pylint: disable=no-self-argument
        """
        Propagates the new value of the destination just after launching the
        decorated method.
        """

        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            result = func(self, *args, **kwargs)  # pylint: disable=not-callable

            self.file_helper.set_path(self.destination)

            return result

        return wrapper

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

        return self._destination

    @destination.setter
    @propagate_destination
    def destination(self, value: str) -> None:
        """
        Sets the destination to use.

        :param value:
            The value to set.

        :raise TypeError:
            When the given :code:`value` is not a :py:class:`str`.
        :raise ValueError:
            When teh 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._destination = value

    def set_destination(self, value: str) -> "FilePrinter":
        """
        Sets the destination to use.

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

        self.destination = value

        return self

    @staticmethod
    def get_generation_date_line() -> str:
        """
        Provides the line which informs of the date a file was generated.
        """

        return f"# Date of generation: {datetime.now(timezone.utc).isoformat()}"

    @ensure_destination_is_given
    def print_interpolated_line(self) -> None:
        """
        Prints the interpolated line into the destination.
        """

        PyFunceble.facility.Logger.info(
            "Started to write into %r.", self.file_helper.path
        )

        line_to_print = self.get_line_to_print() + "\n"
        without_header = ["hosts", "plain"]

        PyFunceble.facility.Logger.debug("Line to print: %r", line_to_print)

        if not self.file_helper.exists():
            self.file_helper.write(self.STD_FILE_GENERATION, overwrite=True)
            self.file_helper.write(self.get_generation_date_line())
            self.file_helper.write("\n\n")

            if self.template_to_use not in without_header:
                self.file_helper.write(self.get_header_to_print())
                self.file_helper.write("\n")

        self.file_helper.write(line_to_print)

        PyFunceble.facility.Logger.info(
            "Finished to write into %r.", self.file_helper.path
        )

destination: Optional[str] property writable

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

ensure_destination_is_given(func)

Ensures that the destination is given before launching the decorated method.

Raises:

Type Description
TypeError

When the current :code:self.template_to_use is not set.
Source code in PyFunceble/cli/filesystem/printer/file.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def ensure_destination_is_given(func):  # pylint: disable=no-self-argument
    """
    Ensures that the destination is given before launching the
    decorated method.

    :raise TypeError:
        When the current :code:`self.template_to_use` is not set.
    """

    @functools.wraps(func)
    def wrapper(self, *args, **kwargs):
        if not isinstance(self.destination, str):
            raise TypeError("<self.destination> is not given.")

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

    return wrapper

get_generation_date_line() staticmethod

Provides the line which informs of the date a file was generated.

Source code in PyFunceble/cli/filesystem/printer/file.py 
169
170
171
172
173
174
175
@staticmethod
def get_generation_date_line() -> str:
    """
    Provides the line which informs of the date a file was generated.
    """

    return f"# Date of generation: {datetime.now(timezone.utc).isoformat()}"

print_interpolated_line()

Prints the interpolated line into the destination.

Source code in PyFunceble/cli/filesystem/printer/file.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
@ensure_destination_is_given
def print_interpolated_line(self) -> None:
    """
    Prints the interpolated line into the destination.
    """

    PyFunceble.facility.Logger.info(
        "Started to write into %r.", self.file_helper.path
    )

    line_to_print = self.get_line_to_print() + "\n"
    without_header = ["hosts", "plain"]

    PyFunceble.facility.Logger.debug("Line to print: %r", line_to_print)

    if not self.file_helper.exists():
        self.file_helper.write(self.STD_FILE_GENERATION, overwrite=True)
        self.file_helper.write(self.get_generation_date_line())
        self.file_helper.write("\n\n")

        if self.template_to_use not in without_header:
            self.file_helper.write(self.get_header_to_print())
            self.file_helper.write("\n")

    self.file_helper.write(line_to_print)

    PyFunceble.facility.Logger.info(
        "Finished to write into %r.", self.file_helper.path
    )

propagate_destination(func)

Propagates the new value of the destination just after launching the decorated method.

Source code in PyFunceble/cli/filesystem/printer/file.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
def propagate_destination(func):  # pylint: disable=no-self-argument
    """
    Propagates the new value of the destination just after launching the
    decorated method.
    """

    @functools.wraps(func)
    def wrapper(self, *args, **kwargs):
        result = func(self, *args, **kwargs)  # pylint: disable=not-callable

        self.file_helper.set_path(self.destination)

        return result

    return wrapper

set_destination(value)

Sets the destination to use.

Parameters:

Name Type Description Default
value str

The value to set.

 required
Source code in PyFunceble/cli/filesystem/printer/file.py 
157
158
159
160
161
162
163
164
165
166
167
def set_destination(self, value: str) -> "FilePrinter":
    """
    Sets the destination to use.

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

    self.destination = value

    return self