touketsu.core.immutable

@touketsu.core.immutable

Makes a class immutable and modifies the class docstring.

Equivalent to class_decorator_factory() with dectype = "immutable" and docmod = "brief". The standard decorator to use for making a class immutable.

Note

Do not apply to a previously decorated class. Instead, use urt_class() first to return the class to its original state before applying immutable().

Parameters

cls (type) – The class to decorate.

Returns

A decorated version of the original class with immutable instances.

Return type

type