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

Uploaded Source

Built Distribution

class_registry-2.1.2-py2.py3-none-any.whl (12.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for class-registry-2.1.2.tar.gz
Algorithm Hash digest
SHA256 678bdb0322566c07a4d8905140d364bd34a73baf46bf7580fc2e06fa994d4e7e
MD5 6e992ec6201cae721afad6a4416a0586
BLAKE2b-256 77129588e71126438abdf10d3cec4ff4257eedaf6bc9b9637ab001d138d74085

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for class_registry-2.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cfb855514753e2edfe8d88b14a6e449820682fe0983efe61b83df28b688b3e5a
MD5 4f24faef3adafb5572a8ea762ba629f5
BLAKE2b-256 05ca3723cb3a74a23fe77c88f29fe06fed202acc398763d36b6721dc2883bbd4

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