Previous topic

stalker.core.models.repository

Next topic

stalker.core.models.sequence

This Page

stalker.core.models.repository.Repository

Inheritance diagram of stalker.core.models.repository.Repository

class stalker.core.models.repository.Repository(linux_path='', windows_path='', osx_path='', **kwargs)[source]

Bases: stalker.core.models.entity.Entity

Repository is a class to hold repository server data. A repository is a network share that all users have access to.

A studio can create several repositories, for example, one for movie projects and one for commercial projects.

A repository also defines the default paths for linux, windows and mac fileshares.

Parameters:
  • linux_path – shows the linux path of the repository root, should be a string
  • osx_path – shows the mac osx path of the repository root, should be a string
  • windows_path – shows the windows path of the repository root, should be a string
__init__(linux_path='', windows_path='', osx_path='', **kwargs)[source]

Methods

__init__(**kwargs[, linux_path, ...])

Attributes

code The code name of this object.
created_by The User who has created
date_created A datetime.datetime instance showing the creation
date_updated A datetime.datetime instance showing the update
description Description of this object.
linux_path property that helps to set and get linux_path values
name name of this object
nice_name The nice name of this object.
notes all the notes about this entity, it should be a list of Notes
osx_path property that helps to set and get osx_path values
path property that helps to get path for the current os
tags a list of Tag objects which shows the related tags to the
updated_by The User who has updated
windows_path property that helps to set and get windows_path values
linux_path[source]

property that helps to set and get linux_path values

osx_path[source]

property that helps to set and get osx_path values

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 to the uppercase form of the nice_name attribute. If the 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

The 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 notes about this entity, it should be a list of Notes objects or an empty list, None is not accepted

tags

a list of Tag objects which shows the related tags to the entity

updated_by

The User who has updated this object.

windows_path[source]

property that helps to set and get windows_path values

path[source]

property that helps to get path for the current os