Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

[hide private]

GetAllParams(cls)
Compute list of all parameters for an opcode.

source code

Inherited from outils.ValidatedSlots: GetAllSlots

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, **kwargs)
(Constructor)

source code

Constructor for BaseOpCode.

The constructor takes only keyword arguments and will set attributes on this object based on the passed arguments. As such, it means that you should not pass arguments which are not in the __slots__ attribute for this class.

Overrides: object.__init__: (inherited documentation)

getstate(self)

source code

Generic serializer.

This method just returns the contents of the instance as a dictionary.

Returns: dict: the instance attributes and their values

setstate(self, state)

source code

Generic unserializer.

This method just restores from the serialized state the attributes of the current instance.

Parameters:

state (dict) - the serialized opcode data

Validate(self, set_defaults)

source code

Validate opcode parameters, optionally setting default values.

Parameters:

set_defaults (bool) - whether to set default values

Returns: NoneType

None, if the validation succeeds

Raises:

errors.OpPrereqError - when a parameter value doesn't match requirements

Overrides: outils.ValidatedSlots.Validate

Class BaseOpCode

__init__(self, **kwargs) (Constructor)

__getstate__(self)

__setstate__(self, state)

Validate(self, set_defaults)

init(self, **kwargs)
(Constructor)

getstate(self)

setstate(self, state)