Skip to main content

Factory+Registry pattern for Python classes.

Project description

https://travis-ci.org/eflglobal/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 RTD!

Requirements

ClassRegistry is compatible with Python versions 3.6, 3.5 and 2.7.

Installation

Install the latest stable version via pip:

pip install class-registry

Project details


Download files

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

Source Distribution

class-registry-2.1.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

class_registry-2.1.0-py2.py3-none-any.whl (12.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file class-registry-2.1.0.tar.gz.

File metadata

File hashes

Hashes for class-registry-2.1.0.tar.gz
Algorithm Hash digest
SHA256 97a116a6e448e183d14d6fe82b5797b824dff9d10fdf3adf16936286f737597a
MD5 aab361d6b4cab68d4f091049a790bddb
BLAKE2b-256 eb8e2e378e2c268afddf00ce8c1f1af7cfc490101554c925ba851d81ec7fb49b

See more details on using hashes here.

File details

Details for the file class_registry-2.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for class_registry-2.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 12d28642d89bc4f823369b36ad337988e9a423230e8bb3b6e43e50c5f5c0a031
MD5 48faf950d1f0e9a59722ddb686d7941b
BLAKE2b-256 597afaeae485777a0673cb878416bb14ae6fc00fb1462cbfac5f0eb057b66946

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page