idmtools.core.interfaces.iitem module

class idmtools.core.interfaces.iitem.IItem(_uid: uuid.UUID = None, _IItem__pre_creation_hooks: List[Callable[[ForwardRef('IItem'), ForwardRef('IPlatform')], NoneType]] = <factory>, _IItem__post_creation_hooks: List[Callable[[ForwardRef('IItem'), ForwardRef('IPlatform')], NoneType]] = <factory>)

Bases: object

property uid

property id

property metadata

property pickle_ignore_fields

property metadata_fields

display()

pre_creation(platform: IPlatform) → None

Called before the actual creation of the entity.

Parameters

platform – Platform item is being created on

Returns:

post_creation(platform: IPlatform) → None

Called after the actual creation of the entity.

Parameters

platform – Platform item was created on

Returns:

add_pre_creation_hook(hook: Callable[[IItem, IPlatform], None])

Adds a hook function to be called before an item is created

Parameters

hook – Hook function. This should have two arguments, the item and the platform

Returns

None

add_post_creation_hook(hook: Callable[[IItem, IPlatform], None])

Adds a hook function to be called after an item is created

Parameters

hook – Hook function. This should have two arguments, the item and the platform

Returns

None

post_setstate()

Function called after restoring the state if additional initialization is required

pre_getstate()

Function called before picking and return default values for “pickle-ignore” fields