Skip to content

# Cleanup

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

::

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

Provides everything related to the cleanup of the filesystem.

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.

## `FilesystemCleanup`

Bases: `FilesystemDirBase`

Provides the interface for the cleanup of the filesystem.

Source code in `PyFunceble/cli/filesystem/cleanup.py`

     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

    class FilesystemCleanup(FilesystemDirBase):
        """
        Provides the interface for the cleanup of the filesystem.
        """

        file_helper: FileHelper = FileHelper()

        def clean_database(self) -> "FilesystemCleanup":
            """
            Cleanups the uneeded data that were stored in the database.

            .. warning::
                This method cleans everything except the WHOIS records.
            """

            if (
                PyFunceble.cli.facility.CredentialLoader.is_already_loaded()
                and self.db_session
            ):
                to_clean = [Continue, Inactive]

                for orm_obj in to_clean:
                    # pylint: disable=line-too-long
                    with PyFunceble.cli.factory.DBSession.get_db_session() as db_session:
                        db_session.query(orm_obj).delete(synchronize_session=False)
                        db_session.commit()

                        PyFunceble.facility.Logger.info(
                            "Deleted all entries in %r.", orm_obj
                        )

        @property
        def output_files_to_delete(self) -> List[str]:
            """
            Provides the list of output files to delete.
            """

            result = []
            files_to_ignore = [".gitignore", ".keep", ".gitkeep"]

            for root, _, files in os.walk(self.get_output_basedir()):
                for file in files:
                    if file in files_to_ignore:
                        continue

                    result.append(os.path.join(root, file))

            return result

        def clean_output_files(self) -> "FilesystemCleanup":
            """
            Cleanups the unneeded files from the output directory.
            """

            for file in self.output_files_to_delete:
                self.file_helper.set_path(file).delete()

                PyFunceble.facility.Logger.debug("Deleted: %r.", file)

            return self

        def start(self) -> "FilesystemCleanup":
            """
            Starts the cleanup of everything unneeded.
            """

            self.clean_output_files()

            return self

### `output_files_to_delete: List[str]` `property`

Provides the list of output files to delete.

### `clean_database()`

Cleanups the uneeded data that were stored in the database.

.. warning:: This method cleans everything except the WHOIS records.

Source code in `PyFunceble/cli/filesystem/cleanup.py`

    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94

    def clean_database(self) -> "FilesystemCleanup":
        """
        Cleanups the uneeded data that were stored in the database.

        .. warning::
            This method cleans everything except the WHOIS records.
        """

        if (
            PyFunceble.cli.facility.CredentialLoader.is_already_loaded()
            and self.db_session
        ):
            to_clean = [Continue, Inactive]

            for orm_obj in to_clean:
                # pylint: disable=line-too-long
                with PyFunceble.cli.factory.DBSession.get_db_session() as db_session:
                    db_session.query(orm_obj).delete(synchronize_session=False)
                    db_session.commit()

                    PyFunceble.facility.Logger.info(
                        "Deleted all entries in %r.", orm_obj
                    )

### `clean_output_files()`

Cleanups the unneeded files from the output directory.

Source code in `PyFunceble/cli/filesystem/cleanup.py`

    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124

    def clean_output_files(self) -> "FilesystemCleanup":
        """
        Cleanups the unneeded files from the output directory.
        """

        for file in self.output_files_to_delete:
            self.file_helper.set_path(file).delete()

            PyFunceble.facility.Logger.debug("Deleted: %r.", file)

        return self

### `start()`

Starts the cleanup of everything unneeded.

Source code in `PyFunceble/cli/filesystem/cleanup.py`

    126
    127
    128
    129
    130
    131
    132
    133

    def start(self) -> "FilesystemCleanup":
        """
        Starts the cleanup of everything unneeded.
        """

        self.clean_output_files()

        return self