Address comments in pull request

Author: mdboom

doc/custom_benchmarks.rst

@@ -324,17 +324,17 @@ All other PEP 621 fields are optional (e.g. ``requires-python = ">=3.8"``,
 The ``[tool.pyperformance]`` Section
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-=============== ===== === === ===
-field           type  R   B   F 
-=============== ===== === === ===
-tool.name       str   X       X
-tool.tags       [str]     X    
-tool.extra_opts [str]     X    
-tool.inherits   file           
-tool.runscript  file      X    
-tool.datadir    file      X    
-tool.setup_py   bool
-=============== ===== === === ===
+================== ===== === === ===
+field              type  R   B   F
+================== ===== === === ===
+tool.name          str   X       X
+tool.tags          [str]     X
+tool.extra_opts    [str]     X
+tool.inherits      file
+tool.runscript     file      X
+tool.datadir       file      X
+tool.install_setup bool
+================== ===== === === ===
 
 "R": required
 "B": inferred from the inherited metadata
@@ -343,5 +343,6 @@ tool.setup_py   bool
 * tags: optional list of names to group benchmarks
 * extra_opts: optional list of args to pass to ``tool.runscript``
 * runscript: the benchmark script to use instead of run_benchmark.py.
-* setup_py: when ``true``, run the setup.py in the benchmark directory to build
-  and install artifacts, such as C extensions
+* install_setup: when ``true`` (default), run ``pip install -e .`` in the
+  benchmark directory to install it in the virtual environment. This has the
+  effect of running a ``setup.py`` file, if present.

pyperformance/_benchmark.py

@@ -165,8 +165,8 @@ def extra_opts(self):
         return self._get_metadata_value('extra_opts', ())
 
     @property
-    def setup_py(self):
-        return self._get_metadata_value('setup_py', False)
+    def install_setup(self):
+        return self._get_metadata_value('install_setup', True)
 
     # Other metadata keys:
     # * base

pyperformance/_benchmark_metadata.py

@@ -32,7 +32,7 @@
     'datadir': None,
     'runscript': None,
     'extra_opts': None,
-    'setup_py': None,
+    'install_setup': None,
 }
 
 
@@ -229,9 +229,9 @@ def _resolve_value(field, value, rootdir):
         for opt in value:
             if not opt or not isinstance(opt, str):
                 raise TypeError(f'extra_opts should be a list of strings, got {value!r}')
-    elif field == 'setup_py':
+    elif field == 'install_setup':
         if not isinstance(value, bool):
-            raise TypeError(f'setup_py should be a bool, got {value!r}')
+            raise TypeError(f'install_setup should be a bool, got {value!r}')
     else:
         raise NotImplementedError(field)
     return value

pyperformance/data-files/benchmarks/bm_ctypes/bm_ctypes_argtypes.toml

@@ -8,5 +8,4 @@ dynamic = ["version"]
 [tool.pyperformance]
 name = "ctypes_argtypes"
 tags = "extension"
-extra_args = "--argtypes"
-setup_py = true
+extra_opts = ["--argtypes"]

pyperformance/data-files/benchmarks/bm_ctypes/pyproject.toml

@@ -7,5 +7,4 @@ dynamic = ["version"]
 
 [tool.pyperformance]
 name = "ctypes"
-tags = "extension"
-setup_py = true
+tags = "extension"

pyperformance/data-files/benchmarks/bm_ctypes/run_benchmark.py

@@ -94,7 +94,7 @@ def benchmark(loops):
     runner = pyperf.Runner()
     runner.metadata["description"] = "ctypes function call overhead benchmark"
 
-    runner.argparser.add_argument("--argtypes")
+    runner.argparser.add_argument("--argtypes", action="store_true")
     options = runner.parse_args()
 
     if options.argtypes:

pyperformance/venv.py

@@ -24,7 +24,7 @@ def from_benchmarks(cls, benchmarks):
         for bench in benchmarks or ():
             filename = bench.requirements_lockfile
             self._add_from_file(filename)
-            if bench.setup_py:
+            if bench.install_setup:
                 self._add(os.path.dirname(bench.metafile))
         return self