Merge pull request #169 from mottosso/master

Maintenance update

CHANGES

@@ -3,6 +3,13 @@ pyblish Changelog
 
 This contains all major version changes between pyblish releases.
 
+Version 1.0.15
+--------------
+
+- API: Plugin.repair_* documented and implemented by default
+- API: Added lib.where()
+- API: Added `.id` attribute to instances and plug-ins
+
 Version 1.0.14
 --------------
 

pyblish/lib.py

@@ -8,6 +8,14 @@
                          'LPT1', 'LPT2', 'LPT3', 'PRN', 'NUL')
 
 
+class classproperty(object):
+    def __init__(self, getter):
+        self.getter = getter
+
+    def __get__(self, instance, owner):
+        return self.getter(owner)
+
+
 def log(cls):
     """Decorator for attaching a logger to the class `cls`
 
@@ -207,3 +215,35 @@ def _resolve_name(name, package, level):
     __import__(name)
 
     return sys.modules[name]
+
+
+def where(program):
+    r"""Parse PATH for executables
+
+    Windows note:
+        PATHEXT yields possible suffixes, such as .exe, .bat and .cmd
+
+    Usage:
+        >> where("python")
+        'c:\\python27\\python.exe'
+
+    """
+
+    suffixes = [""]
+
+    try:
+        # Append Windows suffixes, such as .exe, .bat and .cmd
+        suffixes.extend(os.environ.get("PATHEXT").split(os.pathsep))
+    except:
+        pass
+
+    for path in os.environ["PATH"].split(os.pathsep):
+
+        # A path may be empty.
+        if not path:
+            continue
+
+        for suffix in suffixes:
+            full_path = os.path.join(path, program + suffix)
+            if os.path.isfile(full_path):
+                return full_path

pyblish/plugin.py

@@ -152,6 +152,10 @@ def __str__(self):
     def __repr__(self):
         return u"%s.%s(%r)" % (__name__, type(self).__name__, self.__str__())
 
+    @pyblish.lib.classproperty
+    def id(cls):
+        return cls.__name__
+
     def process(self, context, instances=None):
         """Perform processing upon context `context`
 
@@ -273,6 +277,34 @@ def process_instance(self, instance):
 
         """
 
+    def repair_instance(self, instance):
+        """Repair given `instance`
+
+        Implement this method in your subclasses in order for
+        the given instance to be repaired.
+
+        Returns:
+            None
+
+        Raises:
+            Any error
+
+        """
+
+    def repair_context(self, context):
+        """Repair given `context`
+
+        Implement this method in your subclasses in order for
+        the context to be repaired.
+
+        Returns:
+            None
+
+        Raises:
+            Any error
+
+        """
+
     def process_all(self, context):
         """Convenience method of the above :meth:`process`
 
@@ -567,6 +599,10 @@ def __repr__(self):
     def __str__(self):
         return self.name
 
+    @property
+    def id(self):
+        return self.name
+
     def __init__(self, name, parent=None):
         super(Instance, self).__init__()
         assert isinstance(name, basestring)

pyblish/tests/plugins/full/validate_instances.py

@@ -3,7 +3,7 @@
 
 
 @pyblish.api.log
-class ValidateInstance(pyblish.api.Validator):
+class ValidateInstances(pyblish.api.Validator):
     hosts = ['python']
     families = ['full']
     version = (0, 1, 0)

pyblish/tests/test_lib.py

@@ -0,0 +1,10 @@
+import sys
+import pyblish.lib
+
+from pyblish.vendor.nose.tools import *
+
+
+def test_where():
+    """lib.where works fine"""
+    exe = pyblish.lib.where("python")
+    assert_equals(sys.executable.lower(), exe.lower())

pyblish/tests/test_main.py → pyblish/tests/test_util.py

@@ -12,8 +12,14 @@
 @with_setup(setup_full, teardown)
 def test_publish_all(_):
     """publish() calls upon each convenience function"""
-    ctx = pyblish.plugin.Context()
-    pyblish.util.publish(context=ctx)
+    plugins = pyblish.plugin.discover()
+
+    assert "ConformInstances" in [p.__name__ for p in plugins]
+    assert "SelectInstances" in [p.__name__ for p in plugins]
+    assert "ValidateInstances" in [p.__name__ for p in plugins]
+    assert "ExtractInstances" in [p.__name__ for p in plugins]
+
+    ctx = pyblish.util.publish()
 
     for inst in ctx:
         assert inst.data('selected') is True

pyblish/util.py

@@ -49,7 +49,8 @@
            'extract',
            'conform',
            'publish',
-           'publish_all']
+           'publish_all',
+           'validate_all']
 
 
 def publish(context=None,

pyblish/version.py

@@ -1,7 +1,7 @@
 
 VERSION_MAJOR = 1
 VERSION_MINOR = 0
-VERSION_PATCH = 14
+VERSION_PATCH = 15
 
 version_info = (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
 version = '%i.%i.%i' % version_info