Previous topic

stalker.core.models.User

Next topic

stalker.ext.auth

This Page

stalker.core.models.Version

Inheritance diagram of stalker.core.models.Version

class stalker.core.models.Version(version_of=None, take='MAIN', version=None, source=None, outputs=None, task=None, **kwargs)[source]

Bases: stalker.core.models.Entity, stalker.core.models.StatusMixin

The connection to the filesystem.

A Version holds information about the every incarnation of the files in the Repository. So if one creates a new version for a file or a sequences of file for a Task then the information is hold in the Version instance.

The version attribute is read-only. Trying to change it will produce an AttributeError.

Parameters:
  • take (str) – A short string holding the current take name. Can be any alphanumeric value (a-zA-Z0-9_). The default is the string “Main”. When skipped or given as None or an empty string then it will use the default value. It can not start with a number. It can not have white spaces.
  • version (int) – An integer value showing the current version number. The default is “1”. If skipped or given as zero or as a negative value a ValueError will be raised.
  • source_file (Link) – A Link instance, showing the source file of this version. It can be a Maya scene file (.ma, *.mb), a Nuke file (.nk) or anything that is opened with the application you have created this version.
  • outputs (list of Link instances) – A list of Link instances, holding the outputs of the current version. It could be the rendered image sequences out of Maya or Nuke, or it can be a Targa file which is the output of a Photoshop file (*.psd), or anything that you can think as the output which is created using the source_file.
  • task (Task) – A Task instance showing the owner of this Version.
__init__(version_of=None, take='MAIN', version=None, source=None, outputs=None, task=None, **kwargs)[source]

Methods

__init__(**kwargs[, version_of, take, ...])

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.
entity_id
entity_type
id
name Name of this object
nice_name Nice name of this object.
notes All the Notess attached to this entity.
outputs The outputs of the current version.
published
reviews All the Reviews about this Entity.
source
source_id
status
status_list
status_list_id
tags A list of tags attached to this object.
take
type The type of the object.
type_id
updated_by The User who has updated this object.
updated_by_id
version
version_id
version_of The Task instance that this Version is created for.
version_of_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.

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.

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.

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.

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.

version_of

The Task instance that this Version is created for.

outputs

The outputs of the current version.

It is a list of Link instances.