Data Handlers

pyblish/__init__.py

@@ -7,11 +7,25 @@
 
 """
 
-from .version import *
+from .version import version, version_info, __version__
 
 
 _registered_paths = list()
+_registered_callbacks = dict()
 _registered_plugins = dict()
 _registered_services = dict()
-_registered_test = None
+_registered_test = dict()
 _registered_hosts = list()
+
+
+__all__ = [
+    "version",
+    "version_info",
+    "__version__",
+    "_registered_paths",
+    "_registered_callbacks",
+    "_registered_plugins",
+    "_registered_services",
+    "_registered_test",
+    "_registered_hosts",
+]

pyblish/api.py

@@ -16,8 +16,8 @@
 
 from __future__ import absolute_import
 
+from . import version
 import getpass
-import pyblish
 
 from .plugin import (
     Context,
@@ -58,6 +58,11 @@
     deregister_all_services,
     registered_services,
 
+    register_callback,
+    deregister_callback,
+    deregister_all_callbacks,
+    registered_callbacks,
+
     sort as sort_plugins,
 
     registered_paths,
@@ -70,6 +75,7 @@
     log,
     time as __time,
     format_filename,
+    emit
 )
 
 from .logic import (
@@ -98,7 +104,6 @@
 )
 
 
-version = pyblish.version
 config = __Config()
 
 
@@ -168,6 +173,11 @@ def __init__():
     "deregister_all_services",
     "registered_services",
 
+    "register_callback",
+    "deregister_callback",
+    "deregister_all_callbacks",
+    "registered_callbacks",
+
     "register_plugin_path",
     "deregister_plugin_path",
     "deregister_all_paths",
@@ -192,6 +202,7 @@ def __init__():
 
     # Utilities
     "log",
+    "emit",
 
     # Exceptions
     "PyblishError",

pyblish/lib.py

@@ -5,6 +5,8 @@
 import datetime
 import traceback
 
+from . import _registered_callbacks
+
 _filename_ascii_strip_re = re.compile(r'[^-\w.]')
 _windows_device_files = ('CON', 'AUX', 'COM1', 'COM2', 'COM3', 'COM4',
                          'LPT1', 'LPT2', 'LPT3', 'PRN', 'NUL')
@@ -349,3 +351,27 @@ def _resolve_name(name, package, level):
     __import__(name)
 
     return sys.modules[name]
+
+
+def emit(signal, **kwargs):
+    """Trigger registered callbacks
+
+    Keyword arguments are passed from caller to callee.
+
+    Arguments:
+        signal (string): Name of signal emitted
+
+    Example:
+        >>> import sys
+        >>> from .plugin import register_callback
+        >>> register_callback("mysignal", lambda data: sys.stdout.write(data))
+        >>> emit("mysignal", data={"something": "cool"})
+        {'something': 'cool'}
+
+    """
+
+    for callback in _registered_callbacks.get(signal, []):
+        try:
+            callback(**kwargs)
+        except Exception as e:
+            traceback.print_exc(e)

pyblish/logic.py

@@ -4,8 +4,8 @@
 import inspect
 import traceback
 
-import pyblish
-import lib
+from . import _registered_test, lib
+from .plugin import Validator
 
 
 class TestFailed(Exception):
@@ -37,7 +37,7 @@ def default_test(**vars):
     """
 
     offset = 0.5
-    validation_order = pyblish.api.Validator.order
+    validation_order = Validator.order
 
     # If validation is done
     if vars["nextOrder"] >= validation_order + offset:
@@ -193,12 +193,12 @@ def register_test(test):
 
     """
 
-    pyblish._registered_test = test
+    _registered_test["default"] = test
 
 
 def registered_test():
     """Return the currently registered test"""
-    return pyblish._registered_test
+    return _registered_test["default"]
 
 
 def deregister_test():