objectory = object + factory

Overview

A light Python library for general purpose object factories. In particular, it focuses on dynamic object factory implementations where objects can be registered dynamically without changing the code of the factory. An object factory can be used to instantiate an object from its configuration. The current implementation contains both abstract factory and registry approaches.

factory

from objectory import factory


class MyClass:
    pass


obj = factory("MyClass")
print(obj)

abstract factory

from objectory import AbstractFactory


class BaseClass(metaclass=AbstractFactory):
    pass


class MyClass(BaseClass):
    pass


obj = BaseClass.factory("MyClass")
print(obj)

Output:

<__main__.MyClass object at 0x123456789>

registry

from objectory import Registry

registry = Registry()


@registry.register()
class MyClass:
    pass


obj = registry.factory("MyClass")
print(obj)

<__main__.MyClass object at 0x123456789>

Please read the documentation to learn more about these approaches.

• Documentation
• Installation
• Contributing
• API stability
• License

Installation

We highly recommend installing a virtual environment. objectory can be installed from pip using the following command:

pip install objectory

Please check the get started page to see other alternatives to install the library.

Contributing

Please let us know if you encounter a bug by filing an issue.

We welcome contributions from anyone, even if you are new to open source.

• If you are planning to contribute back bug-fixes, please do so without any further discussion.
• If you plan to contribute new features, utility functions, or extensions to the core, please first open an issue and discuss the feature with us.

Once you implement and test your feature or bug-fix, please submit a Pull Request.

Please feel free to open an issue to share your feedback or to request new features.

API stability

:warning: While objectory is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading objectory to a new version will possibly break any code that was using the old version of objectory.

License

objectory is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.