PyFunceble.cli.entry_points.pyfunceble package¶

Submodules¶

PyFunceble.cli.entry_points.pyfunceble.argsparser module¶

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

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

Provides our very own argument parser

Author:: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:: https://pyfunceble.github.io/#/special-thanks
Contributors:: https://pyfunceble.github.io/#/contributors
Project link:: https://github.com/funilrys/PyFunceble
Project documentation:: https://pyfunceble.readthedocs.io/en/latest/
Project homepage:: https://pyfunceble.github.io/

License:

Copyright 2017, 2018, 2019, 2020, 2022, 2023 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

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

class PyFunceble.cli.entry_points.pyfunceble.argsparser.OurArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)[source]¶

Bases: argparse.ArgumentParser

Overwrites some behavior of the default argument parser.

parse_args(args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) → argparse.Namespace[source]¶

PyFunceble.cli.entry_points.pyfunceble.cli module¶

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://pyfunceble.readthedocs.io/en/latest/
Project homepage:: https://pyfunceble.github.io/

License:

Copyright 2017, 2018, 2019, 2020, 2022, 2023 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

    http://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.

PyFunceble.cli.entry_points.pyfunceble.cli.add_arguments_to_parser(parser: Union[argparse.ArgumentParser, argparse._ArgumentGroup], arguments: List[Tuple[List[str], dict]]) → None[source]¶: Adds the given argument into the given parser.

PyFunceble.cli.entry_points.pyfunceble.cli.ask_authorization_to_merge_config(missing_key: Optional[str] = None) → bool[source]¶

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

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

PyFunceble.cli.entry_points.pyfunceble.cli.get_ci_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the CI group data.

PyFunceble.cli.entry_points.pyfunceble.cli.get_configured_value(entry: str, *, negate=False) → Any[source]¶

Provides the currently configured value.

Parameters:	entry – An entry to check. multilevel should be separated with a point. negate – Allows us to negate the result from the configuration.
Raises:	ValueError – When the given `entry` is not found.

PyFunceble.cli.entry_points.pyfunceble.cli.get_database_control_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the arguments of the database group.

PyFunceble.cli.entry_points.pyfunceble.cli.get_default_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the default group.

PyFunceble.cli.entry_points.pyfunceble.cli.get_dns_control_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the DNS control group.

PyFunceble.cli.entry_points.pyfunceble.cli.get_filtering_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the filtering group.

PyFunceble.cli.entry_points.pyfunceble.cli.get_multiprocessing_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the multiprocessing group data.

PyFunceble.cli.entry_points.pyfunceble.cli.get_output_control_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the output group.

PyFunceble.cli.entry_points.pyfunceble.cli.get_proxy_control_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the proxy control group.

PyFunceble.cli.entry_points.pyfunceble.cli.get_source_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the arguments of the source group.

PyFunceble.cli.entry_points.pyfunceble.cli.get_test_control_group_data() → List[Tuple[List[str], dict]][source]¶: Provides the argument of the test control data group.

PyFunceble.cli.entry_points.pyfunceble.cli.tool() → None[source]¶: Provides the CLI of PyFunceble.

Module contents¶

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

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

Provides (a bit more that “usual”) what is needed by 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://pyfunceble.readthedocs.io/en/latest/
Project homepage:: https://pyfunceble.github.io/

License:

Copyright 2017, 2018, 2019, 2020, 2022, 2023 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

    http://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.