timerit 1.1.0__tar.gz → 1.2.0__tar.gz

timerit-1.2.0/MANIFEST.in

@@ -0,0 +1 @@
+include requirements/*.txt

{timerit-1.1.0/timerit.egg-info → timerit-1.2.0}/PKG-INFO

@@ -1,33 +1,43 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: timerit
-Version: 1.1.0
+Version: 1.2.0
 Summary: A powerful multiline alternative to timeit
-Home-page: https://github.com/Erotemic/timerit
-Author: Jon Crall
-Author-email: erotemic@gmail.com
-License: Apache 2
-Platform: UNKNOWN
+Author-email: Jon Crall <erotemic@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Erotemic/timerit
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
+License-File: LICENSE
 Provides-Extra: all
-Provides-Extra: all-strict
+Requires-Dist: pandas; extra == "all"
+Requires-Dist: kwplot; extra == "all"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0.1; extra == "docs"
+Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=1.0.0; extra == "docs"
+Requires-Dist: sphinxcontrib-napoleon>=0.7; extra == "docs"
+Requires-Dist: sphinx-autoapi>=1.8.4; extra == "docs"
+Requires-Dist: Pygments>=2.9.0; extra == "docs"
+Requires-Dist: myst_parser>=0.18.0; extra == "docs"
+Requires-Dist: sphinx-reredirects>=0.0.1; extra == "docs"
 Provides-Extra: optional
-Provides-Extra: optional-strict
-Provides-Extra: runtime-strict
+Requires-Dist: pandas; extra == "optional"
+Requires-Dist: kwplot; extra == "optional"
 Provides-Extra: tests
-Provides-Extra: tests-strict
-License-File: LICENSE
+Requires-Dist: xdoctest>=1.1.0; extra == "tests"
+Requires-Dist: pytest>=6.2.5; extra == "tests"
+Requires-Dist: pytest-cov>=3.0.0; extra == "tests"
+Dynamic: license-file
 
 
 |GithubActions| |Appveyor| |Codecov| |Pypi| |Downloads| |ReadTheDocs|
@@ -36,7 +46,7 @@ License-File: LICENSE
 Timerit
 =======
 
-A powerful multiline alternative to Python's builtin ``timeit`` module.
+A powerful multiline alternative to Python's builtin `timeit <https://docs.python.org/3/library/timeit.html>`_ module.
 
 Docs are published at https://timerit.readthedocs.io/en/latest/ but this README
 and code comments contain a walkthrough.
@@ -97,7 +107,7 @@ Here's what each of the numbers means:
   that you can get slow times if the something in the background is consuming
   resources, so you're generally only interested in the fastest times.  This
   idea is also described in the
-  `timeit <https://docs.python.org/3/library/timeit.html#timeit.Timer.repeat>`_ docs.
+  `timeit docs <https://docs.python.org/3/library/timeit.html#timeit.Timer.repeat>`_.
 
 - "best=616.740 µs": How long the fastest iteration took to run.  For the reasons
   described above, this is usually the most consistent number, and the primary
@@ -310,6 +320,16 @@ Benchmark Recipe
         ax.set_ylabel('y-variable description')
 
 
+Related Work
+============
+
+* `timeit <https://docs.python.org/3/library/timeit.html>`_: The builtin timeit module for profiling single statements.
+
+* `line_profiler <https://github.com/pyutils/line_profiler>`_: Line-by-line profiling.
+
+* `ubelt <https://github.com/Erotemic/ubelt>`_: This library was original developed as a component of ubelt, but has since become a standalone module.
+
+
 .. |Travis| image:: https://img.shields.io/travis/Erotemic/timerit/master.svg?label=Travis%20CI
    :target: https://travis-ci.org/Erotemic/timerit?branch=master
 .. |Codecov| image:: https://codecov.io/github/Erotemic/timerit/badge.svg?branch=master&service=github
@@ -331,5 +351,3 @@ Benchmark Recipe
 
 .. _PYTHONSTARTUP: https://docs.python.org/3/using/cmdline.html?highlight=pythonstartup#envvar-PYTHONSTARTUP
 
-
-

{timerit-1.1.0 → timerit-1.2.0}/README.rst

@@ -5,7 +5,7 @@
 Timerit
 =======
 
-A powerful multiline alternative to Python's builtin ``timeit`` module.
+A powerful multiline alternative to Python's builtin `timeit <https://docs.python.org/3/library/timeit.html>`_ module.
 
 Docs are published at https://timerit.readthedocs.io/en/latest/ but this README
 and code comments contain a walkthrough.
@@ -66,7 +66,7 @@ Here's what each of the numbers means:
   that you can get slow times if the something in the background is consuming
   resources, so you're generally only interested in the fastest times.  This
   idea is also described in the
-  `timeit <https://docs.python.org/3/library/timeit.html#timeit.Timer.repeat>`_ docs.
+  `timeit docs <https://docs.python.org/3/library/timeit.html#timeit.Timer.repeat>`_.
 
 - "best=616.740 µs": How long the fastest iteration took to run.  For the reasons
   described above, this is usually the most consistent number, and the primary
@@ -279,6 +279,16 @@ Benchmark Recipe
         ax.set_ylabel('y-variable description')
 
 
+Related Work
+============
+
+* `timeit <https://docs.python.org/3/library/timeit.html>`_: The builtin timeit module for profiling single statements.
+
+* `line_profiler <https://github.com/pyutils/line_profiler>`_: Line-by-line profiling.
+
+* `ubelt <https://github.com/Erotemic/ubelt>`_: This library was original developed as a component of ubelt, but has since become a standalone module.
+
+
 .. |Travis| image:: https://img.shields.io/travis/Erotemic/timerit/master.svg?label=Travis%20CI
    :target: https://travis-ci.org/Erotemic/timerit?branch=master
 .. |Codecov| image:: https://codecov.io/github/Erotemic/timerit/badge.svg?branch=master&service=github

timerit-1.2.0/pyproject.toml

@@ -0,0 +1,135 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+  "setuptools>=41.0.1",
+  "setuptools>=77",
+]
+
+[project]
+name = "timerit"
+description = "A powerful multiline alternative to timeit"
+license = "Apache-2.0"
+license-files = [
+  "LICENSE",
+]
+authors = [ { name = "Jon Crall", email = "erotemic@gmail.com" } ]
+requires-python = ">=3.10"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Utilities",
+]
+dynamic = [
+  "dependencies",
+  "optional-dependencies",
+  "readme",
+  "version",
+]
+urls.Homepage = "https://github.com/Erotemic/timerit"
+
+[tool.setuptools]
+include-package-data = true
+dynamic.dependencies.file = [
+  "requirements/runtime.txt",
+]
+dynamic.optional-dependencies.all.file = [
+  "requirements/optional.txt",
+]
+dynamic.optional-dependencies.docs.file = [
+  "requirements/docs.txt",
+]
+dynamic.optional-dependencies.optional.file = [
+  "requirements/optional.txt",
+]
+dynamic.optional-dependencies.tests.file = [
+  "requirements/tests.txt",
+]
+dynamic.readme.file = [
+  "README.rst",
+]
+dynamic.readme.content-type = "text/x-rst"
+dynamic.version.attr = "timerit.__version__"
+package-data."*" = [
+  "requirements/*.txt",
+]
+package-data.timerit = [
+  "py.typed",
+]
+packages.find.where = [
+  ".",
+]
+packages.find.include = [
+  "timerit*",
+]
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.pytest]
+ini_options.addopts = "-p no:doctest --xdoctest --xdoctest-style=google --ignore-glob=setup.py --ignore-glob=dev --ignore-glob=docs"
+ini_options.norecursedirs = ".git ignore build __pycache__ dev _skbuild docs"
+ini_options.filterwarnings = [
+  "default",
+  "ignore:.*No cfgstr given in Cacher constructor or call.*:Warning",
+  "ignore:.*Define the __nice__ method for.*:Warning",
+  "ignore:.*private pytest class or function.*:Warning",
+]
+
+[tool.coverage]
+run.branch = true
+report.exclude_lines = [
+  ".*  # nocover",
+  ".*  # pragma: no cover",
+  ".*if six.PY2:",
+  "^ *pass *$",
+  "^ *raise",
+  "def __repr__",
+  "if __name__ == .__main__.:",
+  "if _debug:",
+  "if 0:",
+  "if trace is not None",
+  "pragma: no cover",
+  "raise AssertionError",
+  "raise NotImplementedError",
+  "verbose = .*",
+]
+report.omit = [
+  "*/setup.py",
+  "timerit/__main__.py",
+]
+
+[tool.xcookie]
+tags = [
+  "erotemic",
+  "purepy",
+  "github",
+]
+mod_name = "timerit"
+repo_name = "timerit"
+rel_mod_parent_dpath = "."
+os = [
+  "linux",
+  "osx",
+  "win",
+]
+min_python = "3.10"
+version = "{mod_dpath}/__init__.py::__version__"
+url = "https://github.com/Erotemic/timerit"
+author = "Jon Crall"
+author_email = "erotemic@gmail.com"
+description = "A powerful multiline alternative to timeit"
+license = "Apache 2"
+dev_status = "stable"
+typed = true
+workspace_members = []
+workspace_sync_versions = false
+use_setup_py = false
+use_pyproject_requirements = false
+enable_gpg = true

timerit-1.2.0/requirements/docs.txt

@@ -0,0 +1,8 @@
+sphinx >= 5.0.1
+sphinx-autobuild >= 2021.3.14
+sphinx_rtd_theme >= 1.0.0
+sphinxcontrib-napoleon >= 0.7
+sphinx-autoapi >= 1.8.4
+Pygments >= 2.9.0
+myst_parser >= 0.18.0
+sphinx-reredirects >= 0.0.1

timerit-1.2.0/requirements/optional.txt

@@ -0,0 +1,2 @@
+pandas
+kwplot

timerit-1.2.0/requirements/tests.txt

@@ -0,0 +1,3 @@
+xdoctest >= 1.1.0
+pytest >= 6.2.5
+pytest-cov >= 3.0.0

timerit-1.2.0/tests/test_benchmarker.py

@@ -0,0 +1,164 @@
+from timerit.benchmarker import Benchmarker
+
+
+def test_benchmarker_heterogeneous_signatures_and_adapters():
+    calls = []
+    adapter_calls = []
+
+    bm = Benchmarker(num_trials=2, bestof=1, record_samples=False, verbose=0)
+
+    @bm.register
+    def direct(x):
+        calls.append(('direct', x))
+
+    @bm.register
+    def adapted(value):
+        calls.append(('adapted', value))
+
+    @bm.register_data_adapter(for_method='adapted')
+    def adapt(x):
+        adapter_calls.append(x)
+        return {'value': x + 10}
+
+    bm.set_basis({'x': [1, 2]})
+    bm.run()
+
+    assert calls.count(('direct', 1)) == 2
+    assert calls.count(('direct', 2)) == 2
+    assert calls.count(('adapted', 11)) == 2
+    assert calls.count(('adapted', 12)) == 2
+    assert adapter_calls == [1, 1, 2, 2]
+    assert len(bm.stats) == 4
+    assert len(bm.rows) == 4
+
+
+def test_benchmarker_records_robust_samples():
+    bm = Benchmarker(num_trials=4, bestof=2, record_samples=True, verbose=0)
+
+    @bm.register
+    def method1(n):
+        return n + 1
+
+    @bm.register
+    def method2(n):
+        return n * 2
+
+    bm.set_basis({'n': [1, 2]})
+    bm.run()
+
+    # 2 methods * 2 parameter values * (4 trials / bestof 2)
+    assert len(bm.rows) == 8
+    assert len(bm.stats) == 4
+    assert all('time' in row for row in bm.rows)
+    assert all(row['mean_speedup_vs_slowest'] >= 1 for row in bm.stats)
+    assert all(row['min_speedup_vs_slowest'] >= 1 for row in bm.stats)
+
+
+def test_benchmarker_allows_method_only_benchmark():
+    bm = Benchmarker(num_trials=1, bestof=1, record_samples=False, verbose=0)
+
+    @bm.register
+    def first():
+        pass
+
+    @bm.register
+    def second():
+        pass
+
+    bm.set_basis({})
+    bm.run()
+
+    assert {row['method'] for row in bm.stats} == {'first', 'second'}
+    assert len(bm.stats) == 2
+
+
+def test_benchmarker_run_does_not_require_plot_configuration():
+    bm = Benchmarker(num_trials=1, bestof=1, verbose=0)
+
+    @bm.register
+    def method(n):
+        return n
+
+    bm.set_basis({'n': [1]})
+    result = bm.run()
+    assert result is bm
+
+
+def test_benchmarker_rejects_reserved_basis_name():
+    bm = Benchmarker(verbose=0)
+    try:
+        bm.set_basis({'method': ['foo']})
+    except ValueError:
+        pass
+    else:
+        raise AssertionError('expected method basis name to be reserved')
+
+
+def test_benchmarker_callable_object_requires_or_accepts_name():
+    class CallableMethod:
+        def __call__(self, n):
+            return n
+
+    bm = Benchmarker(num_trials=1, bestof=1, verbose=0)
+    method = CallableMethod()
+
+    try:
+        bm.register(method)
+    except TypeError:
+        pass
+    else:
+        raise AssertionError('unnamed callable object should require name=')
+
+    bm.register(method, name='callable_method')
+    bm.set_basis({'n': [1]})
+    bm.run()
+    assert bm.stats[0]['method'] == 'callable_method'
+
+
+def test_benchmarker_rejects_adapter_for_unknown_method():
+    bm = Benchmarker(num_trials=1, bestof=1, verbose=0)
+
+    @bm.register
+    def known(n):
+        return n
+
+    @bm.register_data_adapter(for_method='typo')
+    def adapter(n):
+        return {'n': n}
+
+    bm.set_basis({'n': [1]})
+    try:
+        bm.run()
+    except KeyError as ex:
+        assert 'typo' in str(ex)
+    else:
+        raise AssertionError('unknown adapter target should be rejected')
+
+
+def test_benchmarker_plot_configuration_can_change_after_run():
+    bm = Benchmarker(num_trials=1, bestof=1, verbose=0)
+
+    @bm.register
+    def first(n):
+        return n
+
+    @bm.register
+    def second(n):
+        return n
+
+    bm.set_basis({'n': [1, 2]})
+    bm.run()
+    bm.set_plot_semantics(x='n', hue='method')
+
+    # Plot metadata is derived from stored statistics after measurement rather
+    # than being baked into the timing rows during run(). This helper requires
+    # pandas, so only check the independence at the plain-data level here.
+    assert all('hue_key' not in row for row in bm.rows)
+    assert all('hue_key' not in row for row in bm.stats)
+
+def test_benchmarker_is_not_top_level_api():
+    import timerit
+
+    assert 'Benchmarker' not in timerit.__all__
+    assert not hasattr(timerit, 'Benchmarker')
+

timerit-1.2.0/tests/test_import.py

@@ -0,0 +1,2 @@
+def test_import():
+    import timerit