Ayon-Python-Api 0.1.14__tar.gz → 0.1.16__tar.gz

ayon-python-api-0.1.16/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: ayon-python-api
+Version: 0.1.16
+Summary: AYON Python API
+Home-page: https://github.com/ynput/ayon-python-api
+Author: ynput.io
+Author-email: info@ynput.io
+License: Apache License (2.0)
+Keywords: AYON,ynput,OpenPype,vfx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# AYON server API
+Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
+
+AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
+
+Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_TOKEN` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object.
+
+## Install
+AYON python api is available on PyPi:
+
+    pip install ayon-python-api
+
+For development purposes you may follow [build](#build-wheel) guide to build and install custom wheels.
+
+
+## Cloning the repository
+Repository does not have submodules or special cases. Clone is simple as:
+
+    git clone git@github.com:ynput/ayon-python-api.git
+
+
+## Build wheel
+For wheel build is required a `wheel` module from PyPi:
+
+    pip install wheel
+
+Open terminal and change directory to ayon-python-api repository and build wheel:
+
+    cd <REPOSITORY ROOT>/ayon-python-api
+    python setup.py sdist bdist_wheel   
+    
+
+Once finished a wheel should be created in `./dist/ayon_python_api-<VERSION>-py3-none-any`.
+
+---
+
+### Wheel installation
+The wheel file can be used to install using pip:
+
+    pip install <REPOSITORY ROOT>/dist/ayon_python_api-<VERSION>-py3-none-any
+
+If pip complain that `ayon-python-api` is already installed just uninstall existing one first:
+    
+    pip uninstall ayon-python-api
+
+
+## TODOs
+- Find more suitable name of `ServerAPI` objects (right now is used `con` or `connection`)
+- Add all available CRUD operation on entities using REST
+- Add folder and task changes to operations
+- Enhance entity hub
+  - Entity hub should use operations session to do changes
+  - Entity hub could also handle 'subset', 'version' and 'representation' entities
+  - Missing docstrings in EntityHub -> especially entity arguments are missing
+- Pass docstrings and arguments definitions from `ServerAPI` methods to global functions
+- Missing websockets connection

ayon-python-api-0.1.16/README.md

@@ -0,0 +1,56 @@
+# AYON server API
+Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
+
+AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
+
+Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_TOKEN` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object.
+
+## Install
+AYON python api is available on PyPi:
+
+    pip install ayon-python-api
+
+For development purposes you may follow [build](#build-wheel) guide to build and install custom wheels.
+
+
+## Cloning the repository
+Repository does not have submodules or special cases. Clone is simple as:
+
+    git clone git@github.com:ynput/ayon-python-api.git
+
+
+## Build wheel
+For wheel build is required a `wheel` module from PyPi:
+
+    pip install wheel
+
+Open terminal and change directory to ayon-python-api repository and build wheel:
+
+    cd <REPOSITORY ROOT>/ayon-python-api
+    python setup.py sdist bdist_wheel   
+    
+
+Once finished a wheel should be created in `./dist/ayon_python_api-<VERSION>-py3-none-any`.
+
+---
+
+### Wheel installation
+The wheel file can be used to install using pip:
+
+    pip install <REPOSITORY ROOT>/dist/ayon_python_api-<VERSION>-py3-none-any
+
+If pip complain that `ayon-python-api` is already installed just uninstall existing one first:
+    
+    pip uninstall ayon-python-api
+
+
+## TODOs
+- Find more suitable name of `ServerAPI` objects (right now is used `con` or `connection`)
+- Add all available CRUD operation on entities using REST
+- Add folder and task changes to operations
+- Enhance entity hub
+  - Entity hub should use operations session to do changes
+  - Entity hub could also handle 'subset', 'version' and 'representation' entities
+  - Missing docstrings in EntityHub -> especially entity arguments are missing
+- Pass docstrings and arguments definitions from `ServerAPI` methods to global functions
+- Missing websockets connection

{ayon-python-api-0.1.14 → ayon-python-api-0.1.16}/ayon_api/entity_hub.py

@@ -673,6 +673,7 @@ class EntityHub(object):
             if entity_id in processed_ids:
                 continue
             entity = self._entities_by_id[entity_id]
+            processed_ids.add(entity_id)
             operations_body.append(self._get_create_body(entity))
 
         for entity_id in reversed(removed_entity_ids):
@@ -877,9 +878,7 @@ class BaseEntity(object):
         if created is None:
             created = entity_id is None
 
-        entity_id = convert_entity_id(entity_id)
-        if entity_id is None:
-            entity_id = create_entity_id()
+        entity_id = self._prepare_entity_id(entity_id)
 
         if data is None:
             data = {}
@@ -924,6 +923,12 @@ class BaseEntity(object):
     def __setitem__(self, item, value):
         return setattr(self, item, value)
 
+    def _prepare_entity_id(self, entity_id):
+        entity_id = convert_entity_id(entity_id)
+        if entity_id is None:
+            entity_id = create_entity_id()
+        return entity_id
+
     @property
     def id(self):
         """Access to entity id under which is entity available on server.
@@ -1347,6 +1352,13 @@ class ProjectEntity(BaseEntity):
         self._orig_folder_types = copy.deepcopy(folder_types)
         self._orig_task_types = copy.deepcopy(task_types)
 
+    def _prepare_entity_id(self, entity_id):
+        if entity_id != self.project_name:
+            raise ValueError(
+                "Unexpected entity id value \"{}\". Expected \"{}\"".format(
+                    entity_id, self.project_name))
+        return entity_id
+
     def get_parent(self, *args, **kwargs):
         return None
 
@@ -1426,6 +1438,10 @@ class FolderEntity(BaseEntity):
 
     def __init__(self, folder_type, *args, label=None, path=None, **kwargs):
         super(FolderEntity, self).__init__(*args, **kwargs)
+        # Autofill project as parent of folder if is not yet set
+        # - this can be guessed only if folder was just created
+        if self.created and self._parent_id is UNKNOWN_VALUE:
+            self._parent_id = self.project_name
 
         self._folder_type = folder_type
         self._label = label

{ayon-python-api-0.1.14 → ayon-python-api-0.1.16}/ayon_api/operations.py

@@ -1,7 +1,6 @@
 import copy
 import collections
 import uuid
-import datetime
 from abc import ABCMeta, abstractproperty
 
 import six
@@ -137,13 +136,20 @@ def new_version_entity(
     if data is None:
         data = {}
 
-    return {
+    output = {
         "id": _create_or_convert_to_id(entity_id),
         "version": int(version),
         "subsetId": _create_or_convert_to_id(subset_id),
         "attrib": attribs,
         "data": data
     }
+    if task_id:
+        output["taskId"] = task_id
+    if thumbnail_id:
+        output["thumbnailId"] = thumbnail_id
+    if author:
+        output["author"] = author
+    return output
 
 
 def new_hero_version_entity(
@@ -180,13 +186,20 @@ def new_hero_version_entity(
     if data is None:
         data = {}
 
-    return {
+    output = {
         "id": _create_or_convert_to_id(entity_id),
         "version": -abs(int(version)),
         "subsetId": subset_id,
         "attrib": attribs,
         "data": data
     }
+    if task_id:
+        output["taskId"] = task_id
+    if thumbnail_id:
+        output["thumbnailId"] = thumbnail_id
+    if author:
+        output["author"] = author
+    return output
 
 
 def new_representation_entity(
@@ -198,7 +211,6 @@ def new_representation_entity(
         name (str): Representation name considered as unique identifier
             of representation under version.
         version_id (str): Id of parent version.
-        context (Dict[str, Any]): Representation context used to fill template.
         attribs (Dict[str, Any]): Explicitly set attributes of representation.
         data (Dict[str, Any]): Representation entity data.
         entity_id (str): Predefined id of entity. New id is created
@@ -236,6 +248,8 @@ def new_workfile_info_doc(
         task_name (str): Task under which was workfile created.
         files (List[str]): List of rootless filepaths related to workfile.
         data (Dict[str, Any]): Additional metadata.
+        entity_id (str): Predefined id of entity. New id is created
+            if not passed.
 
     Returns:
         Dict[str, Any]: Skeleton of workfile info entity.
@@ -254,153 +268,6 @@ def new_workfile_info_doc(
     }
 
 
-def _prepare_update_data(old_doc, new_doc, replace):
-    changes = {}
-    for key, value in new_doc.items():
-        if key not in old_doc or value != old_doc[key]:
-            changes[key] = value
-
-    if replace:
-        for key in old_doc.keys():
-            if key not in new_doc:
-                changes[key] = REMOVED_VALUE
-    return changes
-
-
-def prepare_folder_update_data(old_doc, new_doc, replace=True):
-    """Compare two folder entities and prepare update data.
-
-    Based on compared values will create update data for
-    'UpdateOperation'.
-
-    Empty output means that entities data are identical.
-
-    Returns:
-        Dict[str, Any]: Changes between old and new entity.
-    """
-
-    # changes = {}
-    # for key, value in new_doc.items():
-    #     if key in ("data", ):
-    #         continue
-    #
-    #     if key not in old_doc or value != old_doc[key]:
-    #         changes[key] = value
-    #
-    # return _prepare_update_data(old_doc, new_doc, replace)
-
-    raise NotImplementedError(
-        "'prepare_folder_update_data' not yet implemented"
-    )
-
-
-def prepare_subset_update_data(old_doc, new_doc, replace=True):
-    """Compare two subset entities and prepare update data.
-
-    Based on compared values will create update data for
-    'UpdateOperation'.
-
-    Empty output means that entities are identical.
-
-    Returns:
-        Dict[str, Any]: Changes between old and new entity.
-    """
-
-    # return _prepare_update_data(old_doc, new_doc, replace)
-
-    raise NotImplementedError(
-        "'prepare_folder_update_data' not yet implemented"
-    )
-
-
-def prepare_version_update_data(old_doc, new_doc, replace=True):
-    """Compare two version entities and prepare update data.
-
-    Based on compared values will create update data for
-    'UpdateOperation'.
-
-    Empty output means that entities are identical.
-
-    Returns:
-        Dict[str, Any]: Changes between old and new entity.
-    """
-
-    # return _prepare_update_data(old_doc, new_doc, replace)
-
-    raise NotImplementedError(
-        "'prepare_folder_update_data' not yet implemented"
-    )
-
-
-def prepare_hero_version_update_data(old_doc, new_doc, replace=True):
-    """Compare two hero version entities and prepare update data.
-
-    Based on compared values will create update data for 'UpdateOperation'.
-
-    Empty output means that entities are identical.
-
-    Returns:
-        Dict[str, Any]: Changes between old and new entity.
-    """
-
-    # return _prepare_update_data(old_doc, new_doc, replace)
-
-    raise NotImplementedError(
-        "'prepare_folder_update_data' not yet implemented"
-    )
-
-
-def prepare_representation_update_data(old_doc, new_doc, replace=True):
-    """Compare two representation entities and prepare update data.
-
-    Based on compared values will create update data for
-    'UpdateOperation'.
-
-    Empty output means that entities are identical.
-
-    Returns:
-        Dict[str, Any]: Changes between old and new entity.
-    """
-
-    # return _prepare_update_data(old_doc, new_doc, replace)
-
-    raise NotImplementedError(
-        "'prepare_folder_update_data' not yet implemented"
-    )
-
-
-def prepare_workfile_info_update_data(old_doc, new_doc, replace=True):
-    """Compare two workfile info entities and prepare update data.
-
-    Based on compared values will create update data for
-    'UpdateOperation'.
-
-    Empty output means that entities are identical.
-
-    Returns:
-        Dict[str, Any]: Changes between old and new entity.
-    """
-
-    # return _prepare_update_data(old_doc, new_doc, replace)
-
-    raise NotImplementedError(
-        "'prepare_folder_update_data' not yet implemented"
-    )
-
-
-def entity_data_json_default(value):
-    if isinstance(value, datetime.datetime):
-        return int(value.timestamp())
-
-    raise TypeError(
-        "Object of type {} is not JSON serializable".format(str(type(value)))
-    )
-
-
-def failed_json_default(value):
-    return "< Failed value {} > {}".format(type(value), str(value))
-
-
 @six.add_metaclass(ABCMeta)
 class AbstractOperation(object):
     """Base operation class.