1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
.. image:: https://github.com/todofixthis/class-registry/actions/workflows/build.yml/badge.svg
:target: https://github.com/todofixthis/class-registry/actions/workflows/build.yml
.. image:: https://readthedocs.org/projects/class-registry/badge/?version=latest
:target: http://class-registry.readthedocs.io/
ClassRegistry
=============
At the intersection of the Registry and Factory patterns lies the
``ClassRegistry``:
- Define global factories that generate new class instances based on
configurable keys.
- Seamlessly create powerful service registries.
- Integrate with setuptools's ``entry_points`` system to make your registries
infinitely extensible by 3rd-party libraries!
- And more!
Getting Started
---------------
Create a registry using the ``class_registry.ClassRegistry`` class, then
decorate any classes that you wish to register with its ``register`` method:
.. code-block:: python
from class_registry import ClassRegistry
pokedex = ClassRegistry()
@pokedex.register('fire')
class Charizard(Pokemon):
...
@pokedex.register('grass')
class Bulbasaur(Pokemon):
...
@pokedex.register('water')
class Squirtle(Pokemon):
...
To create a class instance from a registry, use the subscript operator:
.. code-block:: python
# Charizard, I choose you!
fighter1 = pokedex['fire']
# CHARIZARD fainted!
# How come my rival always picks the type that my pokémon is weak against??
fighter2 = pokedex['grass']
Advanced Usage
~~~~~~~~~~~~~~
There's a whole lot more you can do with ClassRegistry, including:
- Provide args and kwargs to new class instances.
- Automatically register non-abstract classes.
- Integrate with setuptools's ``entry_points`` system so that 3rd-party
libraries can add their own classes to your registries.
- Wrap your registry in an instance cache to create a service registry.
- And more!
For more advanced usage, check out the documentation on `ReadTheDocs`_!
Requirements
------------
ClassRegistry is known to be compatible with the following Python versions:
- 3.12
- 3.11
- 3.10
.. note::
I'm only one person, so to keep from getting overwhelmed, I'm only committing
to supporting the 3 most recent versions of Python. ClassRegistry's code is
pretty simple, so it's likely to be compatible with versions not listed here;
there just won't be any test coverage to prove it 😇
Installation
------------
Install the latest stable version via pip::
pip install phx-class-registry
.. important::
Make sure to install `phx-class-registry`, **not** `class-registry`. I
created the latter at a previous job years ago, and after I left they never
touched that project again and stopped responding to my emails — so in the
end I had to fork it 🤷
Running Unit Tests
------------------
Install the package with the ``test-runner`` extra to set up the necessary
dependencies, and then you can run the tests with the ``tox`` command::
pip install -e .[test-runner]
tox -p
To run tests in the current virtualenv::
python -m unittest
Documentation
-------------
Documentation is available on `ReadTheDocs`_.
If you are installing from source (see above), you can also build the
documentation locally:
#. Install extra dependencies (you only have to do this once)::
pip install -e '.[docs-builder]'
#. Switch to the ``docs`` directory::
cd docs
#. Build the documentation::
make html
Releases
--------
Steps to build releases are based on `Packaging Python Projects Tutorial`_
.. important::
Make sure to build releases off of the ``main`` branch, and check that all
changes from ``develop`` have been merged before creating the release!
1. Build the Project
~~~~~~~~~~~~~~~~~~~~
#. Install extra dependencies (you only have to do this once)::
pip install -e '.[build-system]'
#. Delete artefacts from previous builds, if applicable::
rm dist/*
#. Run the build::
python -m build
#. The build artefacts will be located in the ``dist`` directory at the top
level of the project.
2. Upload to PyPI
~~~~~~~~~~~~~~~~~
#. `Create a PyPI API token`_ (you only have to do this once).
#. Increment the version number in ``pyproject.toml``.
#. Check that the build artefacts are valid, and fix any errors that it finds::
python -m twine check dist/*
#. Upload build artefacts to PyPI::
python -m twine upload dist/*
3. Create GitHub Release
~~~~~~~~~~~~~~~~~~~~~~~~
#. Create a tag and push to GitHub::
git tag <version>
git push
``<version>`` must match the updated version number in ``pyproject.toml``.
#. Go to the `Releases page for the repo`_.
#. Click ``Draft a new release``.
#. Select the tag that you created in step 1.
#. Specify the title of the release (e.g., ``ClassRegistry v1.2.3``).
#. Write a description for the release. Make sure to include:
- Credit for code contributed by community members.
- Significant functionality that was added/changed/removed.
- Any backwards-incompatible changes and/or migration instructions.
- SHA256 hashes of the build artefacts.
#. GPG-sign the description for the release (ASCII-armoured).
#. Attach the build artefacts to the release.
#. Click ``Publish release``.
.. _Create a PyPI API token: https://pypi.org/manage/account/token/
.. _Packaging Python Projects Tutorial: https://packaging.python.org/en/latest/tutorials/packaging-projects/
.. _ReadTheDocs: https://class-registry.readthedocs.io/
.. _Releases page for the repo: https://github.com/todofixthis/class-registry/releases
.. _tox: https://tox.readthedocs.io/
|
