README.md

objectory = object + factory

Overview

A 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
>>> obj = factory("builtins.list")
>>> print(obj)
[]

abstract factory

>>> from objectory import AbstractFactory
>>> class BaseClass(metaclass=AbstractFactory):
...     pass
...
>>> class MyClass(BaseClass):
...     pass
...
>>> obj = BaseClass.factory("MyClass")
>>> print(obj)
<__main__.MyClass object at 0x...>

registry

>>> from objectory import Registry
>>> registry = Registry()
>>> @registry.register()
... class MyClass:
...     pass
...
>>> obj = registry.factory("MyClass")
>>> print(obj)
<__main__.MyClass object at 0x...>

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

It is highly recommended to use the last stable version available. Please check the get started page to see other alternatives to install the library. The following is the corresponding objectory versions and supported dependencies.

objectory	tornado	python
main	>=6.0,<7.0	>=3.9,<3.14
0.2.0	>=6.0,<7.0	>=3.9,<3.14
0.1.2	>=6.0,<7.0	>=3.9,<3.13
0.1.1	>=6.0,<7.0	>=3.9,<3.13
0.1.0	>=6.0,<7.0	>=3.9,<3.13
0.0.9	>=6.0,<7.0	>=3.9,<3.13
0.0.8	>=6.0,<7.0	>=3.9,<3.13
0.0.7	>=6.0,<7.0	>=3.9,<3.12

Contributing

Please check the instructions in CONTRIBUTING.md.

API stability

⚠️ 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.