Skip to main content

Factory+Registry pattern for Python classes.

Project description

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.0.0.tar.gz (14.3 kB view details)

Uploaded Source

Built Distributions

class_registry-2.0.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

class_registry-2.0.0-py2-none-any.whl (12.1 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for class-registry-2.0.0.tar.gz
Algorithm Hash digest
SHA256 9a947976c19cbd2c87e63df61f76c59ab0dcb851ac4deb9b50709941a42d698c
MD5 f3a6d7d80e4d507916f57785e4cfb2c2
BLAKE2b-256 326faca81a73c639395bec4be2386132cdcd821b3a6474ce5a448a866f4a3f4c

See more details on using hashes here.

File details

Details for the file class_registry-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for class_registry-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1476f2b80a01eff9aef3270f0459282ed720e0985ed51b51ec36fa8e7bed77e6
MD5 6d61e162586b62229f35a46a78d75607
BLAKE2b-256 0c99329b5e7706f18b99b692d8d431676c459f6aca56029c7230e2adcb97d780

See more details on using hashes here.

File details

Details for the file class_registry-2.0.0-py2-none-any.whl.

File metadata

File hashes

Hashes for class_registry-2.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 71e8a5b8ba47bc3b9f4cc03ff9adef3ef1cce43223a10b92ee8ce427dcde711f
MD5 422291fe168d27fa4fec54b2f9f09466
BLAKE2b-256 b580eee87536ee038b7fe7ffd031ee92b55889997555a96f15d807bf4188d451

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