cookiecutter_python.backend.sanitization package

Subpackages

• cookiecutter_python.backend.sanitization.string_sanitizers package
  • Submodules
  • cookiecutter_python.backend.sanitization.string_sanitizers.base_sanitizer module
    • AbstractSanitizer
      • AbstractSanitizer.exception_msg
      • AbstractSanitizer.log_message()
      • AbstractSanitizer.verify
    • BaseSanitizer
      • BaseSanitizer.exception_msg
      • BaseSanitizer.log_message()
      • BaseSanitizer.verify
    • SanitizerInterface
  • cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_input module
    • BaseSanitizer
      • BaseSanitizer.exception_msg
      • BaseSanitizer.log_message()
      • BaseSanitizer.verify
    • InputValueError
  • cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_module_name module
    • ModuleNameSanitizer
      • ModuleNameSanitizer.exception_msg
      • ModuleNameSanitizer.log_message()
      • ModuleNameSanitizer.regex
    • sanitize_module_name()
  • cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_version module
    • VersionSanitizer
      • VersionSanitizer.exception_msg
      • VersionSanitizer.log_message()
      • VersionSanitizer.regex
    • sanitize_version()
  • Module contents

Submodules

cookiecutter_python.backend.sanitization.input_sanitization module

class cookiecutter_python.backend.sanitization.input_sanitization.Sanitize

Bases: object

property exceptions: Mapping[str, Type[Exception] | Tuple]

exceptions_map: Dict[str, List[Type[Exception]]] = {'interpreters': [<class 'cookiecutter_python.backend.sanitization.interpreters_support.InvalidInterpretersError'>], 'module-name': [<class 'cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_input.InputValueError'>], 'semantic-version': [<class 'cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_input.InputValueError'>]}

classmethod register_exception(sanitizer_identifier: str)

Add an Exception to the sanitizers’ expected exceptions registry.

Parameters:

sanitizer_identifier (str) – [description]

classmethod register_sanitizer(sanitizer_identifier: str)

Add a callback to the sanitizers’ registry.

Parameters:

sanitizer_identifier (str) – [description]

sanitizers_map: Dict[str, Callable[[Any], None]] = {'interpreters': <function verify_input_interpreters>, 'module-name': <function sanitize_module_name>, 'semantic-version': <function sanitize_version>}

cookiecutter_python.backend.sanitization.interpreters_support module

exception cookiecutter_python.backend.sanitization.interpreters_support.InvalidInterpretersError

Bases: Exception

cookiecutter_python.backend.sanitization.interpreters_support.unsupported_interpreters(interpreters: Sequence[str]) → Iterator[str]

cookiecutter_python.backend.sanitization.interpreters_support.verify_input_interpreters(interpreters: Sequence[str]) → None

Module contents