API Reference

Complete API documentation for all modules, classes, and functions in mixinforge.

Core Components

Mixins and Metaclasses

The library provides several mixins and metaclasses for common design patterns:

• ParameterizableMixin - Parameter management and JSON serialization

• ImmutableParameterizableMixin - Immutable objects with params-based identity

• CacheablePropertiesMixin - Automatic cached property management

• NotPicklableMixin - Prevent object pickling

• SingleThreadEnforcerMixin - Thread safety enforcement

• SingletonMixin - Singleton pattern implementation

• GuardedInitMeta - Initialization lifecycle control

Utility Functions

Helper functions for common operations:

• JSON processing - dumpjs, loadjs, update_jsparams, access_jsparams

• Dictionary utilities - sort_dict_by_keys

• Collection processing - nested structure handling

Command Line Tools

Project analysis and maintenance utilities:

• mf-get-stats - Generate project metrics

• mf-clear-cache - Remove Python cache files

Full Module Documentation

• mixinforge package
  • CacheablePropertiesMixin
  • GuardedInitMeta
    • GuardedInitMeta.__init__()
  • ImmutableMixin
    • ImmutableMixin.__init__()
    • ImmutableMixin.get_identity_key()
    • ImmutableMixin.identity_key
  • ImmutableParameterizableMixin
    • ImmutableParameterizableMixin.get_identity_key()
    • ImmutableParameterizableMixin.essential_jsparams
  • NotPicklableMixin
  • OutputCapturer
    • OutputCapturer.__init__()
    • OutputCapturer.get_output()
  • OutputSuppressor
  • ParameterizableMixin
    • ParameterizableMixin.get_params()
    • ParameterizableMixin.clone()
    • ParameterizableMixin.get_jsparams()
    • ParameterizableMixin.get_default_params()
    • ParameterizableMixin.get_default_jsparams()
    • ParameterizableMixin.essential_param_names
    • ParameterizableMixin.auxiliary_param_names
    • ParameterizableMixin.get_essential_params()
    • ParameterizableMixin.get_essential_jsparams()
    • ParameterizableMixin.get_auxiliary_params()
    • ParameterizableMixin.get_auxiliary_jsparams()
  • SingleThreadEnforcerMixin
    • SingleThreadEnforcerMixin.__init__()
  • SingletonMixin
    • SingletonMixin._instances
    • SingletonMixin._counters
  • access_jsparams()
  • dumpjs()
  • flatten_nested_collection()
  • find_instances_inside_composite_object()
  • install_package()
  • is_package_installed()
  • is_valid_env_name()
  • transform_instances_inside_composite_object()
  • is_executed_in_notebook()
  • loadjs()
  • reset_notebook_detection()
  • sort_dict_by_keys()
  • uninstall_package()
  • update_jsparams()