cookiecutter_python package

Subpackages

• cookiecutter_python.backend package
  • Subpackages
    • cookiecutter_python.backend.error_handling package
      • Submodules
      • cookiecutter_python.backend.error_handling.handler_builder module
      • Module contents
    • cookiecutter_python.backend.generator package
      • Submodules
      • cookiecutter_python.backend.generator.generator module
      • Module contents
    • cookiecutter_python.backend.hosting_services package
      • Submodules
      • cookiecutter_python.backend.hosting_services.check_engine module
      • cookiecutter_python.backend.hosting_services.check_service module
      • cookiecutter_python.backend.hosting_services.check_web_hosting_service module
      • cookiecutter_python.backend.hosting_services.checker module
      • cookiecutter_python.backend.hosting_services.checkers module
      • cookiecutter_python.backend.hosting_services.exceptions module
      • cookiecutter_python.backend.hosting_services.extract_name module
      • cookiecutter_python.backend.hosting_services.handle_hosting_service_check module
      • cookiecutter_python.backend.hosting_services.handler module
      • cookiecutter_python.backend.hosting_services.value_extractor module
      • cookiecutter_python.backend.hosting_services.web_hosting_service module
      • Module contents
    • cookiecutter_python.backend.sanitization package
      • Subpackages
      • Submodules
      • cookiecutter_python.backend.sanitization.input_sanitization module
      • cookiecutter_python.backend.sanitization.interpreters_support module
      • Module contents
  • Submodules
  • cookiecutter_python.backend.check_server_result module
    • CheckWebServerResult
      • CheckWebServerResult.future
      • CheckWebServerResult.name
      • CheckWebServerResult.service_name
  • cookiecutter_python.backend.gen_docs_common module
    • get_docs_gen_internal_config()
  • cookiecutter_python.backend.helpers module
    • parse_context()
  • cookiecutter_python.backend.load_config module
    • InvalidYamlFormatError
    • UserYamlDesignError
    • get_interpreters_from_yaml()
    • load_yaml()
  • cookiecutter_python.backend.main module
    • generate()
  • cookiecutter_python.backend.post_main module
    • CheckWebServerError
    • post_main()
  • cookiecutter_python.backend.pre_main module
    • pre_main()
  • cookiecutter_python.backend.proxy module
    • BaseProxy
      • BaseProxy.log_info_args()
  • cookiecutter_python.backend.request module
    • Request
      • Request.check
      • Request.check_results
      • Request.config_file
      • Request.default_config
      • Request.extra_context
      • Request.no_input
      • Request.offline
      • Request.web_servers
  • cookiecutter_python.backend.user_config_proxy module
  • Module contents
    • CheckWebServerError
    • generate()
    • get_docs_gen_internal_config()
• cookiecutter_python.handle package
  • Subpackages
    • cookiecutter_python.handle.dialogs package
      • Subpackages
      • Submodules
      • cookiecutter_python.handle.dialogs.dialog module
      • Module contents
  • Submodules
  • cookiecutter_python.handle.interactive_cli_pipeline module
    • InteractiveDialogsPipeline
      • InteractiveDialogsPipeline.dialogs
      • InteractiveDialogsPipeline.process()
  • cookiecutter_python.handle.node_base module
    • DialogNode
      • DialogNode.process()
  • cookiecutter_python.handle.node_factory module
    • NodeFactory
      • NodeFactory.create()
  • cookiecutter_python.handle.node_interface module
    • Node
      • Node.process()
  • Module contents
• cookiecutter_python.hooks package
  • Submodules
  • cookiecutter_python.hooks.post_gen_project module
    • CLI_ONLY()
    • PYTEST_PLUGIN_ONLY()
    • PostFileRemovalError
    • get_context()
    • get_request()
    • git_commit()
    • initialize_git_repo()
    • is_git_repo_clean()
    • iter_files()
    • main()
    • post_file_removal()
    • post_hook()
    • run_process_python36_n_below()
    • run_process_python37_n_above()
    • subprocess_run()
  • cookiecutter_python.hooks.pre_gen_project module
    • InputSanitizationError
    • get_request()
    • hook_main()
    • input_sanitization()
    • main()
  • Module contents

Submodules

cookiecutter_python.cli module

Main cookiecutter_python CLI.

cookiecutter_python.cli.version_msg()

Message about Python Generator version, location and Python version.

cookiecutter_python.cli_handlers module

cookiecutter_python.cli_handlers.handle_error(error)

cookiecutter_python.exceptions module

cookiecutter_python.exceptions.error_2_str(error)

cookiecutter_python.utils module

cookiecutter_python.utils.load(interface: Type[T], module: str | None = None) → List[Type[T]]

Dynamically import all class objects that implement the given interface.

The classes (class objects) are discovered and imported in the namespace, by searching within each module found inside the input ‘dire’ (path) directory.

Each class object is an attribute found in a module’s namespace. We classify an attribute as a (correct) “class to import”, if the following python boolean expression evaluates to True:

isclass(attribute) and issubclass(attribute, interface)

If ‘dire’ is not given then we consider the modules that are inside the same directory as the one where the module of the invoking code resides.

Parameters:

• interface (Type[T]) – the type (ie class) that the imported classes should ‘inherit’ (subclass) from

• module (str) – module containing the modules to inspect. Defaults to the same module (directory) as the one where the module of the invoking code resides.

Module contents