Skip to content

collect_version

Requires

context -> version

Provides

instance -> version - incremented latest published workfile version

CollectVersion

Bases: InstancePlugin

Collect version for publishable instances.

Used to synchronize version from workfile to all publishable instances
  • image (manually created or color coded)
  • review
  • workfile

Dev comment: Explicit collector created to control this from single place and not from 3 different.

Workfile set here explicitly as version might to be forced from latest + 1 because of Webpublisher. (This plugin must run after CollectPublishedVersion!)

Source code in client/ayon_photoshop/plugins/publish/collect_version.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class CollectVersion(pyblish.api.InstancePlugin):
    """Collect version for publishable instances.

    Used to synchronize version from workfile to all publishable instances:
        - image (manually created or color coded)
        - review
        - workfile

    Dev comment:
    Explicit collector created to control this from single place and not from
    3 different.

    Workfile set here explicitly as version might to be forced from latest + 1
    because of Webpublisher.
    (This plugin must run after CollectPublishedVersion!)
    """
    # QUESTION can we move the logic to the 'CollectPublishedVersion'?
    order = pyblish.api.CollectorOrder - 0.35

    label = "Collect Version"

    hosts = ["photoshop"]
    families = ["image", "review", "workfile"]
    settings_category = "photoshop"

    def process(self, instance):
        workfile_version = instance.context.data["version"]
        self.log.debug(f"Applying version {workfile_version}")
        instance.data["version"] = workfile_version