Skip to main content

Factory+Registry pattern for Python classes.

Project description

https://travis-ci.org/todofixthis/class-registry.svg?branch=master https://readthedocs.org/projects/class-registry/badge/?version=latest

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:

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:

# 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 compatible with the following Python versions:

  • 3.8
  • 3.7
  • 3.6
  • 3.5

pypy3 is also supported.

Note

ClassRegistry is not compatible with Python 2.

Installation

Install the latest stable version via pip:

pip install phx-class-registry

Running Unit Tests

To run unit tests after installing from source:

python setup.py test

This project is also compatible with tox, which will run the unit tests in different virtual environments (one for each supported version of Python).

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 all

Documentation

Documentation is available on ReadTheDocs.

If you are installing from source (see above), you can also build the documentation locally:

  1. Install extra dependencies (you only have to do this once):

    pip install '.[docs-builder]'
    
  2. Switch to the docs directory:

    cd docs
    
  3. Build the documentation:

    make html
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for phx-class-registry, version 3.0.5
Filename, size File type Python version Upload date Hashes
Filename, size phx_class_registry-3.0.5-py3-none-any.whl (11.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size phx-class-registry-3.0.5.tar.gz (15.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page