Source code for stalker.models.reference
#-*- coding: utf-8 -*-
from stalker.models import entity
########################################################################
[docs]class Reference(entity.Entity):
"""Holds data about external references.
References are all about to give some external information to the current
entity (external to the database, so it can be something on the
:class:`~stalker.models.repository.Repository` or in the Web). The
reference type is defined by the
:class:`~stalker.models.reference.ReferenceType` object and it can be
anything like File, Folder, Web, Image, Movie, Text etc. (you can also use
multiple :class:`~stalker.models.tag.Tag`s for). Again it is
defined by the needs of the studio.
The references should be used to give external references (as the name
suggests), it is not a good place to connect
:class:`~stalker.models.asset.Asset` versions (namely
:class:`~stalker.models.version.Version` objects) to files in the
repository.
A :class:`~stalker.models.project.Project` object has a reference_template
which shows where to move the references in case
A reference object is an object which is a little bit more detailed than a
:class:`~stalker.models.link.Link` object by holding also a reference
to a :class:`~stalker.models.reference.ReferenceType` object. This
simplifies the sorting problem.
It is aimed to be used as direct links to files but it is not the correct
place to hold information about Asset and file connections. It is the duty
of Version objects to hold information about the Asset and file
connections.
Use this class for just reference a file or link to an entity.
"""
#----------------------------------------------------------------------
[docs] def __init__(self):
pass
########################################################################
[docs]class ReferenceType(entity.Entity):
"""Type type of :class:`~stalker.models.reference.Reference` is hold in
ReferenceType objects.
"""
#----------------------------------------------------------------------
[docs] def __init__(self):
pass