Merge commit

Author: iLLiCiTiT

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**What happened?**
+A clear and concise description of what the bug is, e.g. *"when I clicked on X, Y happened"*
+
+**What did you expect?**
+A similarly short description of your expectations, e.g. *"Z should have happened"*.
+
+**To Reproduce**
+Steps to reproduce the behavior, preferably a bullet-list.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is, e.g. *"To many clicks to do X"*
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen, e.g. *"Wish I could multi-select"*
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+Thank you for your contribution to Avalon! Here's how you can get your code merged quickly.
+
+**What's changed?**
+Briefly summarise the changes you've made, something human-readable to get the reader up-to-speed with your thought process (hint: everyone loves bullet-lists). If the PR is in response to an existing issue (it should), link to this here.
+
+**Health Check**
+To ensure your code lives up the standards of Avalon, consult the [Pull-Request](https://github.com/getavalon/core/blob/master/CONTRIBUTING.md#pull-request) section of `CONTRIBUTION.md` for details.
+
+**Examples**
+If you are unsure of how to format your pull-request, have a look at these examples. [#403](https://github.com/getavalon/core/pull/403), [#400](https://github.com/getavalon/core/pull/400)

avalon/nuke/__init__.py

@@ -6,7 +6,6 @@
 
 from .lib import (
     add_publish_knob,
-    ls_img_sequence,
     maintained_selection,
     get_node_path,
     get_avalon_knob_data,
@@ -52,6 +51,13 @@
 
     "Creator",
 
+    "file_extensions",
+    "has_unsaved_changes",
+    "save_file",
+    "open_file",
+    "current_file",
+    "work_root",
+
     "containerise",
     "parse_container",
     "update_container",
@@ -64,17 +70,8 @@
     "get_avalon_knob_data",
     "set_avalon_knob_data",
     "add_publish_knob",
-    "ls_img_sequence",
     "maintained_selection",
     "get_node_path",
-
-    # Workfiles API
-    "open",
-    "save",
-    "current_file",
-    "has_unsaved_changes",
-    "file_extensions",
-    "work_root"
 ]
 
 # Backwards API compatibility

avalon/nuke/lib.py

@@ -47,6 +47,8 @@ def reset_selection():
     """
     clear_selection_recursive()
 
+    Parse user data into Node knobs.
+    Use `collections.OrderedDict` to ensure knob order.
 
 def select_nodes(nodes):
     """Selects all inputed nodes
@@ -80,6 +82,46 @@ def add_publish_knob(node):
         node.addKnob(knob)
     return node
 
+    Returns:
+        None
+
+    Examples:
+        ```
+        import nuke
+        from avalon.nuke import lib
+
+        node = nuke.createNode("NoOp")
+        data = {
+            # Regular type of attributes
+            "myList": ["x", "y", "z"],
+            "myBool": True,
+            "myFloat": 0.1,
+            "myInt": 5,
+
+            # Creating non-default imprint type of knob
+            "MyFilePath": lib.Knobby("File_Knob", "/file/path"),
+            "divider": lib.Knobby("Text_Knob", ""),
+
+            # Manual nice knob naming
+            ("my_knob", "Nice Knob Name"): "some text",
+
+            # dict type will be created as knob group
+            "KnobGroup": {
+                "knob1": 5,
+                "knob2": "hello",
+                "knob3": ["a", "b"],
+            },
+
+            # Nested dict will be created as tab group
+            "TabGroup": {
+                "tab1": {"count": 5},
+                "tab2": {"isGood": True},
+                "tab3": {"direction": ["Left", "Right"]},
+            },
+        }
+        lib.imprint(node, data, tab="Demo")
+
+        ```
 
 def set_avalon_knob_data(node, data={}, prefix="ak:"):
     """ Sets a data into nodes's avalon knob
@@ -226,9 +268,13 @@ def check_subsetname_exists(nodes, subset_name):
     return result
 
 
-def imprint(node, data):
-    """Adding `Avalon data` into a node's Avalon Tab/Avalon knob
-    also including publish knob
+class Knobby(object):
+    """For creating knob which it's type isn't mapped in `create_knobs`
+
+    Args:
+        type (string): Nuke knob type name
+        value: Value to be set with `Knob.setValue`, put `None` if not required
+        *args: Args other than knob name for initializing knob class
 
     Arguments:
         node (obj): A nuke's node object
@@ -284,6 +330,24 @@ def ls_img_sequence(path):
         return False
 
 
+def get_avalon_knob_data(node, prefix="avalon:"):
+    """ Get data from nodes's avalon knob
+
+    Arguments:
+        node (nuke.Node): Nuke node to search for data,
+        prefix (str, optional): filtering prefix
+
+    Returns:
+        data (dict)
+    """
+    data = {
+        knob[len(prefix):]: node[knob].value()
+        for knob in node.knobs().keys()
+        if knob.startswith(prefix)
+    }
+    return data
+
+
 def fix_data_for_node_create(data):
     """Fixing data to be used for nuke knobs
     """

avalon/nuke/pipeline.py

@@ -13,6 +13,9 @@
 
 log = logging.getLogger(__name__)
 
+self = sys.modules[__name__]
+self._parent = None  # Main Window cache
+
 AVALON_CONFIG = os.environ["AVALON_CONFIG"]
 
 
@@ -76,6 +79,18 @@ def containerise(node,
         node (obj): containerised nuke's node object
 
     """
+    data = OrderedDict(
+        [
+            ("schema", "avalon-core:container-2.0"),
+            ("id", AVALON_CONTAINER_ID),
+            ("name", name),
+            ("namespace", namespace),
+            ("loader", str(loader)),
+            ("representation", context["representation"]["_id"]),
+        ],
+
+        **data or dict()
+    )
 
     data_imprint = OrderedDict({
         "schema": "avalon-core:container-2.0",
@@ -126,34 +141,30 @@ def parse_container(node, validate=True):
 
     # Store the node's name
     container["objectName"] = node["name"].value()
-
     # Store reference to the node object
     container["_node"] = node
 
     return container
 
 
-def update_container(node, keys=dict()):
+def update_container(node, keys=None):
     """Returns node with updateted containder data
 
     Arguments:
-        node (object): The node in Nuke to imprint as container,
-        keys (dict): data which should be updated
+        node (nuke.Node): The node in Nuke to imprint as container,
+        keys (dict, optional): data which should be updated
 
     Returns:
-        node (object): nuke node with updated container data
-    """
+        node (nuke.Node): nuke node with updated container data
 
     data = lib.get_avalon_knob_data(node)
 
     container = dict()
     container = {key: data[key] for key in data}
 
-    for key, value in container.items():
-        try:
-            container[key] = keys[key]
-        except KeyError:
-            pass
+    container = parse_container(node)
+    if not container:
+        raise TypeError("Not a valid container node.")
 
     node = lib.set_avalon_knob_data(node, container)
 
@@ -272,6 +283,18 @@ def find_host_config(config):
     return config
 
 
+def get_main_window():
+    """Acquire Nuke's main window"""
+    if self._parent is None:
+        top_widgets = QtWidgets.QApplication.topLevelWidgets()
+        name = "Foundry::UI::DockMainWindow"
+        main_window = next(widget for widget in top_widgets if
+                           widget.inherits("QMainWindow") and
+                           widget.metaObject().className() == name)
+        self._parent = main_window
+    return self._parent
+
+
 def uninstall(config):
     """Uninstall all that was previously installed
 
@@ -312,13 +335,26 @@ def _install_menu():
         api.Session["AVALON_ASSET"], api.Session["AVALON_TASK"]
     )
     context_menu = menu.addMenu(label)
-    context_menu.addCommand("Set Context", contextmanager.show)
+    context_menu.addCommand("Set Context",
+                            lambda: contextmanager.show(
+                                parent=get_main_window())
+                            )
+    menu.addSeparator()
+    menu.addCommand("Create...",
+                    lambda: creator.show(parent=get_main_window()))
+    menu.addCommand("Load...",
+                    lambda: loader.show(parent=get_main_window(),
+                                        use_context=True))
+    menu.addCommand("Publish...",
+                    lambda: publish.show(parent=get_main_window()))
+    menu.addCommand("Manage...",
+                    lambda: sceneinventory.show(parent=get_main_window()))
 
     menu.addSeparator()
     menu.addCommand("Work Files...",
                     lambda: workfiles.show(
-                        os.environ["AVALON_WORKDIR"]
-                    )
+                        os.environ["AVALON_WORKDIR"],
+                        parent=get_main_window())
                     )
     menu.addSeparator()
     menu.addCommand("Create...", creator.show)

avalon/pipeline.py

@@ -995,6 +995,12 @@ def update_current_task(task=None, asset=None, app=None):
     if not os.path.exists(workdir):
         os.makedirs(workdir)
 
+    parents = asset_document['data'].get('parents', [])
+    hierarchy = ""
+    if len(parents) > 0:
+        hierarchy = os.path.sep.join(parents)
+    changed['AVALON_HIERARCHY'] = hierarchy
+
     # Update the full session in one go to avoid half updates
     Session.update(changed)