Previous topic

stalker.core.models.Review

Next topic

stalker.core.models.Shot

This Page

stalker.core.models.Sequence

Inheritance diagram of stalker.core.models.Sequence

class stalker.core.models.Sequence(lead=None, **kwargs)[source]

Bases: stalker.core.models.TaskableEntity, stalker.core.models.ReferenceMixin, stalker.core.models.StatusMixin, stalker.core.models.ScheduleMixin

Stores data about Sequences.

Sequences are holders of the Shot objects. They orginize the conceptual data with another level of complexity.

The Sequence class updates the sequence attribute in the Project class when the Sequence is initialized.

Parameters:lead (User) – The lead of this Seuqence. The default value is None.
__init__(lead=None, **kwargs)[source]

Methods

__init__(**kwargs[, lead])
create_secondary_tables_for_references() creates any secondary table

Attributes

code The code name of this object.
created_by The User who has created this object.
created_by_id
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.
due_date The date that the entity should be delivered.
duration Duration of the entity.
entity_id
entity_type
id
lead The lead of this sequence.
lead_id
name Name of this object
nice_name Nice name of this object.
notes All the Notess attached to this entity.
project The Project instance that this object belongs to.
project_id
references
reviews All the Reviews about this Entity.
sequence_id
shots The Shots assigned to this Sequence.
start_date The date that this entity should start.
status
status_list
status_list_id
tags A list of tags attached to this object.
taskableEntity_id
tasks
type The type of the object.
type_id
updated_by The User who has updated this object.
updated_by_id
code

The code name of this object.

It accepts string or unicode values and any other kind of objects will be converted to string. In any update to the name attribute the code also will be updated. If the code is not initialized or given as None, it will be set to the uppercase version of the nice_name attribute. Setting the code attribute to None will reset it to the default value. The default value is the upper case form of the nice_name.

classmethod create_secondary_tables_for_references()

creates any secondary table

created_by

The User who has created this object.

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.

due_date

The date that the entity should be delivered.

The due_date can be set to a datetime.timedelta and in this case it will be calculated as an offset from the start_date and converted to datetime.date again. Setting the start_date to a date passing the due_date will also set the due_date so the timedelta between them is preserved, default value is 10 days

duration

Duration of the entity.

It is a datetime.timedelta instance. Showing the difference of the start_date and the due_date. If edited it changes the due_date attribute value.

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.

There is also the code attribute which is simply the upper case form of nice_name if it is not defined differently (i.e set to another value).

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.

project

The Project instance that this object belongs to.

reviews

All the Reviews about this Entity.

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

start_date

The date that this entity should start.

Also effects the due_date attribute value in certain conditions, if the start_date is set to a time passing the due_date it will also offset the due_date to keep the duration value fixed. start_date should be an instance of class:datetime.date and the default value is datetime.date.today()

tags

A list of tags attached to this object.

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

type

The type of the object.

It is an instance of Type with a proper target_entity_type.

updated_by

The User who has updated this object.

lead_id

class:~stalker.core.models.Project instance.

lead

The lead of this sequence.

A User instance which is assigned as the lead of this Sequence.

shots

The Shots assigned to this Sequence.

It is a list of Shot instances.