Merge pull request #76 from chelloiaco/list-relatives-cmds-behavior

Makes listRelatives behave more like Maya cmds

cmdx.py

@@ -13,6 +13,7 @@
 import collections
 import contextlib
 from functools import wraps
+from itertools import chain
 
 from maya import cmds
 from maya.api import OpenMaya as om, OpenMayaAnim as oma, OpenMayaUI as omui
@@ -7238,16 +7239,17 @@ def listRelatives(node,
     if not isinstance(node, DagNode):
         return None
 
-    elif allDescendents:
-        return list(node.descendents(type=type))
-    elif shapes:
+    if shapes and not parent:
         return list(node.shapes(type=type))
 
-    elif parent:
-        return [node.parent(type=type)]
+    if parent:
+        _parent = node.parent(type=type)
+        return [_parent] if _parent else []
+
+    if allDescendents:
+        return list(node.descendents(type=type))
 
-    elif children:
-        return list(node.children(type=type))
+    return list(chain(node.shapes(type=type), node.children(type=type)))
 
 
 def listConnections(attr):

tests.py

@@ -609,3 +609,57 @@ def undo():
 
 def test_modifier_redo():
     pass
+
+
+def _setup_listrelatives_test():
+    new_scene()
+    cmds.createNode('transform', name='topGrp')
+    cmds.polyCube(name='hierarchyCube', constructionHistory=False)
+    cmds.parent('hierarchyCube', 'topGrp')
+    cmds.createNode('transform', name='botGrp', parent='hierarchyCube')
+    cmds.polyCube(name='worldCube', constructionHistory=False)
+    cmds.blendShape('hierarchyCube', 'worldCube', name='cubeBlend')
+
+
+@with_setup(_setup_listrelatives_test)
+def test_listrelatives_children():
+
+    result_cmdx = cmdx.listRelatives('hierarchyCube', children=True)
+    result_cmdx = [i.name() for i in result_cmdx]
+    result_cmds = cmds.listRelatives('hierarchyCube', children=True)
+
+    assert_equals(result_cmdx, result_cmds)
+
+
+@with_setup(_setup_listrelatives_test)
+def test_listrelatives_alldescendents():
+
+    result_cmdx = cmdx.listRelatives('topGrp', allDescendents=True)
+    result_cmdx = [i.name() for i in result_cmdx]
+    result_cmds = cmds.listRelatives('topGrp', allDescendents=True)
+
+    # cmds has a special result order, so compare sets
+    result_cmdx = set(result_cmdx)
+    result_cmds = set(result_cmds)
+
+    assert_equals(result_cmdx, result_cmds)
+
+
+@with_setup(_setup_listrelatives_test)
+def test_listrelatives_parent():
+
+    result_cmdx = cmdx.listRelatives('hierarchyCubeShape', parent=True)
+    result_cmdx = [i.name() for i in result_cmdx]
+    result_cmds = cmds.listRelatives('hierarchyCubeShape', parent=True)
+
+    assert_equals(result_cmdx, result_cmds)
+
+
+@with_setup(_setup_listrelatives_test)
+def test_listrelatives_shapes():
+
+    result_cmdx = cmdx.listRelatives('worldCube', shapes=True)
+    result_cmdx = [i.name() for i in result_cmdx]
+    result_cmds = cmds.listRelatives('worldCube', shapes=True)
+
+    assert_equals(result_cmdx, result_cmds)