Source code for stalker.models.version

# -*- coding: utf-8 -*-
# Stalker a Production Asset Management System
# Copyright (C) 2009-2013 Erkan Ozgur Yilmaz
# 
# This file is part of Stalker.
# 
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation;
# version 2.1 of the License.
# 
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
# 
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
import os

import re
import jinja2

from sqlalchemy import Table, Column, Integer, ForeignKey, String, Boolean
from sqlalchemy.exc import UnboundExecutionError
from sqlalchemy.orm import relationship, validates

from stalker.db.declarative import Base
from stalker.models import check_circular_dependency
from stalker.models.link import Link
from stalker.models.mixins import StatusMixin

from stalker import defaults

from stalker.log import logging_level
import logging

logger = logging.getLogger(__name__)
logger.setLevel(logging_level)


[docs]class Version(Link, StatusMixin): """Holds information about the created versions (files) for a class:`~stalker.models.task.Task` A :class:`~stalker.models.version.Version` holds information about the created files related to a class:`~stalker.models.task.Task`. So if one creates a new version for a file or a sequences of file for a :class:`~stalker.models.task.Task` then the information is hold in the :class:`~stalker.models.version.Version` instance. :param str take_name: A short string holding the current take name. Takes in Stalker are used solely for grouping individual versions together. Versions with the same ``take_name`` (of the same Task) are numbered together. It 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. :param inputs: A list o :class:`~stalker.models.link.Link` instances, holding the inputs of the current version. It could be a texture for a Maya file or an image sequence for Nuke, or anything those you can think as the input for the current Version. :type inputs: list of :class:`~stalker.models.link.Link` :param outputs: A list of :class:`~stalker.models.link.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 out of this Version. :type outputs: list of :class:`~stalker.models.link.Link` instances :param task: A :class:`~stalker.models.task.Task` instance showing the owner of this Version. :type task: :class:`~stalker.models.task.Task` :param parent: A :class:`~stalker.models.version.Version` instance which is the parent of this Version. It is mainly used to see which Version is derived from which in the Version history of a :class:`~stalker.models.task.Task`. :type parent: :class:`~stalker.models.version.Version` """ __auto_name__ = True __tablename__ = "Versions" __mapper_args__ = {"polymorphic_identity": "Version"} version_id = Column("id", Integer, ForeignKey("Links.id"), primary_key=True) task_id = Column(Integer, ForeignKey("Tasks.id"), nullable=False) task = relationship( "Task", primaryjoin="Versions.c.task_id==Tasks.c.id", doc="""The :class:`~stalker.models.task.Task` instance that this Version is created for. """, uselist=False, back_populates="versions", ) take_name = Column( String(256), default=defaults.version_take_name, doc="""Takes in Versions are used solely for grouping individual versions together.""" ) version_number = Column( Integer, default=1, nullable=False, doc="""The :attr:`.version_number` attribute is read-only. Trying to change it will produce an AttributeError. """ ) # source_file_id = Column(Integer, ForeignKey("Links.id")) # source_file = relationship( # "Link", # primaryjoin="Versions.c.source_file_id==Links.c.id", # uselist=False, # doc="""This is the source file of this Version instance. # # It holds a :class:`~stalker.models.link.Link` instance which is showing # a source file for this version. It is let say the scene file for Maya # or a psd file for Photoshop etc. # """ # ) parent_id = Column('parent_id', Integer, ForeignKey('Versions.id')) parent = relationship( 'Version', remote_side=[version_id], primaryjoin='Versions.c.parent_id==Versions.c.id', back_populates='children', post_update=True ) children = relationship( 'Version', primaryjoin='Versions.c.parent_id==Versions.c.id', back_populates='parent', post_update=True, doc="""The children :class:`~stalker.models.version.Version` instances which are derived from this particular Version instance. """ ) inputs = relationship( "Link", secondary="Version_Inputs", primaryjoin="Versions.c.id==Version_Inputs.c.version_id", secondaryjoin="Version_Inputs.c.link_id==Links.c.id", doc="""The inputs of the current version. It is a list of :class:`~stalker.models.link.Link` instances. """ ) outputs = relationship( "Link", secondary="Version_Outputs", primaryjoin="Versions.c.id==Version_Outputs.c.version_id", secondaryjoin="Version_Outputs.c.link_id==Links.c.id", doc="""The outputs of the current version. It is a list of :class:`~stalker.models.link.Link` instances. """ ) is_published = Column(Boolean, default=False)
[docs] def __init__(self, task=None, take_name=defaults.version_take_name, inputs=None, outputs=None, parent=None, full_path=None, **kwargs): # call supers __init__ kwargs['full_path'] = full_path super(Version, self).__init__(**kwargs) StatusMixin.__init__(self, **kwargs) self.take_name = take_name # self.source_file = source_file self.task = task self.version_number = None if inputs is None: inputs = [] if outputs is None: outputs = [] self.inputs = inputs self.outputs = outputs # set published to False by default self.is_published = False self.parent = parent # @validates("source_file") # def _validate_source_file(self, key, source_file): # """validates the given source_file value # """ # from stalker.models.link import Link # # if source_file is not None: # if not isinstance(source_file, Link): # raise TypeError("Version.source_file attribute should be a " # "stalker.models.link.Link instance, not %s"\ # % source_file.__class__.__name__) # # return source_file
def _format_take_name(self, take_name): """formats the given take_name value """ logger.debug("-------------------------------------") logger.debug("take_name : %s" % take_name) # remove unnecessary characters take_name = re.sub( r"([^a-zA-Z0-9\s_\-]+)", r"", take_name ).strip() logger.debug("take_name : %s" % take_name) # replace empty spaces with underscores take_name = re.sub(r'[\s]+', '_', take_name) logger.debug("take_name : %s" % take_name) # replace multiple underscores with only one take_name = re.sub(r'([_]+)', r'_', take_name) logger.debug("take_name : %s" % take_name) # take_name = re.sub(r"(.+?[^a-zA-Z]+)([a-zA-Z0-9\s_\-]+)", r"\2", take_name) take_name = re.sub(r"^[^a-zA-Z0-9]+", r"", take_name) logger.debug("take_name : %s" % take_name) return take_name @validates("take_name") def _validate_take_name(self, key, take_name): """validates the given take_name value """ if take_name is None: raise TypeError("%s.take_name can not be None, please give a " "proper string" % self.__class__.__name__) take_name = self._format_take_name(str(take_name)) if take_name == "": raise ValueError("%s.take_name can not be an empty string" % self.__class__.__name__) return take_name @property
[docs] def max_version_number(self): """returns the maximum version number for this Version :return: int """ try: all_versions = Version.query \ .filter(Version.task == self.task) \ .filter(Version.take_name == self.take_name) \ .order_by(Version.version_number.desc()) \ .all() except UnboundExecutionError: all_versions = [] if len(all_versions): version_with_max_version_number = all_versions[-1] # skip the current version if it is itself to prevent increasing # the version number unnecessarily if version_with_max_version_number is not self: return version_with_max_version_number.version_number elif len(all_versions) > 1: return all_versions[-2].version_number return 0
@validates("version_number") def _validate_version_number(self, key, version_number): """validates the given version_number value """ max_version = self.max_version_number logger.debug('max_version_number: %s' % max_version) logger.debug('given version_number: %s' % version_number) if version_number is None or version_number <= max_version: version_number = max_version + 1 logger.debug( 'given Version.version_number is too low, max version_number ' 'in the database is %s, setting the current version_number to ' '%s' % (max_version, version_number) ) return version_number @validates("task") def _validate_task(self, key, task): """validates the given task value """ if task is None: raise TypeError("%s.task can not be None" % self.__class__.__name__) from stalker.models.task import Task if not isinstance(task, Task): raise TypeError("%s.task should be a " "stalker.models.task.Task instance not %s" % (self.__class__.__name__, task.__class__.__name__)) return task @validates("inputs") def _validate_inputs(self, key, input): """validates the given output """ from stalker.models.link import Link if not isinstance(input, Link): raise TypeError("all elements in %s.inputs should be all " "stalker.models.link.Link instances not %s" % (self.__class__.__name__, input.__class__.__name__) ) return input @validates("outputs") def _validate_outputs(self, key, output): """validates the given output """ from stalker.models.link import Link if not isinstance(output, Link): raise TypeError("all elements in %s.outputs should be all " "stalker.models.link.Link instances not %s" % (self.__class__.__name__, output.__class__.__name__) ) return output @validates('parent') def _validate_parent(self, key, parent): """validates the given parent value """ if parent is not None: if not isinstance(parent, Version): raise TypeError('%s.parent should be a ' 'stalker.models.version.Version instance, ' 'not %s' % (self.__class__.__name__, parent.__class__.__name__)) # check for CircularDependency check_circular_dependency(self, parent, 'children') return parent @validates('children') def _validate_children(self, key, child): """validates the given child value """ if not isinstance(child, Version): raise TypeError('All elements in %s.children should be a ' 'stalker.models.version.Version instance, not %s' % (self.__class__.__name__, child.__class__.__name__)) return child def _template_variables(self): """variables used in rendering the filename template """ from stalker import Shot sequences = [] scenes = [] if isinstance(self.task, Shot): sequences = self.task.sequences scenes = self.task.scenes shot = self.task # get the parent tasks task = self.task parent_tasks = task.parents parent_tasks.append(task) kwargs = { 'project': self.task.project, 'sequences': sequences, 'scenes': scenes, 'sequence': self.task, 'shot': self.task, 'asset': self.task, 'task': self.task, 'parent_tasks': parent_tasks, 'version': self, 'type': self.type, 'extension': self.extension } return kwargs
[docs] def update_paths(self): """updates the path variables """ kwargs = self._template_variables() # get a suitable FilenameTemplate structure = self.task.project.structure from stalker import FilenameTemplate vers_template = None if structure: for template in structure.templates: assert isinstance(template, FilenameTemplate) if template._target_entity_type == self.task.entity_type: vers_template = template break if not vers_template: raise RuntimeError( "There are no suitable FilenameTemplate " "(target_entity_type == '%s') defined in the Structure of the " "related Project instance, please create a new " "`stalker.models.template.FilenameTemplate` instance with its " "'target_entity_type' attribute is set to '%s' and assign it " "to the `templates` attribute of the structure of the " "project" % (self.task.entity_type, self.task.entity_type) ) self.filename = jinja2.Template(vers_template.filename) \ .render(**kwargs) self.path = jinja2.Template(vers_template.path).render(**kwargs)
@property
[docs] def absolute_full_path(self): """Returns the absolute full path of this version including the repository path of the related project :return: str """ project = self.task.project repo = project.repository return os.path.join( repo.path, self.full_path ).replace('\\', '/')
@property
[docs] def absolute_path(self): """Returns the absolute path of this version including the repository path of the related project :return: str """ project = self.task.project repo = project.repository return os.path.join( repo.path, self.path ).replace('\\', '/') # VERSION INPUTS
Version_Inputs = Table( "Version_Inputs", Base.metadata, Column("version_id", Integer, ForeignKey("Versions.id"), primary_key=True), Column("link_id", Integer, ForeignKey("Links.id"), primary_key=True) ) # VERSION_OUTPUTS Version_Outputs = Table( "Version_Outputs", Base.metadata, Column("version_id", Integer, ForeignKey("Versions.id"), primary_key=True), Column("link_id", Integer, ForeignKey("Links.id"), primary_key=True) )