magic_utils documentation

• magic_utils
  • magic_utils package
    • Subpackages
      • magic_utils.exceptions package
        • Submodules
        • magic_utils.exceptions.registryExceptions module
          • DuplicateKeyError
          • MissingKeyError
          • RegistryError
        • Module contents
      • magic_utils.magicLogger package
        • Submodules
        • magic_utils.magicLogger.loggingFormatter module
          • ColoredFormatter
            • ColoredFormatter.format()
          • JsonFormatter
            • JsonFormatter.format()
        • magic_utils.magicLogger.loggingManager module
          • setup_logger()
        • Module contents
      • magic_utils.registries package
        • Submodules
        • magic_utils.registries.aliasRegistry module
          • AliasRegistry
            • AliasRegistry.add_alias()
            • AliasRegistry.aliases
            • AliasRegistry.canonicals
            • AliasRegistry.get()
            • AliasRegistry.register()
            • AliasRegistry.register_class()
            • AliasRegistry.register_function()
            • AliasRegistry.remove()
            • AliasRegistry.remove_alias()
            • AliasRegistry.reset()
            • AliasRegistry.resolve_key_to_canonical()
            • AliasRegistry.resolve_value_to_canonicals()
            • AliasRegistry.update()
        • magic_utils.registries.registry module
          • Registry
            • Registry.get()
            • Registry.register()
            • Registry.register_class()
            • Registry.register_function()
            • Registry.registry
            • Registry.remove()
            • Registry.reset()
            • Registry.update()
        • Module contents
      • magic_utils.tunnel package
        • Submodules
        • magic_utils.tunnel.tunnelmole module
          • TunnelMole
            • TunnelMole.is_running()
            • TunnelMole.start()
            • TunnelMole.stop()
        • Module contents
    • Submodules
    • magic_utils.eventManager module
      • EventManager
        • EventManager.clear()
        • EventManager.notify_all()
        • EventManager.notify_parallel()
        • EventManager.subscribe()
        • EventManager.unsubscribe()
    • Module contents
      • AliasRegistry
        • AliasRegistry.add_alias()
        • AliasRegistry.aliases
        • AliasRegistry.canonicals
        • AliasRegistry.get()
        • AliasRegistry.register()
        • AliasRegistry.register_class()
        • AliasRegistry.register_function()
        • AliasRegistry.remove()
        • AliasRegistry.remove_alias()
        • AliasRegistry.reset()
        • AliasRegistry.resolve_key_to_canonical()
        • AliasRegistry.resolve_value_to_canonicals()
        • AliasRegistry.update()
      • EventManager
        • EventManager.clear()
        • EventManager.notify_all()
        • EventManager.notify_parallel()
        • EventManager.subscribe()
        • EventManager.unsubscribe()
      • Registry
        • Registry.get()
        • Registry.register()
        • Registry.register_class()
        • Registry.register_function()
        • Registry.registry
        • Registry.remove()
        • Registry.reset()
        • Registry.update()
      • TunnelMole
        • TunnelMole.is_running()
        • TunnelMole.start()
        • TunnelMole.stop()
      • setup_logger()
  • setup module
  • tests package
    • Subpackages
      • tests.test_magicLogger package
        • Submodules
        • tests.test_magicLogger.conftest module
          • log_file_path()
        • tests.test_magicLogger.test_configuration_basic module
          • test_custom_file_formatter()
          • test_custom_stream_formatter()
          • test_file_formatter_is_none()
          • test_setup_logger_clears_previous_handlers()
          • test_setup_logger_creates_logger_with_name()
          • test_setup_logger_raises_for_conflicting_file_formatter()
          • test_setup_logger_raises_for_conflicting_stream_formatter()
          • test_setup_logger_sets_handler_levels()
          • test_setup_logger_uses_custom_timed_rotating_kwargs()
          • test_stream_formatter_is_none()
        • tests.test_magicLogger.test_formatters module
          • test_colored_formatter_outputs_ansi_and_formatted_fields()
          • test_formatters_include_extra_args()
          • test_json_formatter_outputs_valid_json_and_keys()
        • tests.test_magicLogger.test_integration_logging_io module
          • test_logging_to_file()
        • Module contents
      • tests.test_registries package
        • Subpackages
          • tests.test_registries.test_aliasRegistry package
            • Submodules
            • tests.test_registries.test_aliasRegistry.conftest module
              • alias_registry()
            • tests.test_registries.test_aliasRegistry.constants module
            • tests.test_registries.test_aliasRegistry.test_alias_crud_operations module
              • test_contains_with_alias()
              • test_contains_with_canonical()
              • test_remove_by_alias_removes_all()
              • test_remove_by_canonical_removes_aliases()
              • test_remove_by_value_with_aliases()
              • test_reset_clears_aliases()
              • test_setitem_registers_new_key()
              • test_setitem_updates_existing_key()
              • test_setitem_via_alias_updates_value()
              • test_update_by_alias()
              • test_update_by_canonical_key()
              • test_update_nonexistent_key()
            • tests.test_registries.test_aliasRegistry.test_alias_decorators module
              • test_register_class_default_key_with_aliases()
              • test_register_class_duplicate_alias()
              • test_register_class_with_aliases()
              • test_register_function_default_key_with_aliases()
              • test_register_function_duplicate_alias()
              • test_register_function_no_key_or_aliases()
              • test_register_function_with_aliases()
            • tests.test_registries.test_aliasRegistry.test_alias_dunder module
              • test_alias_registry_eq_different_data()
              • test_alias_registry_eq_type_check()
              • test_alias_registry_eq_with_base_registry()
              • test_alias_registry_len()
              • test_alias_registry_repr()
              • test_alias_registry_repr_multiple()
              • test_alias_registry_repr_no_aliases()
            • tests.test_registries.test_aliasRegistry.test_alias_exceptions module
              • test_alias_registry_eq_different_data()
              • test_alias_registry_eq_type_check()
              • test_alias_registry_eq_with_base_registry()
              • test_alias_registry_eq_with_same_aliases_but_different_name()
              • test_alias_registry_eq_with_same_aliases_same_name()
              • test_alias_registry_len()
              • test_alias_registry_repr()
              • test_alias_registry_repr_multiple()
              • test_alias_registry_repr_no_aliases()
            • tests.test_registries.test_aliasRegistry.test_alias_management module
              • test_add_alias_that_exists_as_canonical()
              • test_add_alias_to_canonical()
              • test_add_alias_to_existing_alias()
              • test_add_alias_to_nonexistent_key()
              • test_add_duplicate_alias()
              • test_remove_alias()
              • test_remove_alias_from_nonexistent_key()
              • test_remove_alias_using_alias_as_key()
              • test_remove_nonexistent_alias()
            • tests.test_registries.test_aliasRegistry.test_alias_registration module
              • test_alias_registry_duplicate_alias()
              • test_alias_registry_duplicate_alias_in_list()
              • test_alias_registry_duplicate_as_alias()
              • test_alias_registry_duplicate_canonical_key()
              • test_alias_registry_duplicate_in_aliases()
              • test_alias_registry_register_empty_aliases()
              • test_alias_registry_register_with_aliases()
              • test_alias_registry_register_without_aliases()
            • tests.test_registries.test_aliasRegistry.test_alias_retrieval module
              • test_aliases_property()
              • test_canonicals_property()
              • test_get_by_alias()
              • test_get_by_canonical_key()
              • test_getitem_by_alias()
              • test_getitem_by_canonical()
              • test_resolve_key_to_canonical()
              • test_resolve_nonexistent_key()
            • Module contents
          • tests.test_registries.test_registry package
            • Submodules
            • tests.test_registries.test_registry.conftest module
              • registry()
            • tests.test_registries.test_registry.constants module
            • tests.test_registries.test_registry.helper module
              • set_register_registry()
            • tests.test_registries.test_registry.test_crud module
              • test_registry_get()
              • test_registry_register()
              • test_registry_register_class()
              • test_registry_register_function()
              • test_registry_remove()
              • test_registry_update()
            • tests.test_registries.test_registry.test_dunder module
              • registry()
              • test_registry_contains()
              • test_registry_eq()
              • test_registry_len()
              • test_registry_repr()
            • tests.test_registries.test_registry.test_exceptions module
              • test_duplicate_key_error_str()
              • test_registry_duplicate_key_exception()
              • test_registry_missing_key_exception()
              • test_rmv_with_mutliple_same_values()
            • tests.test_registries.test_registry.test_logging module
              • registry()
              • reset_registry()
              • test_registry_logging_get()
              • test_registry_logging_register()
              • test_registry_logging_remove()
              • test_registry_logging_update()
            • tests.test_registries.test_registry.test_other module
              • registry()
              • test_registry_reset()
              • test_registry_singleton()
            • Module contents
        • Module contents
      • tests.test_tunnel package
        • Submodules
        • tests.test_tunnel.test_tunnelMole module
          • mock_popen()
          • test_context_manager()
          • test_tunnel_exceptions()
          • test_tunnel_start_and_stop()
        • Module contents
    • Submodules
    • tests.test_eventManager module
      • subscriber_function_test_1()
      • subscriber_function_test_2()
      • test_clear()
      • test_eq()
      • test_notify_all()
      • test_notify_parallel()
      • test_notify_parallel_invalid_num_threads()
      • test_notify_parallel_subscribers_exceeding_threads()
      • test_subscribe()
      • test_unsubscribe()
    • Module contents