stalker.models.entity.Entity

class stalker.models.entity.Entity(tags=None, notes=None, **kwargs)

Bases: stalker.models.entity.SimpleEntity

Another base data class that adds tags and notes to the attributes list.

This is the entity class which is derived from the SimpleEntity and adds only tags to the list of parameters.

Two Entities considered equal if they have the same name. It doesn’t matter if they have different tags or notes.

Parameters:

• tags (list) – A list of Tag objects related to this entity. tags could be an empty list, or when omitted it will be set to an empty list.
• notes (list) – A list of Note instances. Can be an empty list, or when omitted it will be set to an empty list, when set to None it will be converted to an empty list.

__init__(tags=None, notes=None, **kwargs)

Methods

__init__([tags, notes])

Attributes

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.
entity_groups
entity_id
entity_type
generic_data	This attribute can hold any kind of data which exists in SOM.
generic_text	This attribute can hold any text.
html_class
html_style
id
metadata
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
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 this entity.

tags

A list of tags attached to this object.

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

notes

All the Notess attached to this entity.

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

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.

generic_text

This attribute can hold any text.

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.

plural_class_name

the plural name of this class

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 a Type instance with a proper Type.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.