PyFunceble.cli.filesystem package

Subpackages

Submodules

PyFunceble.cli.filesystem.cleanup module

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

class PyFunceble.cli.filesystem.cleanup.FilesystemCleanup(parent_dirname: str | None = None, *, db_session: DBSession | None = None)[source]

Bases: FilesystemDirBase

Provides the interface for the cleanup of the filesystem.

clean_database() → FilesystemCleanup[source]: Cleanups the uneeded data that were stored in the database.

Warning

This method cleans everything except the WHOIS records.

clean_output_files() → FilesystemCleanup[source]: Cleanups the unneeded files from the output directory.

file_helper: FileHelper = <PyFunceble.helpers.file.FileHelper object>

property output_files_to_delete: List[str]: Provides the list of output files to delete.

start() → FilesystemCleanup[source]: Starts the cleanup of everything unneeded.

PyFunceble.cli.filesystem.counter module

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

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

Provides everything related to our counter tracker.

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, 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.

class PyFunceble.cli.filesystem.counter.FilesystemCounter(parent_dirname: str | None = None, *, db_session: DBSession | None = None)[source]

Bases: FilesystemJSONBase

Provides our counter.

PERCENTAGE_STATUSES: Dict[str, List[str]] = {'AVAILABILITY': ['ACTIVE', 'INACTIVE', 'INVALID'], 'REPUTATION': ['SANE', 'MALICIOUS'], 'SYNTAX': ['VALID', 'INVALID']}

SOURCE_FILE: str = 'counter.json'

STD_DATASET: Dict[str, int] = {'counter': {'ACTIVE': 0, 'INACTIVE': 0, 'INVALID': 0, 'MALICIOUS': 0, 'SANE': 0, 'VALID': 0, 'total': 0}, 'percentage': {'ACTIVE': 0, 'INACTIVE': 0, 'INVALID': 0, 'MALICIOUS': 0, 'SANE': 0, 'VALID': 0, 'total': 0}}

count(status: CheckerStatusBase) → FilesystemCounter[source]

Starts the counting process.

Parameters:: status – The status to count into our dataset.

get_dataset_for_printer() → List[Dict[str, str | int]][source]

Provides the dataset that the printer may understand.

Raises:: ValueError – When the current testing mode is not supported (yet?).

get_sorted_dataset() → List[Tuple[str, float]][source]: Provides the datasets in a sorted manner.

PyFunceble.cli.filesystem.dir_base module

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

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

Provides a common base to the manipulation of the output directory.

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, 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.

class PyFunceble.cli.filesystem.dir_base.FilesystemDirBase(parent_dirname: str | None = None, *, db_session: DBSession | None = None)[source]

Bases: object

Provides a common base for the manipulation of our output directory.

INLINE_DEST: str = '_inline_'

db_session: DBSession | None = None

property differ_to_inline: bool: Provides the current state of the _differ_to_inline attribute.

get_output_basedir() → str[source]

Provides the output base directory.

Parameters:: create_if_missing – Authorizes the creation of the directory if it’s missing.

property parent_dirname: str | None: Provides the current state of the _parent_dirname attribute.

set_differ_to_inline(value: bool) → FilesystemDirBase[source]

Allows/Disallow the split to the inline directory. The attribute can be set when you want to overwrite the behavior of the get_output_basedir method.

Parm value:: The value to set.

set_parent_dirname(value: str) → FilesystemDirBase[source]

Sets the parent dirname. The parent dirname is a directory which acts a parent into the output directory.

Parm value:: The value to set.

PyFunceble.cli.filesystem.json_base module

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

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

Provides a base for the manipulation of JSON files.

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, 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.

class PyFunceble.cli.filesystem.json_base.FilesystemJSONBase(parent_dirname: str | None = None, *, db_session: DBSession | None = None)[source]

Bases: FilesystemDirBase

A base interface for the manipulation of JSON files.

SOURCE_FILE: str | None = None

STD_DATASET: dict | list = {}

dataset: Dict[str, int] = {}

fetch_dataset() → FilesystemJSONBase[source]: Fetch the dataset from the source file.

fetch_dataset_beforehand()[source]: Updates the dataset to work with before launching the decorated method.

save_dataset() → FilesystemJSONBase[source]: Saves the current dataset into it’s final destination.

save_dataset_afterwards()[source]: Saves the dataset after launching the decorated method.

source_file_path: str | None = None

update_source_file_path_beforehand()[source]: Updates the source file before launching the decorated method.

PyFunceble.cli.filesystem.registrar_counter module

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

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

Provides everything related to the registrar counter.

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, 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.

class PyFunceble.cli.filesystem.registrar_counter.RegistrarCounter(parent_dirname: str | None = None, *, db_session: DBSession | None = None)[source]

Bases: FilesystemJSONBase

Provides our registrar stats counter.

SOURCE_FILE: str = 'registrar_counter.json'

STD_DATASET: Dict[str, int] = {'counter': {'total': 0}, 'percentage': {'total': 0}}

SUPPORTED_TEST_MODES: List[str] = ['AVAILABILITY']

count(registrar: str) → RegistrarCounter[source]

Starts the counting process.

Parameters:: registrar – The registrar to count into our dataset.

get_dataset_for_printer(*, limit: int | None = 15) → List[Dict[str, str | int]][source]

Provides the dataset that the printer may understand.

Parameters:

limit –

Maximum number of registrars to display.

Warning

If set to None, all registrars will be displayed.

Raises:

ValueError – When the current testing mode is not supported (yet?).

PyFunceble.cli.filesystem.status_file module

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

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

Provides everything related to our status file generation.

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, 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.

Bases: FilesystemDirBase

Provides an interface for the generation of the status file from a given status.

STD_ALLOW_ANALYTIC_FILES: bool = True

STD_ALLOW_HOSTS_FILES: bool = True

STD_ALLOW_PLAIN_FILES: bool = True

STD_ALLOW_UNIFIED_FILE: bool = False

STD_HOSTS_IP: str = '0.0.0.0'

property allow_analytic_files: bool: Provides the current state of the _allow_analytic_files attribute.

property allow_hosts_files: bool: Provides the current state of the _allow_hosts_files attribute.

property allow_plain_files: bool: Provides the current state of the _allow_plain_file attribute.

property allow_unified_file: bool: Provides the current state of the allow_unified_file attribute.

ensure_status_is_given()[source]

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

Raises:: TypeError – When self.status is not set.

file_printer: FilePrinter = <PyFunceble.cli.filesystem.printer.file.FilePrinter object>

generate_analytic_file() → StatusFileGenerator[source]: Generates the analytic files.

generate_hosts_file() → StatusFileGenerator[source]: Generates the hosts file.

generate_plain_file() → StatusFileGenerator[source]: Generates the plain file.

generate_splitted_status_file() → StatusFileGenerator[source]: Generates the splitted status file.

generate_unified_status_file() → StatusFileGenerator[source]: Generates the unified status file.

get_output_basedir() → str[source]

Provides the output base directory.

Parameters:: create_if_missing – Authorizes the creation of the directory if it’s missing.

guess_all_settings() → StatusFileGenerator[source]: Try to guess all settings.

guess_and_set_allow_analytic_files() → StatusFileGenerator[source]: Tries to guess the value of the allow_analytic_files from the configuration file.

guess_and_set_allow_hosts_files() → StatusFileGenerator[source]: Tries to guess the value of the allow_hosts_files from the configuration file.

guess_and_set_allow_plain_files() → StatusFileGenerator[source]: Tries to guess the value of the allow_plain_files from the configuration file.

guess_and_set_allow_unified_file() → StatusFileGenerator[source]: Tries to guess the value of the allow_unified_file from the configuration file.

guess_and_set_hosts_ip() → StatusFileGenerator[source]: Tries to guess the value of the hosts_ip from the configuration file.

property hosts_ip: str | None: Provides the current state of the _hosts_ip attribute.

set_allow_analytic_files(value: bool) → StatusFileGenerator[source]

Sets the authorization to generation of analytic files.

Parameters:: value – The value to set.

set_allow_hosts_files(value: bool) → StatusFileGenerator[source]

Sets the authorization to generation of hosts files.

Parameters:: value – The value to set.

set_allow_plain_files(value: bool) → StatusFileGenerator[source]

Sets the authorization to generation of plain files.

Parameters:: value – The value to set.

set_allow_unified_file(value: bool) → StatusFileGenerator[source]

Sets the authorization to generation of the unified status file.

Parameters:: value – The value to set.

set_hosts_ip(value: str) → StatusFileGenerator[source]

Sets the hosts IP to use while generating the hosts files.

Parameters:: value – The value to set.

set_status(value: CheckerStatusBase) → StatusFileGenerator[source]

Sets the status to work with.

Parameters:: value – The value to set.

set_test_dataset(value: dict) → StatusFileGenerator[source]

Sets the test dataset which was given to the tester.

Parameters:: value – The value to set.
Raises:: TypeError – When the given value is not a :py:class`dict`.

start() → StatusFileGenerator[source]: Starts the generation of everything possible.

property status: CheckerStatusBase: Provides the current state of the _status attribute.

property test_dataset: dict | None: Provides the current state of the _test_dataset attribute.

Module contents

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

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

Provides everything related to our very own filesystem or output structure.

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, 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.