Bases: stalker.models.entity.Entity
Holds data about how the physical files are arranged in the Repository.
Structures are generally owned by Project objects. Whenever a Project is physically created, project folders are created by looking at custom_template of the Structure, the Project object is generally given to the Structure. So it is possible to use a variable like “{{project}}” or derived variables like:
{% for seq in project.sequences %}
{{do something here}}
Every line of this rendered template will represent a folder and Stalker will create these folders on the attached Repository.
Parameters: |
|
---|
A Structure can not be created without a type (__strictly_typed__ = True). By giving a type to the Structure, you can create one structure for Commercials and another project structure for Movies and another one for Print projects etc. and can reuse them with new Projects.
Methods
__init__([templates, custom_template]) |
Attributes
created_by | The User who has created this object. |
created_by_id | The id of the User who has created |
custom_template | |
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 | |
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. |
structure_id | |
tags | A list of tags attached to this object. |
templates | |
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 |
A datetime.datetime instance showing the creation date and time of this object.
A datetime.datetime instance showing the update date and time of this object.
Description of this object.
This attribute can hold any kind of data which exists in SOM.
Name of this object
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.
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.
the plural name of this class
A list of tags attached to this object.
It is a list of Tag instances which shows the tags of this object
returns TaskJuggler compatible id
renders a TaskJuggler compliant string used for TaskJuggler integration. Needs to be overridden in inherited classes.
The type of the object.
It is an instance of Type with a proper target_entity_type.