pyperf 2.6.3__tar.gz → 2.7.0__tar.gz

{pyperf-2.6.3/pyperf.egg-info → pyperf-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyperf
-Version: 2.6.3
+Version: 2.7.0
 Summary: Python module to run and analyze benchmarks
 Author-email: Victor Stinner <vstinner@redhat.com>
 Maintainer-email: Dong-hee Na <donghee.na@python.org>

{pyperf-2.6.3 → pyperf-2.7.0}/doc/analyze.rst

@@ -223,9 +223,15 @@ two-sample, two-tailed t-test
 
 Render a table using ``--table`` option::
 
-    $ python3 -m pyperf compare_to py36.json py38.json --table
-    +-----------+---------+------------------------------+
-    | Benchmark | py36    | py38                         |
-    +===========+=========+==============================+
-    | timeit    | 4.70 us | 4.22 us: 1.11x faster (-10%) |
-    +-----------+---------+------------------------------+
+    $ python3 -m pyperf compare_to mult_list_py36.json mult_list_py38.json --table
+    +----------------+----------------+-----------------------+
+    | Benchmark      | mult_list_py36 | mult_list_py38        |
+    +================+================+=======================+
+    | [1,2]*1000     | 3.70 us        | 3.18 us: 1.16x faster |
+    +----------------+----------------+-----------------------+
+    | [1,2,3]*1000   | 4.61 us        | 4.17 us: 1.11x faster |
+    +----------------+----------------+-----------------------+
+    | Geometric mean | (ref)          | 1.09x faster          |
+    +----------------+----------------+-----------------------+
+
+    Benchmark hidden because not significant (1): [1]*1000

{pyperf-2.6.3 → pyperf-2.7.0}/doc/api.rst

@@ -679,7 +679,7 @@ Benchmark:
 * ``inner_loops`` (``int >= 1``): number of inner-loops of the benchmark (``int``)
 * ``timer``: Implementation of ``time.perf_counter()``, and also resolution if
   available
-* ``tags``: (list of str, optional): A list of tags associated with the benchmark. If provided, the results output will be aggreggated by each tag.
+* ``tags``: (list of str, optional): A list of tags associated with the benchmark. If provided, the results output will be aggregated by each tag.
 
 Python metadata:
 

{pyperf-2.6.3 → pyperf-2.7.0}/doc/changelog.rst

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+Version 2.7.0 (2024-05-18)
+---------------------------
+
+* Fix logic in MSR availability test.
+  Patch by Mike Droettboom.
+* Disable tuning TurboBoost setting on non-Intel device.
+  Patch by Mike Droettboom.
+* Include CONFIG_ARGS in Metadata.
+  Patch by Jeff Glass.
+* Support environment variables PYTHON_GIL / PYTHON_CPU_COUNT.
+  Patch by Donghee Na.
+
 Version 2.6.3 (2024-03-05)
 ---------------------------
 
@@ -88,7 +100,7 @@ Version 2.1.0 (2021-01-14)
 * The :ref:`compare_to command <compare_to_cmd>` no longer displays
   percentages: display less numbers to make the output easier to read. Also,
   percentage were almost the same values than the xxx faster or xxx slower
-  values, but rounded differenly which introduced confusion.
+  values, but rounded differently which introduced confusion.
 * Project moved to https://github.com/psf/pyperf/
 * system command now only emits a warning rather than failing with a hard error
   if it fails to get or set the frequency of a CPU.

{pyperf-2.6.3 → pyperf-2.7.0}/doc/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # pyperf documentation build configuration file, created by
 # sphinx-quickstart on Wed Jun  1 15:28:03 2016.
@@ -42,16 +41,16 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'pyperf'
-copyright = u'2016, Victor Stinner'
-author = u'Victor Stinner'
+project = 'pyperf'
+copyright = '2016, Victor Stinner'
+author = 'Victor Stinner'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = release = '2.6.3'
+version = release = '2.7.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -216,8 +215,8 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'pyperf.tex', u'pyperf Documentation',
-   u'Victor Stinner', 'manual'),
+  (master_doc, 'pyperf.tex', 'pyperf Documentation',
+   'Victor Stinner', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -246,7 +245,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'pyperf', u'pyperf Documentation',
+    (master_doc, 'pyperf', 'pyperf Documentation',
      [author], 1)
 ]
 
@@ -260,7 +259,7 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'pyperf', u'pyperf Documentation',
+  (master_doc, 'pyperf', 'pyperf Documentation',
    author, 'pyperf', 'One line description of project.',
    'Miscellaneous'),
 ]

{pyperf-2.6.3 → pyperf-2.7.0}/doc/examples.rst

@@ -31,8 +31,9 @@ bench_async_func() method
 timeit() method
 ---------------
 
-Benchmark using the :meth:`Runner.timeit` method to performance of sorting a
-sorted list of 1000 numbers using a ``key`` function (which does nothing):
+Benchmark using the :meth:`Runner.timeit` method to measure the performance of
+sorting a sorted list of 1000 numbers using a ``key`` function (which does
+nothing):
 
 .. literalinclude:: examples/bench_timeit.py
 

{pyperf-2.6.3 → pyperf-2.7.0}/doc/index.rst

@@ -4,7 +4,7 @@ Python pyperf module
 
 The Python ``pyperf`` module is a toolkit to write, run and analyze benchmarks.
 
-Documenation:
+Documentation:
 
 .. toctree::
    :maxdepth: 2

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/__init__.py

@@ -1,6 +1,6 @@
 from time import perf_counter
 
-VERSION = (2, 6, 3)
+VERSION = (2, 7, 0)
 __version__ = '.'.join(map(str, VERSION))
 
 # Export pyperf.perf_counter for backward compatibility with pyperf 1.7

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_bench.py

@@ -86,7 +86,7 @@ def _cached_attr(func):
     return method
 
 
-class Run(object):
+class Run:
     # Run is immutable, so it can be shared/exchanged between two benchmarks
 
     __slots__ = ('_warmups', '_values', '_metadata')
@@ -319,7 +319,7 @@ class Run(object):
         return self._replace(metadata=metadata2)
 
 
-class Benchmark(object):
+class Benchmark:
     def __init__(self, runs):
         self._runs = []   # list of Run objects
         self._clear_runs_cache()
@@ -627,7 +627,7 @@ class Benchmark(object):
         self._replace_runs(new_runs)
 
 
-class BenchmarkSuite(object):
+class BenchmarkSuite:
     def __init__(self, benchmarks, filename=None):
         if not benchmarks:
             raise ValueError("benchmarks must be a non-empty "
@@ -727,7 +727,7 @@ class BenchmarkSuite(object):
         if isinstance(filename, bytes):
             suffix = b'.gz'
         else:
-            suffix = u'.gz'
+            suffix = '.gz'
 
         if filename.endswith(suffix):
             # Use lazy import to limit imports on 'import pyperf'
@@ -770,7 +770,7 @@ class BenchmarkSuite(object):
         if isinstance(filename, bytes):
             suffix = b'.gz'
         else:
-            suffix = u'.gz'
+            suffix = '.gz'
 
         if not replace and os.path.exists(filename):
             raise OSError(errno.EEXIST, "File already exists")

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_cli.py

@@ -604,7 +604,7 @@ def catch_broken_pipe_error(file=None):
         # was closed by the consumer
         for file in files:
             file.flush()
-    except IOError as exc:
+    except OSError as exc:
         if exc.errno != errno.EPIPE:
             raise
         # got a broken pipe error: ignore it
@@ -615,5 +615,5 @@ def catch_broken_pipe_error(file=None):
         for file in files:
             try:
                 file.close()
-            except IOError:
+            except OSError:
                 pass

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_collect_metadata.py

@@ -111,6 +111,11 @@ def collect_python_metadata(metadata):
             cflags = normalize_text(cflags)
             metadata['python_cflags'] = cflags
 
+        config_args = sysconfig.get_config_var('CONFIG_ARGS')
+        if config_args:
+            config_args = normalize_text(config_args)
+            metadata['python_config_args'] = config_args
+
     # GC disabled?
     try:
         import gc
@@ -131,7 +136,7 @@ def read_proc(path):
         with open_text(path) as fp:
             for line in fp:
                 yield line.rstrip()
-    except (OSError, IOError):
+    except OSError:
         return
 
 
@@ -327,7 +332,7 @@ def get_cpu_temperature(path, cpu_temp):
 
         try:
             temp_label = read_first_line(template % 'label', error=True)
-        except IOError:
+        except OSError:
             break
 
         temp_input = read_first_line(template % 'input', error=True)

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_compare.py

@@ -53,7 +53,7 @@ def get_tags_for_result(result):
     return result.ref.benchmark.get_metadata().get("tags", [])
 
 
-class CompareResult(object):
+class CompareResult:
     def __init__(self, ref, changed, min_speed=None):
         # CompareData object
         self.ref = ref

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_linux_memory.py

@@ -54,7 +54,7 @@ def check_tracking_memory():
     mem_thread = PeakMemoryUsageThread()
     try:
         mem_thread.get()
-    except IOError as exc:
+    except OSError as exc:
         path = proc_path("self/smaps")
         return "unable to read %s: %s" % (path, exc)
 

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_manager.py

@@ -12,7 +12,7 @@ from pyperf._utils import MS_WINDOWS, create_environ, create_pipe, popen_killer
 MAX_CALIBRATION = 5
 
 
-class Manager(object):
+class Manager:
     """
     Manager process which spawns worker processes to:
     - calibrate warmups

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_metadata.py

@@ -137,7 +137,7 @@ def format_metadata(name, value):
     return info.formatter(value)
 
 
-class Metadata(object):
+class Metadata:
     def __init__(self, name, value):
         self._name = name
         self._value = value

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_runner.py

@@ -69,7 +69,7 @@ class CLIError(Exception):
 class Runner:
     _created = set()
 
-    # Default parameters are chosen to have approximatively a run of 0.5 second
+    # Default parameters are chosen to have approximately a run of 0.5 second
     # and so a total duration of 5 seconds by default
     def __init__(self, values=None, processes=None,
                  loops=0, min_time=0.1, metadata=None,
@@ -85,7 +85,7 @@ class Runner:
             pass
 
         # Watchdog: ensure that only once instance of Runner (or a Runner
-        # subclass) is created per process to prevent bad suprises
+        # subclass) is created per process to prevent bad surprises
         cls = self.__class__
         key = id(cls)
         if key in cls._created:

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_system.py

@@ -1,5 +1,6 @@
 import errno
 import os.path
+import platform
 import re
 import struct
 import subprocess
@@ -74,7 +75,7 @@ def use_intel_pstate():
     return (scaling_driver == 'intel_pstate')
 
 
-class Operation(object):
+class Operation:
     @staticmethod
     def available():
         return True
@@ -107,7 +108,7 @@ class Operation(object):
     def read_first_line(self, path):
         try:
             return read_first_line(path, error=True)
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             return ''
 
@@ -125,7 +126,11 @@ class TurboBoostMSR(Operation):
 
     @staticmethod
     def available():
-        return (OS_LINUX and not use_intel_pstate())
+        return (
+            OS_LINUX and 
+            not use_intel_pstate() and 
+            platform.machine() in ('x86', 'x86_64', 'amd64')
+        )
 
     def __init__(self, system):
         Operation.__init__(self, 'Turbo Boost (MSR)', system)
@@ -219,7 +224,7 @@ class TurboBoostMSR(Operation):
                     os.write(fd, data)
             finally:
                 os.close(fd)
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             self.error("Failed to write %#x into MSR %#x using %s: %s"
                        % (value, reg_num, path, exc))
@@ -308,7 +313,7 @@ class TurboBoostIntelPstate(Operation):
         content = '0' if enable else '1'
         try:
             write_text(self.path, content)
-        except IOError as exc:
+        except OSError as exc:
             # don't log a permission error if the user is root: permission
             # error as root means that Turbo Boost is disabled in the BIOS
             if not is_root():
@@ -376,7 +381,7 @@ class CPUGovernorIntelPstate(Operation):
             return
         try:
             write_text(self.path, new_governor)
-        except IOError as exc:
+        except OSError as exc:
             self.error("Failed to set the CPU scaling governor: %s" % exc)
         else:
             self.log_action("CPU scaling governor set to %s" % new_governor)
@@ -384,7 +389,7 @@ class CPUGovernorIntelPstate(Operation):
 
 class LinuxScheduler(Operation):
     """
-    Check isolcpus=cpus and rcu_nocbs=cpus paramaters of the Linux kernel
+    Check isolcpus=cpus and rcu_nocbs=cpus parameters of the Linux kernel
     command line.
     """
 
@@ -495,7 +500,7 @@ class ASLR(Operation):
 
         try:
             write_text(self.path, new_value)
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             self.error("Failed to write into %s: %s" % (self.path, exc))
         else:
@@ -552,7 +557,7 @@ class CPUFrequency(Operation):
         try:
             with open(filename, "rb") as fp:
                 return fp.readline()
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             return None
 
@@ -579,7 +584,7 @@ class CPUFrequency(Operation):
         filename = os.path.join(cpu_path, "scaling_min_freq")
         try:
             return self.write_freq(filename, freq)
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             self.error("Unable to write scaling_max_freq of CPU %s: %s"
                        % (cpu, exc))
@@ -768,7 +773,7 @@ class IRQAffinity(Operation):
         mask = format_cpus_as_mask(new_affinity)
         try:
             write_text(self.default_affinity_path, mask)
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             self.error("Failed to write %r into %s: %s"
                        % (mask, self.default_affinity_path, exc))
@@ -782,7 +787,7 @@ class IRQAffinity(Operation):
         try:
             write_text(path, mask)
             return True
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             # EIO means that the IRQ doesn't support SMP affinity:
             # ignore the error
@@ -937,7 +942,7 @@ class PerfEvent(Operation):
 
         try:
             write_text(self.path, str(new_rate))
-        except IOError as exc:
+        except OSError as exc:
             self.check_permission_error(exc)
             self.error("Failed to write into %s: %s" % (self.path, exc))
         else:

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_utils.py

@@ -155,7 +155,7 @@ def read_first_line(path, error=False):
         with open_text(path) as fp:
             line = fp.readline()
         return line.rstrip()
-    except IOError:
+    except OSError:
         if error:
             raise
         else:
@@ -266,8 +266,9 @@ def create_environ(inherit_environ, locale, copy_all):
     if copy_all:
         return os.environ
     env = {}
-
-    copy_env = ["PATH", "PYTHONPATH", "HOME", "TEMP", "COMSPEC", "SystemRoot", "SystemDrive"]
+    copy_env = ["PATH", "HOME", "TEMP", "COMSPEC", "SystemRoot", "SystemDrive",
+                # Python specific variables
+                "PYTHONPATH", "PYTHON_CPU_COUNT", "PYTHON_GIL"]
     if locale:
         copy_env.extend(('LANG', 'LC_ADDRESS', 'LC_ALL', 'LC_COLLATE',
                          'LC_CTYPE', 'LC_IDENTIFICATION', 'LC_MEASUREMENT',
@@ -282,7 +283,7 @@ def create_environ(inherit_environ, locale, copy_all):
     return env
 
 
-class _Pipe(object):
+class _Pipe:
     _OPEN_MODE = "r"
 
     def __init__(self, fd):

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/_worker.py

@@ -288,7 +288,7 @@ class WorkerTask:
         else:
             self.compute_warmups_values()
 
-        # collect metatadata
+        # collect metadata
         metadata2 = self.collect_metadata()
         metadata2.update(self.metadata)
         self.metadata = metadata2

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/tests/__init__.py

@@ -55,7 +55,7 @@ def temporary_directory():
 def benchmark_as_json(benchmark, compact=True):
     with temporary_file() as tmp_name:
         benchmark.dump(tmp_name, compact=compact)
-        with io.open(tmp_name, 'r', encoding='utf-8') as tmp:
+        with open(tmp_name, 'r', encoding='utf-8') as tmp:
             return tmp.read()
 
 

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/tests/replay.py

@@ -14,7 +14,7 @@ def get_raw_values(filename, run_id):
     return (run, raw_values)
 
 
-class Replay(object):
+class Replay:
     def __init__(self, runner, filename):
         self.runner = runner
         self.args = runner.args

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/tests/test_metadata.py

@@ -159,7 +159,7 @@ class CpuFunctionsTests(unittest.TestCase):
             elif filename.startswith('/sys/devices/system/cpu/nohz_full'):
                 data = nohz_full
             elif filename.startswith('/sys/devices/system/cpu/cpu2'):
-                raise IOError
+                raise OSError
             elif filename == '/sys/devices/system/cpu/cpuidle/current_driver':
                 data = 'IDLE_DRV\n'
             else:
@@ -194,7 +194,7 @@ class CpuFunctionsTests(unittest.TestCase):
             elif filename == '/sys/devices/system/cpu/cpu0/cpufreq/scaling_governor':
                 data = 'GOVERNOR\n'
             elif filename.startswith('/sys/devices/system/cpu/cpu2'):
-                raise IOError
+                raise OSError
             else:
                 raise ValueError("unexpect open: %r" % filename)
             return io.StringIO(data)

{pyperf-2.6.3 → pyperf-2.7.0}/pyperf/tests/test_perf_cli.py

@@ -11,7 +11,7 @@ TESTDIR = os.path.dirname(__file__)
 TELCO = os.path.join(TESTDIR, 'telco.json')
 
 
-class BaseTestCase(object):
+class BaseTestCase:
     maxDiff = 100 * 80
 
     def create_bench(self, values, metadata=None):

{pyperf-2.6.3 → pyperf-2.7.0/pyperf.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyperf
-Version: 2.6.3
+Version: 2.7.0
 Summary: Python module to run and analyze benchmarks
 Author-email: Victor Stinner <vstinner@redhat.com>
 Maintainer-email: Dong-hee Na <donghee.na@python.org>

{pyperf-2.6.3 → pyperf-2.7.0}/pyproject.toml

@@ -61,3 +61,10 @@ packages = ["pyperf", "pyperf.tests"]
 
 [tool.setuptools.dynamic]
 version = {attr = "pyperf.__version__"}
+
+[tool.ruff.lint]
+extend-select = ["C90", "UP"]
+extend-ignore = ["UP015", "UP031"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 31

{pyperf-2.6.3 → pyperf-2.7.0}/tox.ini

@@ -13,18 +13,12 @@ basepython = python3
 [testenv:doc]
 basepython = python3
 deps = sphinx
-whitelist_externals = make
+allowlist_externals = make
 commands=
     make -C doc html
 
 [testenv:pep8]
 basepython = python3
-deps = flake8
+deps = ruff
 commands =
-    flake8 pyperf setup.py doc/examples/
-
-[flake8]
-# E501 line too long (88 > 79 characters)
-# F812 list comprehension redefines 'loops' from line 56
-# W503 line break before binary operator
-ignore = E501,F812,W503
+    ruff check