iwp3tb 0.0.1

Ish West Python 3 Toolbox

Ish West Python 3 Toolbox

A collection of random handy tools.

Table of Contents

• Module iwp3tb.ancestors
  • Example
  • Class Ancestors
    • Parameters
• Module iwp3tb.multiton
  • Concept
  • Examples
    • Basic Multiton
    • Custom Multiton
    • Singleton
  • Function implementation
  • Function implementation_named
  • Function multiton
  • Function singleton
  • Class MultitonError
    • Ancestors
    • Descendants
  • Class NoRegistrarParent
    • Ancestors
  • Class AlreadyHasRegistrarParent
    • Ancestors
  • Class RegistrarAlreadyHasAttribute
    • Ancestors
• Tools
  • Docs generator
    • Pdoc Virtual Environment
    • Pdoc Templates
  • Unit Tests

Module iwp3tb.ancestors

A handy iterator through a class' custom ancestors.

Example

from iwp3tb import Ancestors

from andere.plek import Oma

class Gran():
    pass

class Dad(Gran):
    pass

class Mom(Oma):
    pass

class Son(Dad, Mom):
    pass

for cls in Ancestors(Son):
    print(cls.__name__)

# prints out:
# Son
# Dad
# Gran
# Mom
# Oma

Class Ancestors

Ancestors(a_class: type, a_include_self: bool = True)

An iterator for non-builtin ancestors of a class

Goes recursively through all custom (i.e. not builtin) classes that the base class inherits from. The base class itself comes first in the iteration otherwise the order is unpredictable. Pass False as a second argument to the constructor to avoid including the base class in the iteration.

Parameters

a_class type

The base class, who's ancestors we want to iterate through

a_include_self bool, optional

If True the base class itself is included in the iteration, otherwise immedeatly proceeds to base class' ancestors. Defaults to True

Module iwp3tb.multiton

A set of handy decorators for my beloved Singleton and Multiton design patterns.

Concept

A multiton here is an abstract class, that has a finite number of implementations. Each implementation is instantiated just once and this instance is made available as an attribute of the parent multiton class.

A singleton is basically a multiton that has only one implementation. Thus no need to separate the abstract class from private implementation.

This approach allows for very private implementations while only the common interface becomes public.

Examples

Basic Multiton

from iwp3tb import multiton, implementation

@multiton
class PowerRaiser():
    def raise_to_power(self, x: float) -> float:
        # This is an abstract method.
        # Implementations should realise it.
        raise Exception('You should have implemented this!')

@implementation
class Second(PowerRaiser):
    def raise_to_power(self, x):
        return x * x

@implementation
class Third(PowerRaiser):
    def raise_to_power(self, x):
        return x * x * x

print(PowerRaiser.Second.raise_to_power(3))
# prints out:
# 9

print(PowerRaiser.Third.raise_to_power(3))
# prints out:
# 27

Custom Multiton

Arbitrary instance names can be used.

from iwp3tb import multiton, implementation_named

@multiton
class PowerRaiser():
    def raise_to_power(self, x: float) -> float:
        # This is an abstract method.
        # Implementations should realise it.
        raise Exception('You should have implemented this!')

@implementation_named('power2')
class Second(PowerRaiser):
    def raise_to_power(self, x):
        return x * x

@implementation_named('power3')
class Third(PowerRaiser):
    def raise_to_power(self, x):
        return x * x * x

print(PowerRaiser.power2.raise_to_power(3))
# prints out:
# 9

print(PowerRaiser.power3.raise_to_power(3))
# prints out:
# 27

Singleton

from iwp3tb import singleton

@singleton
class Squarer():
    def to_square(self, x: float) -> float:
        return x * x

print(Squarer.instance.to_square(3))
# prints out:
# 9

Function implementation

implementation(cls)

Class decorator that registers an implementation with a multiton ancestor class. Class name is used for the implementation instance name. The class name must not conflict with any of the multition attributes.

Function implementation_named

implementation_named(a_name)

Class decorator that registers an implementation with a multiton ancestor class using a custom instance name. The class name must not conflict with any of the multition attributes.

Function multiton

multiton(cls)

Class decorator for multiton. A multiton class should have no multition or singleton ancestors.

Function singleton

singleton(cls)

Class decorator for singleton. A singleton class should have no multition or singleton ancestors.

Class MultitonError

MultitonError(a_string)

Common base class for multiton fatal errors.

Ancestors

• builtins.Exception
• builtins.BaseException

Descendants

• iwp3tb.multiton.AlreadyHasRegistrarParent
• iwp3tb.multiton.NoRegistrarParent
• iwp3tb.multiton.RegistrarAlreadyHasAttribute

Class NoRegistrarParent

NoRegistrarParent(a_class)

An error raised if a class is decorated as an implementation but it has no multiton parent.

from iwp3tb import implementation

@implementation
class BadImplementation():
    pass
# Raises NoRegistrarParent

Ancestors

• iwp3tb.multiton.MultitonError
• builtins.Exception
• builtins.BaseException

Class AlreadyHasRegistrarParent

AlreadyHasRegistrarParent(a_class, a_registrar)

An error raised if a class is decorated as an multiton but it already has a multiton parent.

from iwp3tb import multiton

@multiton
class GoodMultiton():
    pass

@multiton
class BadMultiton(GoodMultiton):
    pass
# Raises AlreadyHasRegistrarParent

Ancestors

• iwp3tb.multiton.MultitonError
• builtins.Exception
• builtins.BaseException

Class RegistrarAlreadyHasAttribute

RegistrarAlreadyHasAttribute(a_class, a_registrar, a_name)

An error raised if a naming conflict happens while registering an implementation with a multiton.

from iwp3tb import multiton, implementation, implementation_named

@multiton
class GoodMultiton():
    pass

@implementation
class GoodImplementation(GoodMultiton):
    pass

@implementation_named('GoodImplementation')
class BadImplementation(GoodMultiton):
    pass
# Raises RegistrarAlreadyHasAttribute

Ancestors

• iwp3tb.multiton.MultitonError
• builtins.Exception
• builtins.BaseException

Tools

Docs generator

gendocs.sh

Generates html documentation from source files using pdoc and saves it to docs/ dir. Also calls cook_combined_md.py to generate MarkDown version of the documentation and then inserts it into README.md (this file).

Pdoc Virtual Environment

If you point the PDOC_PYENV environment variable to a Python venv with pdoc installed in it then all documentation generation will take place in this virtual environment.

Pdoc Templates

Templates from pdoc_templates/ are used to generate documentation. Alternatively you can set PDOC_TEMPLATES environment variable to point to an alternative templates dir.

Unit Tests

runtests.sh

Runs unit tests.