stalker.models.budget.Budget

class stalker.models.budget.Budget(**kwargs)

Bases: stalker.models.entity.Entity, stalker.models.mixins.ProjectMixin, stalker.models.mixins.DAGMixin, stalker.models.mixins.StatusMixin

Manages project budgets

Budgets manager Project budgets. You can create entries as instances of BudgetEntry class.

__init__(**kwargs)

Methods

__init__(**kwargs)
walk_hierarchy([method])	Walks the hierarchy of this task.

Attributes

budget_id
children	Other Budget instances which are the children of this one.
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
entries
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
is_container	Returns True if the Task has children Tasks
is_leaf	Returns True if the Task has no children Tasks
is_root	Returns True if the Task has no parent
metadata
name	Name of this object
nice_name	Nice name of this object.
notes	All the Notess attached to this entity.
parent	A Budget instance which is the parent of this Budget.
parent_id
parents	Returns all of the parents of this mixed in class starting from the
plural_class_name	the plural name of this class
project	The Project instance that this object belongs to.
project_id
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.

children

Other Budget instances which are the children of this one. This attribute along with the parent attribute is used in creating a DAG hierarchy of tasks.

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.

is_container

Returns True if the Task has children Tasks

is_leaf

Returns True if the Task has no children Tasks

is_root

Returns True if the Task has no parent

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 to None will raise a TypeError.

parent

A Budget instance which is the parent of this Budget. In Stalker it is possible to create a hierarchy of Budget.

parents

Returns all of the parents of this mixed in class starting from the root

plural_class_name

the plural name of this class

project

The Project instance that this object belongs to.

status

The current status of the object.

It is a Status instance which is one of the Statuses stored in the status_list attribute of this object.

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 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.

walk_hierarchy(method=0)

Walks the hierarchy of this task.

Parameters:method – The walk method, 0: Depth First, 1: Breadth First