Previous topic

stalker.models.shot.Shot

Next topic

stalker.models.status.StatusList

This Page

stalker.models.status.Status

Inheritance diagram of stalker.models.status.Status

class stalker.models.status.Status(name=None, code=None, fg_color=None, bg_color=None, **kwargs)[source]

Bases: stalker.models.entity.Entity, stalker.models.mixins.CodeMixin

Defines object statutes.

No extra parameters, use the code attribute to give a short name for the status.

A Status object can be compared with a string or unicode value and it will return if the lower case name or lower case code of the status matches the lower case form of the given string:

>>> from stalker import Status
>>> a_status = Status(name="On Hold", "OH")
>>> a_status == "on hold"
True
>>> a_status != "complete"
True
>>> a_status == "oh"
True
>>> a_status == "another status"
False
Parameters:
  • name – The name long name of this Status.
  • code – The code of this Status, its generally the short version of the name attribute.
  • bg_color – A positive integer between 0-16777215 or 0x000000-0xffffff showing the background color of this status mainly used for UI stuff. If skipped or given as None the color will be set to the default background color (which is white).
  • fg_color – A positive integer between 0-16777215 or 0x000000-0xffffff showing the foreground color of this status mainly used for UI stuff. If skipped or given as None the color will be set to the default foreground color (which is black).
__init__(name=None, code=None, fg_color=None, bg_color=None, **kwargs)[source]

Methods

__init__([name, code, fg_color, bg_color])

Attributes

bg_color
code The code name of this object.
created_by The User who has created this object.
created_by_id The id of the User who has created
date_created A datetime.datetime instance showing the creation date and time of this object.
date_updated A datetime.datetime instance showing the update date and time of this object.
description Description of this object.
entity_id
entity_type
fg_color
generic_data This attribute can hold any kind of data which exists in SOM.
id
metadata A collection of Table objects and their associated schema
name Name of this object
nice_name Nice name of this object.
notes All the Notess attached to this entity.
plural_class_name the plural name of this class
query ORM-level SQL construction object.
status_id
tags A list of tags attached to this object.
thumbnail
thumbnail_id
tjp_id returns TaskJuggler compatible id
to_tjp renders a TaskJuggler compliant string used for TaskJuggler
type The type of the object.
type_id The id of the Type of this entity.
updated_by The User who has updated this object.
updated_by_id The id of the User who has updated
code

The code name of this object.

It accepts strings. Can not be None.

created_by

The User who has created this object.

created_by_id

The id of the User who has created this entity.

date_created

A datetime.datetime instance showing the creation date and time of this object.

date_updated

A datetime.datetime instance showing the update date and time of this object.

description

Description of this object.

generic_data

This attribute can hold any kind of data which exists in SOM.

name

Name of this object

nice_name

Nice name of this object.

It has the same value with the name (contextually) but with a different format like, all the white spaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lower case.

notes

All the Notess attached to this entity.

It is a list of Note instances or an empty list, setting it None will raise a TypeError.

plural_class_name

the plural name of this class

tags

A list of tags attached to this object.

It is a list of Tag instances which shows the tags of this object

tjp_id

returns TaskJuggler compatible id

to_tjp

renders a TaskJuggler compliant string used for TaskJuggler integration. Needs to be overridden in inherited classes.

type

The type of the object.

It is an instance of Type with a proper target_entity_type.

type_id

The id of the Type of this entity. Mainly used by SQLAlchemy to create a Many-to-One relates between SimpleEntities and Types.

updated_by

The User who has updated this object.

updated_by_id

The id of the User who has updated this entity.