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

Uploaded Source

Built Distributions

class_registry-2.0.2-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

class_registry-2.0.2-py2-none-any.whl (12.4 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for class-registry-2.0.2.tar.gz
Algorithm Hash digest
SHA256 0e5c18194a74d9762801061da3f9debed15fe05b638d6d42f65f9641a613e332
MD5 e5752724c573f597d6b2ec4ad8d71827
BLAKE2b-256 ca7e04794a859e0da5cd4a394f6ec4492d1446dc36222c6ea8c18b739387c499

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for class_registry-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2798549ef1a957ccfc487be6f4fdb738aa84a4db962962ad12343058ede7ddc4
MD5 ee7344b75e2d6aaad9fb111a89d192bd
BLAKE2b-256 bdcfa7be9ab0f7042852d29c4bfb90a14f56f88addad2489e23c8a57936da878

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for class_registry-2.0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 567ab5048995bbfbbf8e862596cc7e25799617978a6a8a685e796921d637e4c9
MD5 0ccee29676851a2762f66642fa949d12
BLAKE2b-256 ef5423021e66d68856b28e51193d7a559c2c6615280a92c9d2da73a109181f03

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