rename rc -> completed (#235)

* rename rc -> completed

Also, don't check if check_call returns None. It never does.

* return rc from _undo_develop

* document return type

* use completed for returned value

Co-authored-by: Dirk Thomas <[email protected]>

Author: rotu

colcon_core/subprocess.py

@@ -66,6 +66,7 @@ async def run(
     :param shell: whether to use the shell as the program to execute
     :param use_pty: whether to use a pseudo terminal
     :returns: the result of the completed process
+    :rtype subprocess.CompletedProcess
     """
     assert callable(stdout_callback) or stdout_callback is None
     assert callable(stderr_callback) or stderr_callback is None

colcon_core/task/__init__.py

@@ -135,6 +135,7 @@ async def check_call(
     :param shell: whether to use the shell as the program to execute
     :param use_pty: whether to use a pseudo terminal
     :returns: the result of the completed process
+    :rtype subprocess.CompletedProcess
     """
     def stdout_callback(line):
         context.put_event_into_queue(StdoutLine(line))
@@ -144,13 +145,14 @@ def stderr_callback(line):
 
     context.put_event_into_queue(
         Command(cmd, cwd=cwd, env=env, shell=shell))
-    rc = await run(
+    completed = await run(
         cmd, stdout_callback, stderr_callback,
         cwd=cwd, env=env, shell=shell, use_pty=use_pty)
     context.put_event_into_queue(
         CommandEnded(
-            cmd, cwd=cwd, env=env, shell=shell, returncode=rc.returncode))
-    return rc
+            cmd, cwd=cwd, env=env, shell=shell,
+            returncode=completed.returncode))
+    return completed
 
 
 def get_task_extensions(task_name, *, unique_instance=False):

colcon_core/task/python/build.py

@@ -57,8 +57,8 @@ async def build(self, *, additional_hooks=None):  # noqa: D102
 
         if not args.symlink_install:
             rc = await self._undo_develop(pkg, args, env)
-            if rc and rc.returncode:
-                return rc.returncode
+            if rc:
+                return rc
 
             # invoke `setup.py install` step with lots of arguments
             # to avoid placing any files in the source space
@@ -73,9 +73,10 @@ async def build(self, *, additional_hooks=None):  # noqa: D102
                 '--single-version-externally-managed',
             ]
             self._append_install_layout(args, cmd)
-            rc = await check_call(self.context, cmd, cwd=args.path, env=env)
-            if rc and rc.returncode:
-                return rc.returncode
+            completed = await check_call(
+                self.context, cmd, cwd=args.path, env=env)
+            if completed.returncode:
+                return completed.returncode
 
         else:
             self._undo_install(pkg, args, setup_py_data, python_lib)
@@ -96,10 +97,10 @@ async def build(self, *, additional_hooks=None):  # noqa: D102
             if setup_py_data.get('data_files'):
                 cmd += ['install_data', '--install-dir', args.install_base]
             self._append_install_layout(args, cmd)
-            rc = await check_call(
+            completed = await check_call(
                 self.context, cmd, cwd=args.build_base, env=env)
-            if rc and rc.returncode:
-                return rc.returncode
+            if completed.returncode:
+                return completed.returncode
 
             # explicitly add the build directory to the PYTHONPATH
             # to maintain the desired order
@@ -131,10 +132,9 @@ async def _undo_develop(self, pkg, args, env):
                 '--uninstall', '--editable',
                 '--build-directory', os.path.join(args.build_base, 'build')
             ]
-            rc = await check_call(
+            completed = await check_call(
                 self.context, cmd, cwd=args.build_base, env=env)
-            if rc:
-                return rc
+            return completed.returncode
 
     def _undo_install(self, pkg, args, setup_py_data, python_lib):
         # undo previous install if install.log is found

colcon_core/task/python/test/pytest.py

@@ -156,7 +156,8 @@ async def step(self, context, env, setup_py_data):  # noqa: D102
 </testsuite>
 """.format_map(locals()))  # noqa: E501
 
-        rc = await check_call(context, cmd, cwd=context.args.path, env=env)
+        completed = await check_call(
+            context, cmd, cwd=context.args.path, env=env)
 
         # use local import to avoid a dependency on pytest
         try:
@@ -166,7 +167,7 @@ async def step(self, context, env, setup_py_data):  # noqa: D102
             # support pytest < 5.0
             from _pytest.main import EXIT_TESTSFAILED
             EXIT_CODE_TESTS_FAILED = EXIT_TESTSFAILED  # noqa: N806
-        if rc and rc.returncode == EXIT_CODE_TESTS_FAILED:
+        if completed.returncode == EXIT_CODE_TESTS_FAILED:
             context.put_event_into_queue(
                 TestFailure(context.pkg.name))
 
@@ -177,7 +178,7 @@ async def step(self, context, env, setup_py_data):  # noqa: D102
             # support pytest < 5.0
             from _pytest.main import EXIT_NOTESTSCOLLECTED
             EXIT_CODE_NO_TESTS = EXIT_NOTESTSCOLLECTED  # noqa: N806
-        if rc and rc.returncode not in (
+        if completed.returncode not in (
             EXIT_CODE_NO_TESTS, EXIT_CODE_TESTS_FAILED
         ):
-            return rc.returncode
+            return completed.returncode

colcon_core/task/python/test/setuppy_test.py

@@ -45,6 +45,6 @@ async def step(self, context, env, setup_py_data):  # noqa: D102
         cmd = [executable, '-m', 'unittest', '-v']
         if context.args.unittest_args is not None:
             cmd += context.args.unittest_args
-        rc = await check_call(context, cmd, cwd=context.args.path, env=env)
-        if rc and rc.returncode:
-            return rc.returncode
+        completed = await check_call(
+            context, cmd, cwd=context.args.path, env=env)
+        return completed.returncode