PyFunceble-dev 4.3.0a21__py3-none-any.whl → 4.3.0a24__py3-none-any.whl

PyFunceble/checker/syntax/params.py

@@ -59,5 +59,5 @@ from PyFunceble.checker.params_base import CheckerParamsBase
 @dataclasses.dataclass
 class SyntaxCheckerParams(CheckerParamsBase):
     """
-    Provides the description of a syntax checker paramaters.
+    Provides the description of a syntax checker parameters.
     """

PyFunceble/checker/syntax/second_lvl_domain.py

@@ -53,7 +53,6 @@ License:
 from typing import Optional
 
 from PyFunceble.checker.syntax.domain_base import DomainSyntaxCheckerBase
-from PyFunceble.helpers.regex import RegexHelper
 
 
 class SecondLvlDomainSyntaxChecker(DomainSyntaxCheckerBase):
@@ -108,15 +107,15 @@ class SecondLvlDomainSyntaxChecker(DomainSyntaxCheckerBase):
             if "." in subject_without_suffix:
                 return False
 
-            return RegexHelper(self.REGEX_VALID_DOMAIN).match(
+            return self.regex_helper.set_regex(self.REGEX_VALID_DOMAIN).match(
                 self.idna_subject, return_match=False
-            ) or RegexHelper(self.REGEX_VALID_RELAXED_DOMAIN).match(
+            ) or self.regex_helper.set_regex(self.REGEX_VALID_RELAXED_DOMAIN).match(
                 self.idna_subject, return_match=False
             )
 
         if "." in subject_without_extension:
             return False
 
-        return RegexHelper(self.REGEX_VALID_DOMAIN).match(
+        return self.regex_helper.set_regex(self.REGEX_VALID_DOMAIN).match(
             self.idna_subject, return_match=False
         )

PyFunceble/checker/syntax/subdomain.py

@@ -51,7 +51,6 @@ License:
 """
 
 from PyFunceble.checker.syntax.domain_base import DomainSyntaxCheckerBase
-from PyFunceble.helpers.regex import RegexHelper
 
 
 class SubDomainSyntaxChecker(DomainSyntaxCheckerBase):
@@ -89,19 +88,19 @@ class SubDomainSyntaxChecker(DomainSyntaxCheckerBase):
 
         if subject_without_suffix:
             if suffix.count(".") >= 2:
-                return RegexHelper(self.REGEX_VALID_SUBDOMAIN).match(
+                return self.regex_helper.set_regex(self.REGEX_VALID_SUBDOMAIN).match(
                     subject_without_extension, return_match=False
                 )
 
             if "." in subject_without_suffix:
-                return RegexHelper(self.REGEX_VALID_SUBDOMAIN).match(
+                return self.regex_helper.set_regex(self.REGEX_VALID_SUBDOMAIN).match(
                     self.idna_subject, return_match=False
                 )
 
             return False
 
         if "." in subject_without_extension:
-            return RegexHelper(self.REGEX_VALID_SUBDOMAIN).match(
+            return self.regex_helper.set_regex(self.REGEX_VALID_SUBDOMAIN).match(
                 subject_without_extension, return_match=False
             )
 

PyFunceble/checker/syntax/url.py

@@ -57,6 +57,8 @@ from PyFunceble.checker.base import CheckerBase
 from PyFunceble.checker.syntax.base import SyntaxCheckerBase
 from PyFunceble.checker.syntax.domain import DomainSyntaxChecker
 from PyFunceble.checker.syntax.ip import IPSyntaxChecker
+from PyFunceble.checker.syntax.params import SyntaxCheckerParams
+from PyFunceble.checker.syntax.status import SyntaxCheckerStatus
 
 
 class URLSyntaxChecker(SyntaxCheckerBase):
@@ -67,7 +69,11 @@ class URLSyntaxChecker(SyntaxCheckerBase):
         Optional, The subject to work with.
     """
 
-    def subject_propagator(self) -> CheckerBase:
+    def subject_propagator(self) -> "URLSyntaxChecker":
+        self.status = SyntaxCheckerStatus()
+        self.params = SyntaxCheckerParams()
+        self.status.params = self.params
+
         self.status.subject_kind = "url"
 
         return super().subject_propagator()
@@ -112,10 +118,7 @@ class URLSyntaxChecker(SyntaxCheckerBase):
         if not hostname:
             return False
 
-        if (
+        return (
             DomainSyntaxChecker(hostname).is_valid()
             or IPSyntaxChecker(hostname).is_valid()
-        ):
-            return True
-
-        return False
+        )

PyFunceble/checker/utils/whois.py

@@ -73,30 +73,26 @@ def get_whois_dataset_object(
         A database session to use.
 
     :raise ValueError:
-        When the given database type is unkown.
+        When the given database type is unknown.
     :raise RuntimeError:
         When the configuration was not loaded yet.
     """
 
     if PyFunceble.facility.ConfigLoader.is_already_loaded():
-        result = None
-
         if PyFunceble.storage.CONFIGURATION.cli_testing.db_type == "csv":
-            result = CSVWhoisDataset()
-        elif PyFunceble.storage.CONFIGURATION.cli_testing.db_type in (
+            return CSVWhoisDataset().set_authorized(
+                bool(PyFunceble.storage.CONFIGURATION.cli_testing.whois_db)
+            )
+
+        if PyFunceble.storage.CONFIGURATION.cli_testing.db_type in (
             "mariadb",
             "mysql",
             "postgresql",
         ):
-            result = SQLDBWhoisDataset(db_session=db_session)
-
-        if result:
-            result.set_authorized(
+            return SQLDBWhoisDataset(db_session=db_session).set_authorized(
                 bool(PyFunceble.storage.CONFIGURATION.cli_testing.whois_db)
             )
 
-            return result
-
         raise ValueError(
             "<config.db_type> "
             f"({PyFunceble.storage.CONFIGURATION.cli_testing.db_type}) is unknown."

PyFunceble/cli/continuous_integration/base.py

@@ -72,19 +72,19 @@ class ContinuousIntegrationBase:
     :param authorized:
         The authorization to run.
     :param git_email:
-        The email to apply while initilizing the git repository for push.
+        The email to apply while initializing the git repository for push.
     :param git_name:
-        The name to apply while initilizing the git repository for push.
+        The name to apply while initializing the git repository for push.
     :param git_branch:
         The branch to use while testing.
     :param git_distribution_branch:
         The branch to push the results into.
     :param token:
-        The token to apply while initilizing the git repository for push.
+        The token to apply while initializing the git repository for push.
     :param command:
         The command to execute before each push (except the latest one).
     :param end_command:
-        The commant to execute at the very end.
+        The command to execute at the very end.
     :param commit_message:
         The commit message to apply before each push (except the latest one).
     :param end_commit_message:
@@ -202,7 +202,7 @@ class ContinuousIntegrationBase:
         Otherwise, apply the given :code:`default`.
         """
 
-        def inner_metdhod(func):
+        def inner_method(func):
             @functools.wraps(func)
             def wrapper(self, *args, **kwargs):
                 if self.authorized:
@@ -211,7 +211,7 @@ class ContinuousIntegrationBase:
 
             return wrapper
 
-        return inner_metdhod
+        return inner_method
 
     def ensure_git_email_is_given(func):  # pylint: disable=no-self-argument
         """
@@ -609,7 +609,7 @@ class ContinuousIntegrationBase:
             raise TypeError(f"<value> should be {str}, {type(value)} given.")
 
         if not value:
-            raise ValueError("<value> should not be empy.")
+            raise ValueError("<value> should not be empty.")
 
         self._command = value
 
@@ -651,7 +651,7 @@ class ContinuousIntegrationBase:
             raise TypeError(f"<value> should be {str}, {type(value)} given.")
 
         if not value:
-            raise ValueError("<value> should not be empy.")
+            raise ValueError("<value> should not be empty.")
 
         self._end_command = value
 
@@ -693,7 +693,7 @@ class ContinuousIntegrationBase:
             raise TypeError(f"<value> should be {str}, {type(value)} given.")
 
         if not value:
-            raise ValueError("<value> should not be empy.")
+            raise ValueError("<value> should not be empty.")
 
         self._commit_message = value
 
@@ -735,7 +735,7 @@ class ContinuousIntegrationBase:
             raise TypeError(f"<value> should be {str}, {type(value)} given.")
 
         if not value:
-            raise ValueError("<value> should not be empy.")
+            raise ValueError("<value> should not be empty.")
 
         self._end_commit_message = value
 
@@ -835,7 +835,7 @@ class ContinuousIntegrationBase:
     @staticmethod
     def exec_command(command: str, allow_stdout: bool) -> None:
         """
-        Exceutes the given command.
+        Executes the given command.
 
         :param command:
             The command to execute.
@@ -1293,17 +1293,17 @@ class ContinuousIntegrationBase:
         The purpose of this method is to be able to have some custom init based
         on the CI we are currently on.
 
-        The init method should be manually started before runing any further
+        The init method should be manually started before running any further
         action.
 
         .. warning::
             We assume that we are aware that you should run this method first.
         """
 
-        PyFunceble.facility.Logger.info("Started initizalization of workflow.")
+        PyFunceble.facility.Logger.info("Started initialization of workflow.")
 
         self.init_git()
 
-        PyFunceble.facility.Logger.info("Finished initizalization of workflow.")
+        PyFunceble.facility.Logger.info("Finished initialization of workflow.")
 
         return self

PyFunceble/cli/credential_loader.py

@@ -66,7 +66,7 @@ from PyFunceble.helpers.environment_variable import EnvironmentVariableHelper
 
 class CredentialLoader:
     """
-    Provides our creadential loader.
+    Provides our credentials loader.
 
     The idea is to have an interface which provides the credential to use
     but at the same time load and initiate the credential interface after
@@ -123,7 +123,7 @@ class CredentialLoader:
         Otherwise, apply the given :code:`default`.
         """
 
-        def inner_metdhod(func):
+        def inner_method(func):
             @functools.wraps(func)
             def wrapper(self, *args, **kwargs):
                 if self.authorized:
@@ -132,7 +132,7 @@ class CredentialLoader:
 
             return wrapper
 
-        return inner_metdhod
+        return inner_method
 
     def start_if_not_started(func):  # pylint: disable=no-self-argument
         """
@@ -248,9 +248,7 @@ class CredentialLoader:
         else:
             user_input = input(message)
 
-        if user_input:
-            return user_input
-        return default
+        return user_input or default
 
     @execute_if_authorized(None)
     @ensure_db_type_is_given

PyFunceble/cli/entry_points/clean.py

@@ -57,7 +57,6 @@ import traceback
 
 import colorama
 
-import PyFunceble.cli.facility
 import PyFunceble.cli.storage
 import PyFunceble.cli.utils.ascii_logo
 import PyFunceble.facility

PyFunceble/cli/entry_points/production.py

@@ -71,7 +71,7 @@ def producer() -> None:  # pylint: disable=too-many-statements
     description = (
         f"{colorama.Style.BRIGHT}{colorama.Fore.GREEN}PyFunceble Production Preparator"
         f"{colorama.Style.RESET_ALL} - "
-        "The Production peparator for PyFunceble."
+        "The Production preparator for PyFunceble."
     )
 
     parser = argparse.ArgumentParser(

PyFunceble/cli/entry_points/pyfunceble/cli.py

@@ -134,13 +134,18 @@ def add_arguments_to_parser(
         if "dest" in opt_args:
             opt_args["dest"] = opt_args["dest"].replace(".", "__")
 
+        complete_value = opt_args.pop("complete", None)
+
         for index, value in enumerate(pos_args):
             if value.startswith("-") and "." not in value:
                 continue
 
             pos_args[index] = value.replace(".", "__")
 
-        parser.add_argument(*pos_args, **opt_args)
+        if not complete_value:
+            parser.add_argument(*pos_args, **opt_args)
+        else:
+            parser.add_argument(*pos_args, **opt_args).complete = complete_value
 
 
 def get_source_group_data() -> List[Tuple[List[str], dict]]:
@@ -188,6 +193,7 @@ def get_source_group_data() -> List[Tuple[List[str], dict]]:
                 "\nIf remote (RAW link) file is given, PyFunceble will download "
                 "it,\n and test the content of the given RAW link as if it was a"
                 " locally stored file.",
+                "complete": shtab.FILE,
             },
         ),
         (
@@ -206,6 +212,7 @@ def get_source_group_data() -> List[Tuple[List[str], dict]]:
                 " locally stored file. "
                 "\n\nThis argument test if an URL is available. It ONLY test "
                 "full URLs.",
+                "complete": shtab.FILE,
             },
         ),
     ]
@@ -466,7 +473,7 @@ def get_test_control_group_data() -> List[Tuple[List[str], dict]]:
             {
                 "dest": "self_contained.lookup.netinfo",
                 "action": "store_true",
-                "help": "Only perform a network information (or networket "
+                "help": "Only perform a network information (or network "
                 "socket) lookup.",
             },
         ),
@@ -1242,6 +1249,7 @@ def get_default_group_data() -> List[Tuple[List[str], dict]]:
                 "help": "Sets the configuration file to use. It can be a\n"
                 "local or remote file. Please note that this configuration can be\n"
                 "overwritten by your overwrite configuration file.",
+                "complete": shtab.FILE,
             },
         ),
         (
@@ -1252,6 +1260,7 @@ def get_default_group_data() -> List[Tuple[List[str], dict]]:
                 "dest": "config_dir",
                 "type": os.path.realpath,
                 "help": "Sets the configuration directory to use.",
+                "complete": shtab.DIRECTORY,
             },
         ),
     ]

PyFunceble/cli/execution_time.py

@@ -90,7 +90,7 @@ class ExecutionTime:
         Otherwise, apply the given :code:`default`.
         """
 
-        def inner_metdhod(func):
+        def inner_method(func):
             @functools.wraps(func)
             def wrapper(self, *args, **kwargs):
                 if self.authorized:
@@ -99,7 +99,7 @@ class ExecutionTime:
 
             return wrapper
 
-        return inner_metdhod
+        return inner_method
 
     @staticmethod
     def split_difference(start: datetime.datetime, end: datetime.datetime) -> dict:

PyFunceble/cli/filesystem/cleanup.py

@@ -55,8 +55,6 @@ from typing import List
 
 import PyFunceble.cli.facility
 import PyFunceble.cli.factory
-import PyFunceble.cli.utils.testing
-import PyFunceble.sessions
 from PyFunceble.cli.filesystem.dir_base import FilesystemDirBase
 from PyFunceble.database.sqlalchemy.all_schemas import Continue, Inactive
 from PyFunceble.helpers.file import FileHelper
@@ -71,7 +69,7 @@ class FilesystemCleanup(FilesystemDirBase):
 
     def clean_database(self) -> "FilesystemCleanup":
         """
-        Cleanups the uneeded data that were stored in the database.
+        Cleanups the unneeded data that were stored in the database.
 
         .. warning::
             This method cleans everything except the WHOIS records.

PyFunceble/cli/filesystem/dir_base.py

@@ -70,6 +70,8 @@ class FilesystemDirBase:
 
     INLINE_DEST: str = "_inline_"
 
+    directory_helper: Optional[DirectoryHelper] = None
+
     def __init__(
         self,
         parent_dirname: Optional[str] = None,
@@ -83,6 +85,8 @@ class FilesystemDirBase:
 
         self.db_session = db_session
 
+        self.directory_helper = DirectoryHelper()
+
     @property
     def parent_dirname(self) -> Optional[str]:
         """
@@ -187,5 +191,5 @@ class FilesystemDirBase:
         else:
             result = PyFunceble.cli.storage.OUTPUT_DIRECTORY
 
-        DirectoryHelper(result).create()
+        self.directory_helper.set_path(result).create()
         return result

PyFunceble/cli/filesystem/dir_structure/backup.py

@@ -55,7 +55,6 @@ import os
 import PyFunceble.facility
 from PyFunceble.cli.filesystem.dir_structure.base import DirectoryStructureBase
 from PyFunceble.helpers.dict import DictHelper
-from PyFunceble.helpers.directory import DirectoryHelper
 from PyFunceble.helpers.file import FileHelper
 from PyFunceble.helpers.hash import HashHelper
 
@@ -75,7 +74,7 @@ class DirectoryStructureBackup(DirectoryStructureBase):
         file_helper = FileHelper()
         hash_helper = HashHelper()
 
-        for file in DirectoryHelper(base_dir).list_all_files():
+        for file in self.directory_helper.set_path(base_dir).list_all_files():
             file_helper.set_path(file)
             reduced_path = self.get_path_without_base_dir(file)
 

PyFunceble/cli/filesystem/dir_structure/base.py

@@ -58,7 +58,6 @@ try:
 except ImportError:  # pragma: no cover ## Retro compatibility
     import importlib_resources as package_resources
 
-
 from PyFunceble.cli.filesystem.cleanup import FilesystemCleanup
 from PyFunceble.cli.filesystem.dir_base import FilesystemDirBase
 

PyFunceble/cli/filesystem/dir_structure/restore.py

@@ -55,7 +55,6 @@ import os
 import PyFunceble.cli.storage
 from PyFunceble.cli.filesystem.dir_structure.base import DirectoryStructureBase
 from PyFunceble.helpers.dict import DictHelper
-from PyFunceble.helpers.directory import DirectoryHelper
 from PyFunceble.helpers.file import FileHelper
 from PyFunceble.utils.platform import PlatformUtility
 
@@ -99,15 +98,14 @@ class DirectoryStructureRestoration(DirectoryStructureBase):
         backup = self.get_backup_data()
 
         base_dir = self.get_output_basedir()
-        dir_helper = DirectoryHelper()
         file_helper = FileHelper()
 
-        if dir_helper.set_path(base_dir).exists():
-            for root, _, files in os.walk(dir_helper.path):
+        if self.directory_helper.set_path(base_dir).exists():
+            for root, _, files in os.walk(self.directory_helper.path):
                 reduced_path = self.get_path_without_base_dir(root)
 
                 if reduced_path not in backup and root != reduced_path:
-                    dir_helper.set_path(root).delete()
+                    self.directory_helper.set_path(root).delete()
 
                     PyFunceble.facility.Logger.debug(
                         "Added %r into the list of directories to delete. "
@@ -117,10 +115,10 @@ class DirectoryStructureRestoration(DirectoryStructureBase):
                     continue
 
         for directory, files in backup.items():
-            dir_helper.set_path(os.path.join(base_dir, directory)).create()
+            self.directory_helper.set_path(os.path.join(base_dir, directory)).create()
 
             for file, dataset in files.items():
-                file_full_path = os.path.join(dir_helper.path, file)
+                file_full_path = os.path.join(self.directory_helper.path, file)
 
                 if (
                     file == ".gitignore"

PyFunceble/cli/filesystem/status_file.py

@@ -66,7 +66,6 @@ from PyFunceble.cli.filesystem.dir_structure.restore import (
     DirectoryStructureRestoration,
 )
 from PyFunceble.cli.filesystem.printer.file import FilePrinter
-from PyFunceble.helpers.directory import DirectoryHelper
 from PyFunceble.utils.platform import PlatformUtility
 
 
@@ -535,7 +534,7 @@ class StatusFileGenerator(FilesystemDirBase):
 
         result = super().get_output_basedir()
 
-        if not DirectoryHelper(result).exists():
+        if not self.directory_helper.set_path(result).exists():
             DirectoryStructureRestoration(self.parent_dirname).start()
         return result
 
@@ -672,7 +671,7 @@ class StatusFileGenerator(FilesystemDirBase):
                 )
 
         if self.test_dataset and "from_inactive" in self.test_dataset:
-            # Let's generate the supicious file :-)
+            # Let's generate the suspicious file :-)
             if self.status.status in [
                 PyFunceble.storage.STATUS.up,
                 PyFunceble.storage.STATUS.valid,

PyFunceble/cli/migrators/alembic.py

@@ -68,10 +68,8 @@ from alembic import command as alembic_command
 from alembic.script.base import ScriptDirectory
 
 import PyFunceble.cli.facility
-import PyFunceble.cli.factory
 import PyFunceble.cli.storage
 import PyFunceble.facility
-import PyFunceble.sessions
 from PyFunceble.cli.migrators.db_base import DBMigratorBase
 
 
@@ -97,7 +95,7 @@ class Alembic:
         Otherwise, apply the given :code:`default`.
         """
 
-        def inner_metdhod(func):
+        def inner_method(func):
             @functools.wraps(func)
             def wrapper(self, *args, **kwargs):
                 if self.authorized:
@@ -106,7 +104,7 @@ class Alembic:
 
             return wrapper
 
-        return inner_metdhod
+        return inner_method
 
     @property
     def authorized(self):

PyFunceble/cli/migrators/csv_file/inactive_source_delete.py

@@ -55,7 +55,6 @@ import os
 from typing import List
 
 import PyFunceble.cli.storage
-import PyFunceble.storage
 from PyFunceble.cli.migrators.csv_file.base import CSVFileMigratorBase
 
 

PyFunceble/cli/migrators/csv_file/whois_registrar_add.py

@@ -55,7 +55,6 @@ import os
 from typing import List
 
 import PyFunceble.cli.storage
-import PyFunceble.storage
 from PyFunceble.cli.migrators.csv_file.base import CSVFileMigratorBase
 
 

PyFunceble/cli/migrators/db_base.py

@@ -75,7 +75,7 @@ class DBMigratorBase(MigratorBase):
         Otherwise, apply the given :code:`default`.
         """
 
-        def inner_metdhod(func):
+        def inner_method(func):
             @functools.wraps(func)
             def wrapper(self, *args, **kwargs):
                 if self.authorized:
@@ -84,7 +84,7 @@ class DBMigratorBase(MigratorBase):
 
             return wrapper
 
-        return inner_metdhod
+        return inner_method
 
     @property
     def authorized(self):

PyFunceble/cli/migrators/file_cleanup/base.py

@@ -59,7 +59,7 @@ from PyFunceble.cli.utils.stdout import print_single_line
 from PyFunceble.helpers.file import FileHelper
 
 
-class FileClenupMigratorBase(MigratorBase):
+class FileCleanupMigratorBase(MigratorBase):
     """
     Provides the base of all file cleanup related migration classes.
     """
@@ -85,7 +85,7 @@ class FileClenupMigratorBase(MigratorBase):
         return wrapper
 
     @ensure_source_file_is_given
-    def migrate(self) -> "FileClenupMigratorBase":
+    def migrate(self) -> "FileCleanupMigratorBase":
         """
         Provides the migrator (itself)
         """
@@ -98,7 +98,7 @@ class FileClenupMigratorBase(MigratorBase):
         if self.print_action_to_stdout:
             print_single_line()
 
-    def start(self) -> "FileClenupMigratorBase":
+    def start(self) -> "FileCleanupMigratorBase":
         """
         Starts the migration and everything related to it.
         """

PyFunceble/cli/migrators/file_cleanup/hashes_file.py

@@ -53,11 +53,10 @@ License:
 import os
 
 import PyFunceble.cli.storage
-import PyFunceble.storage
-from PyFunceble.cli.migrators.file_cleanup.base import FileClenupMigratorBase
+from PyFunceble.cli.migrators.file_cleanup.base import FileCleanupMigratorBase
 
 
-class HashesFileCleanupMigrator(FileClenupMigratorBase):
+class HashesFileCleanupMigrator(FileCleanupMigratorBase):
     """
     Provides the interface for the cleanup of the hashes file.
     """

PyFunceble/cli/migrators/file_cleanup/mining_file.py

@@ -53,11 +53,10 @@ License:
 import os
 
 import PyFunceble.cli.storage
-import PyFunceble.storage
-from PyFunceble.cli.migrators.file_cleanup.base import FileClenupMigratorBase
+from PyFunceble.cli.migrators.file_cleanup.base import FileCleanupMigratorBase
 
 
-class MiningFileCleanupMigrator(FileClenupMigratorBase):
+class MiningFileCleanupMigrator(FileCleanupMigratorBase):
     """
     Provides the interface for the cleanup of the mining file.
     """

PyFunceble/cli/migrators/file_cleanup/production_config_file.py

@@ -52,12 +52,11 @@ License:
 
 import os
 
-import PyFunceble.cli.storage
 import PyFunceble.storage
-from PyFunceble.cli.migrators.file_cleanup.base import FileClenupMigratorBase
+from PyFunceble.cli.migrators.file_cleanup.base import FileCleanupMigratorBase
 
 
-class ProductionConfigFileCleanupMigrator(FileClenupMigratorBase):
+class ProductionConfigFileCleanupMigrator(FileCleanupMigratorBase):
     """
     Provides the interface for the cleanup of the
     :code:`.PyFunceble_production.yaml` file.