Rename to dryrun, add docstring and doctest

.circleci/config.yml

@@ -56,7 +56,7 @@ jobs:
       - run:
           name: test
           command: |
-            pytest test -v -k firefox
+            pytest test pyodide_build -v -k firefox
 
   test-chrome:
     <<: *defaults
@@ -67,7 +67,7 @@ jobs:
       - run:
           name: test
           command: |
-            pytest test -v -k chrome
+            pytest test pyodide_build -v -k chrome
 
   test-python:
     <<: *defaults
@@ -80,7 +80,7 @@ jobs:
       - run:
           name: test
           command: |
-            pytest test -v -k 'not (chrome or firefox)' --cov=pyodide_build --cov=pyodide
+            pytest test pyodide_build -v -k 'not (chrome or firefox)' --cov=pyodide_build --cov=pyodide
 
   benchmark:
     <<: *defaults

pyodide_build/pywasmcross.py

@@ -105,7 +105,29 @@ def capture_compile(args):
         sys.exit(result.returncode)
 
 
-def handle_command(line, args, pretend=False):
+def handle_command(line, args, dryrun=False):
+    """Handle a compilation command
+
+    Parameters
+    ----------
+    line : iterable
+       an iterable with the compilation arguments
+    args : {object, namedtuple}
+       an container with additional compilation options,
+       in particular containing ``args.cflags`` and ``args.ldflags``
+    dryrun : bool, default=False
+       if True do not run the resulting command, only return it
+
+    Examples
+    --------
+
+    >>> from collections import namedtuple
+    >>> Args = namedtuple('args', ['cflags', 'ldflags'])
+    >>> args = Args(cflags='', ldflags='')
+    >>> handle_command(['gcc', 'test.c'], args, dryrun=True)
+    emcc test.c
+    ['emcc', 'test.c']
+    """
     # This is a special case to skip the compilation tests in numpy that aren't
     # actually part of the build
     for arg in line:
@@ -156,7 +178,7 @@ def handle_command(line, args, pretend=False):
 
     print(' '.join(new_args))
 
-    if not pretend:
+    if not dryrun:
         result = subprocess.run(new_args)
         if result.returncode != 0:
             sys.exit(result.returncode)
@@ -170,7 +192,7 @@ def handle_command(line, args, pretend=False):
             if renamed.endswith(ext):
                 renamed = renamed[:-len(ext)] + '.so'
                 break
-        if not pretend:
+        if not dryrun:
             os.rename(output, renamed)
     return new_args
 

setup.cfg

@@ -2,3 +2,4 @@
 addopts =
     -r sxX
     --instafail
+    --doctest-modules

test/pyodide_build/test_pywasmcross.py

@@ -11,11 +11,11 @@ def _args_wrapper(func):
     """Convert function to take as input / return a string instead of a
     list of arguments
 
-    Also sets pretend=True
+    Also sets dryrun=True
     """
     def _inner(line, *pargs):
         args = line.split()
-        res = func(args, *pargs, pretend=True)
+        res = func(args, *pargs, dryrun=True)
         if hasattr(res, '__len__'):
             return ' '.join(res)
         else: