Skip to content

# Cli

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

::

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

Provides the endpoint of the PyFunceble CLI tool

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

## `add_arguments_to_parser(parser, arguments)`

Adds the given argument into the given parser.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148

    def add_arguments_to_parser(
        parser: Union[argparse.ArgumentParser, argparse._ArgumentGroup],
        arguments: List[Tuple[List[str], dict]],
    ) -> None:
        """
        Adds the given argument into the given parser.
        """

        for pos_args, opt_args in arguments:
            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(".", "__")

            if not complete_value:
                parser.add_argument(*pos_args, **opt_args)
            else:
                parser.add_argument(*pos_args, **opt_args).complete = complete_value

## `ask_authorization_to_merge_config(missing_key=None)`

Asks the end-user for the authorization to merge the upstream configuration and - finally - return the new authorization status.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`missing_key` | `Optional[str]` | The name of a missing key. If not given, a more generic message will be given to end-user. | `None`

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    1305
    1306
    1307
    1308
    1309
    1310
    1311
    1312
    1313
    1314
    1315
    1316
    1317
    1318
    1319
    1320
    1321
    1322
    1323
    1324
    1325
    1326
    1327
    1328
    1329
    1330
    1331
    1332
    1333
    1334
    1335
    1336
    1337
    1338
    1339
    1340
    1341

    def ask_authorization_to_merge_config(missing_key: Optional[str] = None) -> bool:
        """
        Asks the end-user for the authorization to merge the upstream
        configuration and - finally - return the new authorization status.

        :param missing_key:
            The name of a missing key. If not given, a more generic message will be
            given to end-user.
        """

        if missing_key:
            message = (
                f"{colorama.Fore.RED}{colorama.Style.BRIGHT}The {missing_key!r} "
                f"key is missing from your configuration file."
                f"{colorama.Style.RESET_ALL}\n"
                f"Are we authorized to merge it from upstream ? {colorama.Style.BRIGHT}"
                "[y/n] "
            )
        else:
            message = (
                f"{colorama.Fore.RED}{colorama.Style.BRIGHT}A "
                f"key is missing from your configuration file."
                f"{colorama.Style.RESET_ALL}\n"
                f"Are we authorized to merge it from upstream ? {colorama.Style.BRIGHT}"
                "[y/n] "
            )

        while True:
            response = input(message).lower()

            if response[0] not in ("y", "n"):
                continue

            if response[0] == "y":
                return True

            return False

## `get_ci_group_data()`

Provides the argument of the CI group data.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    1129
    1130
    1131
    1132
    1133
    1134
    1135
    1136
    1137
    1138
    1139
    1140
    1141
    1142
    1143
    1144
    1145
    1146
    1147
    1148
    1149
    1150
    1151
    1152
    1153
    1154
    1155
    1156
    1157
    1158
    1159
    1160
    1161
    1162
    1163
    1164
    1165
    1166
    1167
    1168
    1169
    1170
    1171
    1172
    1173
    1174
    1175
    1176
    1177
    1178
    1179
    1180
    1181
    1182
    1183
    1184
    1185
    1186
    1187
    1188
    1189
    1190
    1191
    1192
    1193
    1194
    1195
    1196

    def get_ci_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the CI group data.
        """

        return [
            (
                ["--ci-max-minutes"],
                {
                    "dest": "cli_testing.ci.max_exec_minutes",
                    "type": int,
                    "help": "Sets the number of minutes to wait before starting\n"
                    "to stop a CI session. %s"
                    % get_configured_value("cli_testing.ci.max_exec_minutes"),
                },
            ),
            (
                ["--ci"],
                {
                    "dest": "cli_testing.ci.active",
                    "action": "store_true",
                    "help": "Activates or disables the Continuous Integration\n"
                    "mechanism. %s" % get_configured_value("cli_testing.ci.active"),
                },
            ),
            (
                ["--ci-branch"],
                {
                    "dest": "cli_testing.ci.branch",
                    "type": str,
                    "help": "Sets our git working branch. This is the branch\n"
                    "from where we are supposed to store the tests\n"
                    "(excepts the final results). %s"
                    % get_configured_value("cli_testing.ci.branch"),
                },
            ),
            (
                ["--ci-distribution-branch"],
                {
                    "dest": "cli_testing.ci.distribution_branch",
                    "type": str,
                    "help": "Sets our git distributions branch. This is the\n"
                    "branch from where we are supposed to store and push\n"
                    "the final results. %s"
                    % get_configured_value("cli_testing.ci.distribution_branch"),
                },
            ),
            (
                ["--ci-command"],
                {
                    "dest": "cli_testing.ci.command",
                    "type": str,
                    "help": "Sets the command to execute before each commit\n"
                    "(except the final one). %s"
                    % get_configured_value("cli_testing.ci.command"),
                },
            ),
            (
                ["--ci-end-command"],
                {
                    "dest": "cli_testing.ci.end_command",
                    "type": str,
                    "help": "Sets the command to execute before the final commit. %s"
                    % get_configured_value("cli_testing.ci.end_command"),
                },
            ),
            (
                ["--ci-commit-message"],
                {
                    "dest": "cli_testing.ci.commit_message",
                    "type": str,
                    "help": "Sets the commit message to apply every time we have\n"
                    "to apply a commit except for the really last one. %s"
                    % get_configured_value("cli_testing.ci.commit_message"),
                },
            ),
            (
                [
                    "--ci-end-commit-message",
                ],
                {
                    "dest": "cli_testing.ci.end_commit_message",
                    "type": str,
                    "help": "Sets the commit message to apply at the really end. %s"
                    % get_configured_value("cli_testing.ci.end_commit_message"),
                },
            ),
        ]

## `get_configured_value(entry, *, negate=False, value_only=False)`

Provides the currently configured value.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`entry` | `str` | An entry to check. multilevel should be separated with a point. | required
`negate` | `bool` | Allows us to negate the result from the configuration. | `False`
`value_only` | `bool` | Whether we should only return the value or the full message. | `False`

Raises:

Type | Description
--- | ---
`ValueError` | When the given :code:`entry` is not found.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

     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

    def get_configured_value(
        entry: str, *, negate: bool = False, value_only: bool = False
    ) -> Any:
        """
        Provides the currently configured value.

        :param entry:
            An entry to check.

            multilevel should be separated with a point.

        :param negate:
            Allows us to negate the result from the configuration.

        :param value_only:
            Whether we should only return the value or the full message.

        :raise ValueError:
            When the given :code:`entry` is not found.
        """

        if ":" in entry:
            location, var_name = entry.split(":", 1)

            if location == "cli_storage":
                result = getattr(PyFunceble.cli.storage, var_name)
            else:
                raise RuntimeError("<entry> ({entry!r}) not supported.")

            if var_name == "OUTPUT_DIRECTORY":
                result = os.path.join(*os.path.split(result)[:-1])
        else:
            result = PyFunceble.facility.ConfigLoader.get_configured_value(entry)

        if isinstance(result, str) and "%" in result:
            result = result.replace("%", "%%")

        if negate:
            result = not result

        return (
            (
                f"\n{colorama.Fore.YELLOW}{colorama.Style.BRIGHT}"
                f"Configured value: {colorama.Fore.BLUE}"
                f"{result!r}"
                f"{colorama.Style.RESET_ALL}"
            )
            if not value_only
            else result
        )

## `get_database_control_group_data()`

Provides the arguments of the database group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802

    def get_database_control_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the arguments of the database group.
        """

        return [
            (
                [
                    "--inactive-db",
                ],
                {
                    "dest": "cli_testing.inactive_db",
                    "action": "store_true",
                    "help": "Activates or disables the usage of a 'database' to\n"
                    f"store all {PyFunceble.storage.STATUS.down!r} and "
                    f"{PyFunceble.storage.STATUS.invalid!r} "
                    " subject for continuous retest. %s"
                    % get_configured_value("cli_testing.inactive_db"),
                },
            ),
            (
                [
                    "--database-type",
                ],
                {
                    "dest": "cli_testing.db_type",
                    "type": str,
                    "choices": ["csv", "mariadb", "mysql", "postgresql"],
                    "help": "Sets the database engine to use. "
                    "\nYou can choose between the following: "
                    "`csv | mariadb | mysql | postgresql` %s"
                    % get_configured_value("cli_testing.db_type"),
                },
            ),
            (
                [
                    "-dbr",
                    "--days-between-db-retest",
                ],
                {
                    "dest": "cli_testing.days_between.db_retest",
                    "type": int,
                    "help": "Sets the numbers of days since the introduction of\n"
                    "subject into the inactive dataset before it gets retested. %s"
                    % get_configured_value("cli_testing.days_between.db_retest"),
                },
            ),
            (
                [
                    "-dbc",
                    "--days-between-db-clean",
                ],
                {
                    "dest": "cli_testing.days_between.db_clean",
                    "type": int,
                    "help": argparse.SUPPRESS,
                },
            ),
            (
                [
                    "-wdb",
                    "--whois-database",
                ],
                {
                    "dest": "cli_testing.whois_db",
                    "action": "store_true",
                    "help": "Activates or disables the usage of a 'database' to\n"
                    "store the expiration date of all domains with a valid\n"
                    "expiration date. %s" % get_configured_value("cli_testing.whois_db"),
                },
            ),
        ]

## `get_default_group_data()`

Provides the argument of the default group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    1199
    1200
    1201
    1202
    1203
    1204
    1205
    1206
    1207
    1208
    1209
    1210
    1211
    1212
    1213
    1214
    1215
    1216
    1217
    1218
    1219
    1220
    1221
    1222
    1223
    1224
    1225
    1226
    1227
    1228
    1229
    1230
    1231
    1232
    1233
    1234
    1235
    1236
    1237
    1238
    1239
    1240
    1241
    1242
    1243
    1244
    1245
    1246
    1247
    1248
    1249
    1250
    1251
    1252
    1253
    1254
    1255
    1256
    1257
    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266

    def get_default_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the default group.
        """

        return [
            (
                ["--debug"],
                {
                    "dest": "debug.active",
                    "action": "store_true",
                    "help": argparse.SUPPRESS,
                },
            ),
            (
                ["--logging-level"],
                {
                    "dest": "debug.level",
                    "choices": ["debug", "info", "warning", "error", "critical"],
                    "default": None,
                    "type": str.lower,
                    "help": argparse.SUPPRESS,
                },
            ),
            (
                ["--help"],
                {
                    "action": "help",
                    "help": "Show this help message and exit.",
                    "default": argparse.SUPPRESS,
                },
            ),
            (
                [
                    "-v",
                    "--version",
                ],
                {
                    "action": "version",
                    "help": "Show the version of PyFunceble and exit.",
                    "version": "%(prog)s " + PyFunceble.storage.PROJECT_VERSION,
                },
            ),
            (
                [
                    "--config-file",
                ],
                {
                    "dest": "config_file",
                    "type": str,
                    "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,
                },
            ),
            (
                [
                    "--config-dir",
                ],
                {
                    "dest": "config_dir",
                    "type": os.path.realpath,
                    "help": "Sets the configuration directory to use.",
                    "complete": shtab.DIRECTORY,
                },
            ),
        ]

## `get_dns_control_group_data()`

Provides the argument of the DNS control group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697

    def get_dns_control_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the DNS control group.
        """

        return [
            (
                [
                    "--dns",
                ],
                {
                    "dest": "dns.server",
                    "nargs": "+",
                    "type": str,
                    "help": "Sets one or more (space separated) DNS server(s) to "
                    "use during testing."
                    "\n\nTo specify a port number for the "
                    "DNS server you append\nit as :port [ip:port].\n\n"
                    "If no port is specified, the default DNS port (53) is used. %s"
                    % get_configured_value("dns.server"),
                },
            ),
            (
                [
                    "--dns-protocol",
                ],
                {
                    "dest": "dns.protocol",
                    "type": str,
                    "choices": ["UDP", "TCP", "HTTPS", "TLS"],
                    "help": "Sets the protocol to use for the DNS queries. %s"
                    % get_configured_value("dns.protocol"),
                },
            ),
            (
                ["--follow-server-order"],
                {
                    "dest": "dns.follow_server_order",
                    "action": "store_true",
                    "help": "Let us follow or mix the order of usage of the given\n"
                    "or found DNS server(s). %s"
                    % get_configured_value("dns.follow_server_order"),
                },
            ),
            (
                ["--trust-dns-server"],
                {
                    "dest": "dns.trust_server",
                    "action": "store_true",
                    "help": "Activates or disable the trust mode.\n\n"
                    "When active, when the first read DNS server give us a negative\n"
                    "response - without error - we take it as it it.\n"
                    "Otherwise, if not active, when the first read DNS server give us\n"
                    "a negative response - without error - we still consolidate by\n"
                    "checking all given/found server.\n%s"
                    % get_configured_value("dns.trust_server"),
                },
            ),
            (
                [
                    "--dns-delay",
                ],
                {
                    "dest": "dns.delay",
                    "type": float,
                    "help": "Sets the delay (in seconds) to apply between each DNS\n "
                    "queries.\n %s" % get_configured_value("dns.delay"),
                },
            ),
        ]

## `get_filtering_group_data()`

Provides the argument of the filtering group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332

    def get_filtering_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the filtering group.
        """

        return [
            (
                [
                    "--adblock",
                ],
                {
                    "dest": "cli_decoding.adblock",
                    "action": "store_true",
                    "help": "Activates or deactivates the decoding of the adblock "
                    "format. %s" % get_configured_value("cli_decoding.adblock"),
                },
            ),
            (
                [
                    "--aggressive",
                ],
                {
                    "dest": "cli_decoding.aggressive",
                    "action": "store_true",
                    "help": argparse.SUPPRESS,
                },
            ),
            (
                ["--cidr"],
                {
                    "dest": "cli_testing.cidr_expand",
                    "action": "store_true",
                    "help": "Activates or disables the expansion of CIDR formatted\n"
                    "addresses. %s" % get_configured_value("cli_testing.cidr_expand"),
                },
            ),
            (
                [
                    "--complements",
                ],
                {
                    "dest": "cli_testing.complements",
                    "action": "store_true",
                    "help": "Activates or disables the generation and test of the\n"
                    "complements. "
                    "\nA complement is for example `example.org` if "
                    "'www.example.org'\nis given and vice-versa. %s"
                    % get_configured_value("cli_testing.complements"),
                },
            ),
            (
                [
                    "--preload",
                ],
                {
                    "dest": "cli_testing.preload_file",
                    "action": "store_true",
                    "help": "Activates or disables the preloading of the input\n"
                    "file(s) into the continue dataset before starting the tests.\n\n"
                    "This reduces the waiting time while continuing a previous\n"
                    "session.\n"
                    "Note: This is useless when the auto continue subsystem is not "
                    "active. %s" % get_configured_value("cli_testing.preload_file"),
                },
            ),
            (
                [
                    "--filter",
                ],
                {
                    "dest": "cli_testing.file_filter",
                    "type": str,
                    "help": "Regex to match in order to test a given line. %s"
                    % get_configured_value("cli_testing.file_filter"),
                },
            ),
            (
                [
                    "--mining",
                ],
                {
                    "dest": "cli_testing.mining",
                    "action": "store_true",
                    "help": "Activates or disables the mining subsystem. %s"
                    % get_configured_value("cli_testing.mining"),
                },
            ),
            (
                [
                    "--rpz",
                ],
                {
                    "dest": "cli_decoding.rpz",
                    "action": "store_true",
                    "help": "Activates or disables the decoding of RPZ policies\n"
                    "from each given input files. %s"
                    % get_configured_value("cli_decoding.rpz"),
                },
            ),
            (
                [
                    "--wildcard",
                ],
                {
                    "dest": "cli_decoding.wildcard",
                    "action": "store_true",
                    "help": "Activates or disables the decoding of wildcards for\n"
                    "each given input files. %s"
                    % get_configured_value("cli_decoding.wildcard"),
                },
            ),
        ]

## `get_multiprocessing_group_data()`

Provides the argument of the multiprocessing group data.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    1078
    1079
    1080
    1081
    1082
    1083
    1084
    1085
    1086
    1087
    1088
    1089
    1090
    1091
    1092
    1093
    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106

    def get_multiprocessing_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the multiprocessing group data.
        """

        available_cpu = os.cpu_count()

        if available_cpu is not None and available_cpu > 2:
            default_max_workers = available_cpu - 2
        else:
            default_max_workers = 1

        return [
            (
                [
                    "-w",
                    "--max-workers",
                ],
                {
                    "dest": "cli_testing.max_workers",
                    "type": int,
                    "default": default_max_workers,
                    "help": "Sets the number of maximal workers to use.\n"
                    f"If not given, {default_max_workers} "
                    "(based on the current machine) will be applied. %s"
                    % get_configured_value("cli_testing.max_workers"),
                },
            ),
        ]

## `get_output_control_group_data()`

Provides the argument of the output group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

     805
     806
     807
     808
     809
     810
     811
     812
     813
     814
     815
     816
     817
     818
     819
     820
     821
     822
     823
     824
     825
     826
     827
     828
     829
     830
     831
     832
     833
     834
     835
     836
     837
     838
     839
     840
     841
     842
     843
     844
     845
     846
     847
     848
     849
     850
     851
     852
     853
     854
     855
     856
     857
     858
     859
     860
     861
     862
     863
     864
     865
     866
     867
     868
     869
     870
     871
     872
     873
     874
     875
     876
     877
     878
     879
     880
     881
     882
     883
     884
     885
     886
     887
     888
     889
     890
     891
     892
     893
     894
     895
     896
     897
     898
     899
     900
     901
     902
     903
     904
     905
     906
     907
     908
     909
     910
     911
     912
     913
     914
     915
     916
     917
     918
     919
     920
     921
     922
     923
     924
     925
     926
     927
     928
     929
     930
     931
     932
     933
     934
     935
     936
     937
     938
     939
     940
     941
     942
     943
     944
     945
     946
     947
     948
     949
     950
     951
     952
     953
     954
     955
     956
     957
     958
     959
     960
     961
     962
     963
     964
     965
     966
     967
     968
     969
     970
     971
     972
     973
     974
     975
     976
     977
     978
     979
     980
     981
     982
     983
     984
     985
     986
     987
     988
     989
     990
     991
     992
     993
     994
     995
     996
     997
     998
     999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075

    def get_output_control_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the output group.
        """

        return [
            (
                [
                    "-a",
                    "--all",
                ],
                {
                    "dest": "cli_testing.display_mode.all",
                    "action": "store_true",
                    "help": "Activates or disables the display of the all\n"
                    "information in the table we print to stdout. %s"
                    % get_configured_value("cli_testing.display_mode.all"),
                },
            ),
            (
                [
                    "-ex",
                    "--execution",
                ],
                {
                    "dest": "cli_testing.display_mode.execution_time",
                    "action": "store_true",
                    "help": "Activates or disables the display of the execution time. %s"
                    % get_configured_value("cli_testing.display_mode.execution_time"),
                },
            ),
            (
                ["--colour", "--color"],
                {
                    "dest": "cli_testing.display_mode.colour",
                    "action": "store_true",
                    "help": "Activates or disables the coloration to STDOUT. %s"
                    % get_configured_value("cli_testing.display_mode.colour"),
                },
            ),
            (
                ["--background-colour", "--background-color"],
                {
                    "dest": "cli_testing.display_mode.background_colour",
                    "action": "store_true",
                    "help": "Activates or disables the background coloration to\n"
                    "STDOUT. %s"
                    % get_configured_value("cli_testing.display_mode.background_colour"),
                },
            ),
            (
                ["--display-status"],
                {
                    "dest": "cli_testing.display_mode.status",
                    "type": str.upper,
                    "choices": ["all"] + list(PyFunceble.storage.STATUS.values()),
                    "nargs": "+",
                    "help": "Sets the status that we are allowed to print to STDOUT.\n\n"
                    "Multiple space separated statuses can be given."
                    "%s" % get_configured_value("cli_testing.display_mode.status"),
                    "default": "all",
                },
            ),
            (
                ["--display-datetime-fmt"],
                {
                    "dest": "cli_testing.display_mode.datetime_format",
                    "type": str,
                    "help": "Sets the datetime format to use when displaying the\n"
                    "datetime of the test. %s"
                    % get_configured_value("cli_testing.display_mode.datetime_format"),
                },
            ),
            (
                [
                    "--dots",
                ],
                {
                    "dest": "cli_testing.display_mode.dots",
                    "action": "store_true",
                    "help": "Activate or disables the display of dots or other\n"
                    "characters when we skip the test of a subject. %s"
                    % get_configured_value("cli_testing.display_mode.dots"),
                },
            ),
            (
                [
                    "--hierarchical",
                ],
                {
                    "dest": "cli_testing.sorting_mode.hierarchical",
                    "action": "store_true",
                    "help": "Activates or disables the sorting of the files\n"
                    "content (output) in a hierarchical order. %s"
                    % get_configured_value("cli_testing.sorting_mode.hierarchical"),
                },
            ),
            (
                [
                    "-h",
                    "--host",
                ],
                {
                    "dest": "cli_testing.file_generation.hosts",
                    "action": "store_true",
                    "help": "Activates or disables the generation of the\n"
                    "hosts file(s). %s"
                    % get_configured_value("cli_testing.file_generation.hosts"),
                },
            ),
            (
                ["-ip", "--hosts-ip"],
                {
                    "dest": "cli_testing.hosts_ip",
                    "type": str,
                    "help": "Sets the IP to prefix each lines of the hosts file. %s"
                    % get_configured_value("cli_testing.hosts_ip"),
                },
            ),
            (
                [
                    "--merge-output",
                ],
                {
                    "dest": "cli_testing.file_generation.merge_output_dirs",
                    "action": "store_true",
                    "help": "Activates or disables the merging of the outputs of all\n"
                    "inputted files inside a single subdirectory as opposed to the\n"
                    "normal behavior. %s"
                    % get_configured_value("cli_testing.file_generation.merge_output_dirs"),
                },
            ),
            (
                [
                    "--no-files",
                ],
                {
                    "dest": "cli_testing.file_generation.no_file",
                    "action": "store_true",
                    "help": "Activates or disables the generation of any non-logs\n"
                    "file(s). %s"
                    % get_configured_value("cli_testing.file_generation.no_file"),
                },
            ),
            (
                [
                    "--output-location",
                ],
                {
                    "dest": "output_location",
                    "type": str,
                    "help": "Sets the location where we are supposed to generation\n"
                    "the output directory from. %s"
                    % get_configured_value("cli_storage:OUTPUT_DIRECTORY"),
                },
            ),
            (
                [
                    "--unified-results",
                ],
                {
                    "dest": "cli_testing.file_generation.unified_results",
                    "action": "store_true",
                    "help": "Activates or disables the generation of the unified\n"
                    "results file instead of the divided ones. %s"
                    % get_configured_value(
                        "cli_testing.file_generation.unified_results",
                    ),
                },
            ),
            (
                [
                    "--percentage",
                ],
                {
                    "dest": "cli_testing.display_mode.percentage",
                    "action": "store_true",
                    "help": "Activates or disables the display and generation\n"
                    "of the percentage - file - of each status. %s"
                    % get_configured_value("cli_testing.display_mode.percentage"),
                },
            ),
            (
                [
                    "--registrar",
                ],
                {
                    "dest": "cli_testing.display_mode.registrar",
                    "action": "store_true",
                    "help": "Activates or disables the display and generation\n"
                    "of the registrar - file - status at the end of a test.\n"
                    "The registrar file contains the top domain registrar found\n"
                    "while testing. %s"
                    % get_configured_value("cli_testing.display_mode.registrar"),
                },
            ),
            (
                [
                    "--max-registrar",
                ],
                {
                    "dest": "cli_testing.display_mode.max_registrar",
                    "type": int,
                    "default": 15,
                    "help": "Sets the maximal number of registrar to display.\n"
                    "Note: This argument has no effect when the --registrar\n"
                    "argument is not set. This argument only takes effect on\n"
                    "display but not\n"
                    "in the log file %s"
                    % get_configured_value("cli_testing.display_mode.max_registrar"),
                },
            ),
            (
                [
                    "--plain",
                ],
                {
                    "dest": "cli_testing.file_generation.plain",
                    "action": "store_true",
                    "help": "Activates or disables the generation of the\n"
                    "RAW file(s). What is meant is a list with only a list of\n"
                    "subject (one per line). %s"
                    % get_configured_value("cli_testing.file_generation.plain"),
                },
            ),
            (
                [
                    "-q",
                    "--quiet",
                ],
                {
                    "dest": "cli_testing.display_mode.quiet",
                    "action": "store_true",
                    "help": "Activates or disables the display of output to the\n"
                    "terminal. %s" % get_configured_value("cli_testing.display_mode.quiet"),
                },
            ),
            (
                [
                    "--share-logs",
                ],
                {
                    "dest": "share_logs",
                    "action": "store_true",
                    "help": argparse.SUPPRESS,
                },
            ),
            (
                [
                    "--push-platform",
                ],
                {
                    "dest": "platform.push",
                    "action": "store_true",
                    "help": "Activates or disables the push of test result into the\n"
                    "Platform API. %s" % get_configured_value("platform.push"),
                },
            ),
            (
                [
                    "-s",
                    "--simple",
                ],
                {
                    "dest": "cli_testing.display_mode.simple",
                    "action": "store_true",
                    "help": "Activates or disables the simple output mode. %s"
                    % get_configured_value("cli_testing.display_mode.simple"),
                },
            ),
        ]

## `get_proxy_control_group_data()`

Provides the argument of the proxy control group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728

    def get_proxy_control_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the proxy control group.
        """

        return [
            (
                [
                    "--http-proxy",
                ],
                {
                    "dest": "proxy.global.http",
                    "type": str,
                    "help": "Sets the proxy to use when testing subjects over HTTP. %s"
                    % get_configured_value("proxy.global.http"),
                },
            ),
            (
                [
                    "--https-proxy",
                ],
                {
                    "dest": "proxy.global.https",
                    "type": str,
                    "help": "Sets the proxy to use when testing subjects over HTTPS. %s"
                    % get_configured_value("proxy.global.https"),
                },
            ),
        ]

## `get_source_group_data()`

Provides the arguments of the source group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    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
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218

    def get_source_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the arguments of the source group.
        """

        return [
            (
                [
                    "-d",
                    "--domain",
                ],
                {
                    "dest": "domains",
                    "type": str.lower,
                    "nargs": "+",
                    "help": "Test one or more domains, separated by spaces.\n\n"
                    "When this option is used, no output files are generated.",
                },
            ),
            (
                [
                    "-u",
                    "--url",
                ],
                {
                    "dest": "urls",
                    "type": str,
                    "nargs": "+",
                    "help": "Test one or more full URL, separated by spaces.",
                },
            ),
            (
                [
                    "-f",
                    "--file",
                ],
                {
                    "dest": "files",
                    "type": str,
                    "nargs": "+",
                    "help": "Read a local or remote (RAW link) file and test all "
                    "domains inside it."
                    "\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,
                },
            ),
            (
                [
                    "-uf",
                    "--url-file",
                ],
                {
                    "dest": "url_files",
                    "type": str,
                    "nargs": "+",
                    "help": "Read a local or remote (RAW link) file and test all "
                    "(full) URLs inside it."
                    "\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. "
                    "\n\nThis argument test if an URL is available. It ONLY test "
                    "full URLs.",
                    "complete": shtab.FILE,
                },
            ),
        ]

## `get_test_control_group_data()`

Provides the argument of the test control data group.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625

    def get_test_control_group_data() -> List[Tuple[List[str], dict]]:
        """
        Provides the argument of the test control data group.
        """

        return [
            (
                [
                    "--chancy",
                    "--ludicrous",
                ],
                {
                    "dest": "cli_testing.chancy_tester",
                    "action": "store_true",
                    "help": "Activates a chancy mode that unleashes the safety\n"
                    "workflow in place. \n\n"
                    f"{colorama.Fore.RED}WARNING: You shouldn't have to use this "
                    "unless you feel really lucky\n"
                    "and trust your machine. This mode makes things look 'fast',\n"
                    "but it may produce some unexpected results if N process\n"
                    "simultaneously write the same output file.\n"
                    "This mode makes the graphical CLI output unparsable - either.\n"
                    f"\n{colorama.Fore.GREEN}MAY THE FORCE BE WITH YOU!"
                    f"\n{colorama.Style.RESET_ALL}%s"
                    % get_configured_value("cli_testing.chancy_tester"),
                },
            ),
            (
                [
                    "-c",
                    "--auto-continue",
                    "--continue",
                ],
                {
                    "dest": "cli_testing.autocontinue",
                    "action": "store_true",
                    "help": "Activates or disables the autocontinue subsystem. %s"
                    % get_configured_value("cli_testing.autocontinue"),
                },
            ),
            (
                [
                    "--cooldown-time",
                ],
                {
                    "dest": "cli_testing.cooldown_time",
                    "type": float,
                    "help": "Sets the cooldown time (in second) to apply between\n"
                    "each test. %s" % get_configured_value("cli_testing.cooldown_time"),
                },
            ),
            (
                [
                    "--local",
                ],
                {
                    "dest": "cli_testing.local_network",
                    "action": "store_true",
                    "help": "Activates or disables the consideration of the test(s)\n"
                    "in or for a local or private network context. %s"
                    % get_configured_value("cli_testing.local_network"),
                },
            ),
            (
                ["--platform-preferred-origin"],
                {
                    "dest": "platform.preferred_status_origin",
                    "type": str,
                    "choices": ["frequent", "latest", "recommended"],
                    "help": "Sets the preferred status origin. %s"
                    % get_configured_value("platform.preferred_status_origin"),
                },
            ),
            (
                ["--platform-lookup"],
                {
                    "dest": "lookup.platform",
                    "action": "store_true",
                    "help": "Activates or disables the usage of the Platform lookup\n"
                    "whether possible. %s" % get_configured_value("lookup.platform"),
                },
            ),
            (
                ["--platform-lookup-only"],
                {
                    "dest": "self_contained.lookup.platform",
                    "action": "store_true",
                    "help": "Only perform a Platform lookup.",
                },
            ),
            (
                ["--dns-lookup"],
                {
                    "dest": "lookup.dns",
                    "action": "store_true",
                    "help": "Activates or disables the usage of the DNS lookup\n"
                    "whether possible. %s" % get_configured_value("lookup.dns"),
                },
            ),
            (
                ["--dns-lookup-only"],
                {
                    "dest": "self_contained.lookup.dns",
                    "action": "store_true",
                    "help": "Only perform a DNS lookup.",
                },
            ),
            (
                ["--http", "--http-status-code-lookup"],
                {
                    "dest": "lookup.http_status_code",
                    "action": "store_true",
                    "help": "Switch the value of the usage of HTTP code. %s"
                    % get_configured_value("lookup.http_status_code"),
                },
            ),
            (
                ["--http-only", "--http-status-code-lookup-only"],
                {
                    "dest": "self_contained.lookup.http_status_code",
                    "action": "store_true",
                    "help": "Only perform a HTTP Code lookup.",
                },
            ),
            (
                [
                    "--netinfo-lookup",
                ],
                {
                    "dest": "lookup.netinfo",
                    "action": "store_true",
                    "help": "Activates or disables the usage of the network\n"
                    "information (or network socket) whether possible. %s"
                    % get_configured_value("lookup.netinfo"),
                },
            ),
            (
                ["--netinfo-lookup-only"],
                {
                    "dest": "self_contained.lookup.netinfo",
                    "action": "store_true",
                    "help": "Only perform a network information (or network "
                    "socket) lookup.",
                },
            ),
            (
                [
                    "--special-lookup",
                ],
                {
                    "dest": "lookup.special",
                    "action": "store_true",
                    "help": "Activates or disables the usage of our SPECIAL and\n"
                    "extra rules whether possible. %s"
                    % get_configured_value("lookup.special"),
                },
            ),
            (
                ["--special-lookup-only"],
                {
                    "dest": "self_contained.lookup.special",
                    "action": "store_true",
                    "help": "Only perform a SPECIAL lookup.",
                },
            ),
            (
                [
                    "--whois-lookup",
                ],
                {
                    "dest": "lookup.whois",
                    "action": "store_true",
                    "help": "Activates or disables the usage of the WHOIS record\n"
                    "(or better said the expiration date in it) whether possible. %s"
                    % get_configured_value("lookup.whois"),
                },
            ),
            (
                ["--whois-lookup-only"],
                {
                    "dest": "self_contained.lookup.whois",
                    "action": "store_true",
                    "help": "Only perform a WHOIS lookup.",
                },
            ),
            (
                [
                    "--reputation-lookup",
                ],
                {
                    "dest": "lookup.reputation",
                    "action": "store_true",
                    "help": "Activates or disables the usage of the reputation\n"
                    "dataset whether possible. %s"
                    % get_configured_value("lookup.reputation"),
                },
            ),
            (
                ["--reputation-lookup-only"],
                {
                    "dest": "self_contained.lookup.reputation",
                    "action": "store_true",
                    "help": "Only perform a reputation lookup.",
                },
            ),
            (
                [
                    "--reputation",
                ],
                {
                    "dest": "cli_testing.testing_mode.reputation",
                    "action": "store_true",
                    "help": "Activates or disables the reputation checker. %s"
                    % get_configured_value("cli_testing.testing_mode.reputation"),
                },
            ),
            (
                [
                    "--syntax",
                ],
                {
                    "dest": "cli_testing.testing_mode.syntax",
                    "action": "store_true",
                    "help": "Activates or disables the syntax checker. %s"
                    % get_configured_value("cli_testing.testing_mode.syntax"),
                },
            ),
            (
                [
                    "-t",
                    "--timeout",
                ],
                {
                    "dest": "lookup.timeout",
                    "type": float,
                    "default": 5.0,
                    "help": "Sets the default timeout to apply to each lookup\n"
                    "utilities every time it is possible to define a timeout. %s"
                    % get_configured_value("lookup.timeout"),
                },
            ),
            (
                [
                    "--max-http-retries",
                ],
                {
                    "dest": "max_http_retries",
                    "type": int,
                    "default": 3,
                    "help": "Sets the maximum number of retries for an HTTP "
                    "request. %s" % get_configured_value("max_http_retries"),
                },
            ),
            (
                [
                    "-ua",
                    "--user-agent",
                ],
                {
                    "dest": "user_agent.custom",
                    "type": str,
                    "help": "Sets the user agent to use.\n\nIf not given, we try to "
                    "get the latest (automatically) for you.",
                },
            ),
            (
                [
                    "--user-agent-reference",
                ],
                {
                    "dest": "user_agent.reference",
                    "type": str,
                    "help": "Sets the reference to append to the user agent.\n\n"
                    "This is useful when you want to add a reference to the "
                    "user agent. %s" % get_configured_value("user_agent.reference"),
                },
            ),
            (
                [
                    "-vsc",
                    "--verify-ssl-certificate",
                ],
                {
                    "dest": "verify_ssl_certificate",
                    "action": "store_true",
                    "help": "Activates or disables the verification of the SSL/TLS\n"
                    "certificate when testing for URL. %s"
                    % get_configured_value("verify_ssl_certificate"),
                },
            ),
        ]

## `platform_parser(parser)`

Adds the platform group to the given parser.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    1288
    1289
    1290
    1291
    1292
    1293
    1294
    1295
    1296
    1297
    1298
    1299
    1300
    1301
    1302

    def platform_parser(
        parser: Union[argparse.ArgumentParser, argparse._SubParsersAction],
    ) -> None:
        """
        Adds the platform group to the given parser.
        """

        platform = parser.add_parser(
            "platform",
            add_help=False,
            epilog=PyFunceble.cli.storage.STD_EPILOG,
        )

        args = [
            (
                ["cli_testing.testing_mode.platform_contribution"],
                {
                    "default": get_configured_value(
                        "cli_testing.testing_mode.platform_contribution", value_only=True
                    ),
                    "action": "store_%s"
                    % str(
                        not get_configured_value(
                            "cli_testing.testing_mode.platform_contribution",
                            value_only=True,
                        )
                    ).lower(),
                    "help": argparse.SUPPRESS,
                },
            )
        ]

        add_arguments_to_parser(platform, args)
        add_arguments_to_parser(platform, get_default_group_data())

## `tool()`

Provides the CLI of PyFunceble.

Source code in `PyFunceble/cli/entry_points/pyfunceble/cli.py`

    1344
    1345
    1346
    1347
    1348
    1349
    1350
    1351
    1352
    1353
    1354
    1355
    1356
    1357
    1358
    1359
    1360
    1361
    1362
    1363
    1364
    1365
    1366
    1367
    1368
    1369
    1370
    1371
    1372
    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    1397
    1398
    1399
    1400
    1401
    1402
    1403
    1404
    1405
    1406
    1407
    1408
    1409
    1410
    1411
    1412
    1413
    1414
    1415
    1416
    1417
    1418
    1419
    1420
    1421
    1422
    1423
    1424
    1425
    1426
    1427
    1428
    1429
    1430
    1431
    1432
    1433
    1434
    1435
    1436
    1437
    1438
    1439
    1440
    1441
    1442
    1443
    1444
    1445
    1446
    1447
    1448
    1449
    1450
    1451
    1452
    1453
    1454
    1455
    1456
    1457
    1458
    1459
    1460
    1461
    1462
    1463
    1464
    1465
    1466
    1467
    1468
    1469
    1470
    1471
    1472
    1473
    1474
    1475
    1476
    1477
    1478
    1479
    1480
    1481
    1482
    1483
    1484
    1485
    1486
    1487
    1488
    1489
    1490

    def tool() -> None:
        """
        Provides the CLI of PyFunceble.
        """

        # pylint: disable=too-many-locals

        # We start with loading the configuration. That way, we don't have to
        # think of this anymore as soon as the CLI is called.
        # As the merging is now done on demand and not on first hand, this will
        # give us a bit of agility.
        PyFunceble.facility.ConfigLoader.start()

        colorama.init(autoreset=True)

        description = (
            f"{colorama.Style.BRIGHT}{colorama.Fore.GREEN}PyFunceble"
            f"{colorama.Style.RESET_ALL} - "
            "The tool to check the availability or syntax of domain, IP or URL.\n\n"
            f"{colorama.Style.BRIGHT}Note:{colorama.Style.RESET_ALL}\n"
            "    All arguments listed bellow acts a switch to your configuration file-s.\n"
            "    This means that if (e.g.) 'file_generation.no_file' is set to 'true' "
            "its value\n"
            "    will be switch to 'false' at the runtime if the '--no-files' argument is "
            "being used.\n"
            "    Meaning that output files will be generated."
        )

        our_epilog = (
            f"{colorama.Style.BRIGHT}Examples:{colorama.Style.RESET_ALL}\n\n"
            "    Check the availability of 'example.com'.\n"
            "       $ pyfunceble -d example.com\n\n"
            "    Check the availability of 'example.com' with a simple (stdout) output.\n"
            "       $ pyfunceble -s -d example.com\n\n"
            "    Check the availability of 'example.com' with extended (stdout) output.\n"
            "       $ pyfunceble -a -d example.com\n\n"
            "    Check the availability of 'example.com' and 'example.org'.\n"
            "       $ pyfunceble -d example.com example.org\n\n"
            "    Check the availability of 'https://example.com'.\n"
            "       $ pyfunceble -u https://example.com\n\n"
            "    Check the availability of 'https://example.com' and "
            "'https://example.org'.\n"
            "       $ pyfunceble -u https://example.com https://example.com\n\n"
            "    Check the syntax of 'example.com'.\n"
            "       $ pyfunceble --syntax -d example.com\n\n"
            "    Check the reputation of 'example.com'.\n"
            "       $ pyfunceble --reputation -d example.com\n\n"
            "    Check the availability of all subjects in the 'myhosts' file.\n"
            "       $ pyfunceble -f myhosts\n\n"
            "    Check the availability of all subjects in the 'myhosts' and 'yourhosts' "
            "files.\n"
            "       $ pyfunceble -f myhosts yourhosts\n\n"
            "\n\n"
            f"{colorama.Style.BRIGHT}{colorama.Fore.YELLOW}For an in-depth usage, "
            "explanation and examples of the arguments,\n"
            f"you should read the documentation at{colorama.Fore.GREEN} "
            "https://docs.pyfunceble.com"
            f"{colorama.Style.RESET_ALL}\n\n"
        )

        parser = OurArgumentParser(
            description=description,
            epilog=our_epilog + PyFunceble.cli.storage.STD_EPILOG,
            add_help=False,
            formatter_class=argparse.RawTextHelpFormatter,
        )

        # pylint:  disable=possibly-unused-variable

        command_sub = parser.add_subparsers(dest="command", help=argparse.SUPPRESS)

        shtab.add_argument_to(
            parser,
            option_string=["--show-completion"],
            help="Show Shell completion script and exit.",
        )
        source_group = parser.add_argument_group("Test sources")
        filtering_group = parser.add_argument_group(
            "Source filtering, decoding, conversion and expansion"
        )
        test_control_group = parser.add_argument_group("Test control")
        dns_control_group = parser.add_argument_group("DNS control")
        proxy_control_group = parser.add_argument_group("Proxy control")
        database_control_group = parser.add_argument_group("Databases")
        output_control_group = parser.add_argument_group("Output control")
        multiprocessing_group = parser.add_argument_group("Multiprocessing")
        ci_group = parser.add_argument_group("CI / CD")

        funcs = [
            get_source_group_data,
            get_filtering_group_data,
            get_test_control_group_data,
            get_dns_control_group_data,
            get_proxy_control_group_data,
            get_database_control_group_data,
            get_output_control_group_data,
            get_multiprocessing_group_data,
            get_ci_group_data,
        ]

        parse_funcs = [platform_parser]

        for func in funcs:
            parser_name = func.__name__.replace("get_", "").replace("_data", "")

            try:
                add_arguments_to_parser(locals()[parser_name], func())
            except ValueError as exception:
                exception_message = str(exception)
                if "configuration" not in exception_message:
                    raise exception

                missing_key = RegexHelper(r"<entry>\s\(\'(.*)\'\)").match(
                    exception_message, return_match=True, group=1
                )

                if ask_authorization_to_merge_config(missing_key):
                    PyFunceble.facility.ConfigLoader.set_merge_upstream(True).start()
                    add_arguments_to_parser(locals()[parser_name], func())
                else:
                    print(
                        f"{colorama.Fore.RED}{colorama.Style.BRIGHT}Could not find "
                        f"the {missing_key!r} in your configuration.\n"
                        f"{colorama.Fore.MAGENTA}Please fix your "
                        "configuration file manually or fill a new issue if you "
                        "don't understand this error."
                    )
                    sys.exit(1)

        for func in parse_funcs:
            func(command_sub)

        add_arguments_to_parser(parser, get_default_group_data())

        args = parser.parse_args()

        if any(
            getattr(args, x)
            for x in [
                "domains",
                "urls",
                "files",
                "url_files",
            ]
        ) or bool(args.command):
            SystemIntegrator(args).start()
            SystemLauncher(args).start()