finesse.freeze.canFreeze

finesse.freeze.canFreeze(cls)[source]

A function to be used as a decorator for classes which should have the ability to be frozen and unfrozen.

Parameters
clsobject

Class to make freezable, should never be called directly as this function is to be used as a decorator.

Returns
clsobject

The class with frozen attributes set.

Examples

To make a custom object in Finesse frozen simply use this function as a decorator to the class definition:

from finesse.freeze import canFreeze

@canFreeze
class FinesseObject:
    ...