This topic discusses the Systems feature provided by the PLANTA link API.

Classes

System

Methods

FunctionParametersReturn ValueDescription
System.__eq__(self, other)other: Another System instanceTrue or FalseCheck whether a system is equal to another
System.__hash__(self)
IntegerReturns a hash based on UUID
System.__init__(self, system_id)system_id: UUIDInstanceInitialize a new System instance.
System.create_conditional(self, classname, parameter, expected_value)classname: Check class
parameter: Expected value
expected_value: Expected
UUIDCreates a new system conditional and saves it to the database. If the system could not be created, a ValueError is raised
System.delete(self)

Delete this system

Classmethods

FunctionParametersReturn ValueDescription
System.create(cls, creation_parameters)creation_parameters: Any python id from table 568 that should have a custom valueAn instance of the newly created system. The class is based on the class that create() is called from.Create a new system record. If the system could not be created a ValueError is raised.
System.get_active_system(cls)
System or NoneGet the currently active System instance
System.get_active_system_id(cls)
UUID or NoneRetrieve the UUID of the currently active system

Staticmethods

FunctionParametersReturn ValueDescription
System.get_all_system_ids()
A list of UUIDFetches the UUID of all systems stored in the database

Properties

PropertyGetterSetterDescription
System.is_active
Returns True when all conditionals of this system meet their expected value

RegtestSystem

Methods

FunctionParametersReturn ValueDescription
RegtestSystem.__enter__(self)
RegtestSystem instanceEnter the context
RegtestSystem.__exit__(self, *exc_details)exc_details: Exception details
Leave the context, deleting the RegtestSystem