Documentation: https://autoregistry.readthedocs.io
Source Code: https://github.com/BrianPugh/autoregistry
AutoRegistry
Invoking functions and class-constructors from a string is a common design pattern that AutoRegistry aims to solve. For example, a user might specify a backend of type "sqlite" in a yaml configuration file, for which our program needs to construct the SQLite subclass of our Database class. Classically, you would need to manually create a lookup, mapping the string "sqlite" to the SQLite constructor. With AutoRegistry, the lookup is automatically created for you.
AutoRegistry has a single powerful class Registry that can do the following:
Be inherited to automatically register subclasses by their name.
Be directly invoked my_registry = Registry() to create a decorator for registering callables like functions.
Traverse and automatically create registries for other python libraries.
AutoRegistry is also highly configurable, with features like name-schema-enforcement and name-conversion-rules. Checkout the docs for more information.
Installation
AutoRegistry requires Python >=3.8.
python -m pip install autoregistry
Examples
Class Inheritance
Registry adds a dictionary-like interface to class constructors for looking up subclasses.
from abc import abstractmethod
from dataclasses import dataclass
from autoregistry import Registry
@dataclass
class Pokemon(Registry):
level: int
hp: int
@abstractmethod
def attack(self, target):
"""Attack another Pokemon."""
class Charmander(Pokemon):
def attack(self, target):
return 1
class Pikachu(Pokemon):
def attack(self, target):
return 2
class SurfingPikachu(Pikachu):
def attack(self, target):
return 3
print(f"{len(Pokemon)} Pokemon types registered:")
print(f" {list(Pokemon)}")
# By default, lookup is case-insensitive
charmander = Pokemon["cHaRmAnDer"](level=7, hp=31)
print(f"Created Pokemon: {charmander}")
This code block produces the following output:
3 Pokemon types registered:
['charmander', 'pikachu', 'surfingpikachu']
Created Pokemon: Charmander(level=7, hp=31)
Function Registry
Directly instantiating a Registry object allows you to register functions by decorating them.
from autoregistry import Registry
pokeballs = Registry()
@pokeballs
def masterball(target):
return 1.0
@pokeballs
def pokeball(target):
return 0.1
for ball in ["pokeball", "masterball"]:
success_rate = pokeballs[ball](None)
print(f"Ash used {ball} and had {success_rate=}")
This code block produces the following output:
Ash used pokeball and had success_rate=0.1
Ash used masterball and had success_rate=1.0
Module Registry
Create a registry for another python module.
import torch
from autoregistry import Registry
optims = Registry(torch.optim)
# "adamw" and ``lr`` could be coming from a configuration file.
optimizer = optims["adamw"](model.parameters(), lr=3e-3)
assert list(optims) == [
"asgd",
"adadelta",
"adagrad",
"adam",
"adamw",
"adamax",
"lbfgs",
"nadam",
"optimizer",
"radam",
"rmsprop",
"rprop",
"sgd",
"sparseadam",
"lr_scheduler",
"swa_utils",
]
Project Status
This library is feature-complete and accomplishes pretty much everything it was designed to do. So while releases will be more rare/sparse, do not interpret that as this being a “dead” project!
Metadata
Release files for autoregistry 1.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| autoregistry-1.3.1.tar.gz | 19.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autoregistry-1.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 38.2 kB
Release files / autoregistry-1.3.1.tar.gz
| Download URL | autoregistry-1.3.1.tar.gz |
|---|---|
| Size | 19.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3110c5054fd6fb1f972c7adbfc9df8cfa49ab3ce6c90c0d465625db310a3cb6d
|
|
BLAKE2b-256 checksum How to use checksums |
b2a73a3abcbe79f1e835436bb72fb3c64d1f9705887cfaafb637cbb9c328bfea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 8, 2026.
Transparency logRelease files / autoregistry-1.3.1-py3-none-any.whl
| Download URL | autoregistry-1.3.1-py3-none-any.whl |
|---|---|
| Size | 19.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8ac1859a140be6a092c1d3be592b6f15c40e9ecdec17932fea4a25f1427fd681
|
|
BLAKE2b-256 checksum How to use checksums |
b2f4a3b2ac9c69be875560435fc5d7b9bab427cc239585511b9f55e16ddca82e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 8, 2026.
Transparency log