sbmlutils.utils

Utility functions.

Module Contents

Classes

FrozenClass

FrozenClass.

Functions

create_metaid(sbase)	Create a globally unique meta id.
create_hash_id(sbase)	Create hash code.
timeit(f)	Decorate function with timing information.
deprecated(f)	Decorate function as deprecated.

class sbmlutils.utils.FrozenClass

Bases: object

FrozenClass.

After freezing no additional attributes can be added.

__isfrozen :bool = False

__setattr__(key, value)

Attribute setter.

Parameters

• key (str) –

• value (Any) –

Return type

None

_freeze()

Return type

None

sbmlutils.utils.create_metaid(sbase)

Create a globally unique meta id.

Meta ids are required to store annotations on elements.

Parameters

sbase (libsbml.SBase) –

Return type

str

sbmlutils.utils.create_hash_id(sbase)

Create hash code.

Parameters

sbase (libsbml.SBase) –

Return type

str

sbmlutils.utils.timeit(f)

Decorate function with timing information.

Parameters

f (Callable) – function to time

Returns

Return type

Callable

sbmlutils.utils.deprecated(f)

Decorate function as deprecated.

This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used.

Parameters

f (Callable) –

Return type

Callable