Merge 78be04b into 0d7f8c2

.gitignore

@@ -6,6 +6,7 @@ plum/_version.py
 
 # Virtual environments
 venv
+.tox
 
 # Packaging
 *.egg-info

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+profile = black
+src_paths = plum,tests

.pre-commit-config.yaml

@@ -1,6 +1,20 @@
+default_language_version:
+    python: python3.8
 repos:
   - repo: https://github.com/psf/black
     rev: 22.3.0
     hooks:
       - id: black
-        language_version: python3
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+  - repo: https://github.com/pycqa/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+        args: ["--max-line-length=88", "--extend-ignore=E203,F811"]
+        additional_dependencies:
+          - flake8-bugbear>=22.12
+          - flake8-noqa>=1.3

Makefile

@@ -2,56 +2,11 @@
 
 PACKAGE := plum
 
-docmake:
-	rm -rf docs/source
-	sphinx-apidoc -eMT -o docs/source/ $(PACKAGE)
-	rm docs/source/$(PACKAGE).rst
-	pandoc --from=markdown --to=rst --output=docs/readme.rst README.md
-	cd docs && make html
-
-docopen:
-	open docs/_build/html/index.html
-
-docinit:
-	$(eval BRANCH := $(shell git rev-parse --abbrev-ref HEAD))
-	git checkout -b gh-pages
-	git ls-tree HEAD \
-		| awk '$$4 !~ /\.nojekyll|docs|index\.html/ { print $$4 }' \
-		| xargs -I {} git rm -r {}
-	touch .nojekyll
-	echo '<meta http-equiv="refresh" content="0; url=./docs/_build/html/index.html" />' > index.html
-	git add .nojekyll index.html
-	git commit -m "Branch cleaned for docs"
-	git push origin gh-pages
-	git checkout $(BRANCH)
-
-docremove:
-	git branch -D gh-pages
-	git push origin --delete gh-pages
-
-docupdate: docmake
-	$(eval BRANCH := $(shell git rev-parse --abbrev-ref HEAD))
-	rm -rf docs/_build/html_new
-	mv docs/_build/html docs/_build/html_new
-	git checkout gh-pages
-	rm -rf docs/_build/html
-	mv docs/_build/html_new docs/_build/html
-	git add -f docs/_build/html
-	git commit -m "Update docs at $$(date +'%d %b %Y, %H:%M')"
-	git push origin gh-pages
-	git checkout $(BRANCH)
-
 install:
 	pip install -r requirements.txt
 
 test:
 	python setup.py --version
-	PRAGMA_VERSION=`python -c "import sys; print('.'.join(map(str, sys.version_info[:2])))"` \
-		pytest -v --cov=$(PACKAGE) --cov-report html:cover --cov-report term-missing
-
-clean:
-	rm -rf docs/_build docs/source docs/readme.rst
-	git rm --cached -r docs
-	git add docs/Makefile docs/conf.py docs/index.rst docs/api.rst
-	rm -rf .coverage cover
-	find . | grep '\(\.DS_Store\|\.pyc\)$$' | xargs rm
+	pre-commit run --all-files && sleep 0.2 && \
+		PRAGMA_VERSION=`python -c "import sys; print('.'.join(map(str, sys.version_info[:2])))"` \
+			pytest tests -v --cov=$(PACKAGE) --cov-report html:cover --cov-report term-missing

README.md

@@ -8,6 +8,10 @@
 
 Everybody likes multiple dispatch, just like everybody likes plums.
 
+*Note:*
+Plum 2 is now powered by [Beartype](https://github.com/beartype/beartype)!
+If you notice any issues with the new release, please open an issue.
+
 # Installation
 
 Plum requires Python 3.7 or higher.

benchmark.py

@@ -1,6 +1,8 @@
+from typing import Tuple
+
 import numpy as np
 
-from plum import dispatch, Dispatcher, Tuple
+from plum import Dispatcher, dispatch
 from tests.util import benchmark
 
 
@@ -18,20 +20,13 @@ def g(x: str):
     pass
 
 
-dur_native = benchmark(f, (1,), n=1000000)
-dur_first_plum = benchmark(g, (1,), n=1)
-dur_plum = benchmark(g, (1,), n=1000000)
+dur_native = benchmark(f, (1,), n=1000, burn=10)
+dur_plum = benchmark(g, (1,), n=1000, burn=10)
+factor = int(np.round(dur_plum / dur_native))
 
 print("# Function Calls")
-print("Native call:     {:6.2f} us ({:.1f} x)".format(dur_native, 1))
-print(
-    "First plum call: {:6.2f} us ({:.1f} x)"
-    "".format(dur_first_plum, int(np.round(dur_first_plum / dur_native)))
-)
-print(
-    "Plum call:       {:6.2f} us ({:.1f} x)"
-    "".format(dur_plum, int(np.round(dur_plum / dur_native)))
-)
+print("Native call: {:6.2f} us ({:.1f} x)".format(dur_native, 1))
+print("Plum call:   {:6.2f} us ({:.1f} x)".format(dur_plum, factor))
 print()
 
 
@@ -49,20 +44,13 @@ def g2(x: Tuple[str]):
     pass
 
 
-dur_native = benchmark(f2, ((1,),), n=1000000)
-dur_first_plum = benchmark(g2, ((1,),), n=1)
-dur_plum = benchmark(g2, ((1,),), n=1000000)
+dur_native = benchmark(f2, ((1,),), n=1000, burn=10)
+dur_plum = benchmark(g2, ((1,),), n=1000, burn=10)
+factor = int(np.round(dur_plum / dur_native))
 
 print("# Parametric Function Calls")
-print("Native call:     {:6.2f} us ({:.1f} x)".format(dur_native, 1))
-print(
-    "First plum call: {:6.2f} us ({:.1f} x)"
-    "".format(dur_first_plum, int(np.round(dur_first_plum / dur_native)))
-)
-print(
-    "Plum call:       {:6.2f} us ({:.1f} x)"
-    "".format(dur_plum, int(np.round(dur_plum / dur_native)))
-)
+print("Native call: {:6.2f} us ({:.1f} x)".format(dur_native, 1))
+print("Plum call:   {:6.2f} us ({:.1f} x)".format(dur_plum, factor))
 print()
 
 
@@ -97,33 +85,19 @@ def go(self, x: str):
 a = A()
 b = B()
 
-dur_native = benchmark(a, (1,), n=1000000)
-dur_first_plum = benchmark(b, (1,), n=1)
-dur_plum = benchmark(b, (1,), n=1000000)
+dur_native = benchmark(a, (1,), n=1000, burn=10)
+dur_plum = benchmark(b, (1,), n=1000, burn=10)
+factor = int(np.round(dur_plum / dur_native))
 
 print("# Class Calls")
-print("Native call:     {:6.2f} us ({:.1f} x)".format(dur_native, 1))
-print(
-    "First plum call: {:6.2f} us ({:.1f} x)"
-    "".format(dur_first_plum, int(np.round(dur_first_plum / dur_native)))
-)
-print(
-    "Plum call:       {:6.2f} us ({:.1f} x)"
-    "".format(dur_plum, int(np.round(dur_plum / dur_native)))
-)
+print("Native call: {:6.2f} us ({:.1f} x)".format(dur_native, 1))
+print("Plum call:   {:6.2f} us ({:.1f} x)".format(dur_plum, factor))
 print()
 
-dur_native = benchmark(lambda x: a.go(x), (1,), n=1000000)
-dur_first_plum = benchmark(lambda x: b.go(x), (1,), n=1)
-dur_plum = benchmark(lambda x: b.go(x), (1,), n=1000000)
+dur_native = benchmark(lambda x: a.go(x), (1,), n=1000, burn=10)
+dur_plum = benchmark(lambda x: b.go(x), (1,), n=1000, burn=10)
+factor = int(np.round(dur_plum / dur_native))
 
 print("# Class Attribute Calls")
-print("Native call:     {:6.2f} us ({:.1f} x)".format(dur_native, 1))
-print(
-    "First plum call: {:6.2f} us ({:.1f} x)"
-    "".format(dur_first_plum, int(np.round(dur_first_plum / dur_native)))
-)
-print(
-    "Plum call:       {:6.2f} us ({:.1f} x)"
-    "".format(dur_plum, int(np.round(dur_plum / dur_native)))
-)
+print("Native call: {:6.2f} us ({:.1f} x)".format(dur_native, 1))
+print("Plum call:   {:6.2f} us ({:.1f} x)".format(dur_plum, factor))

docs/_config.yml

@@ -4,6 +4,11 @@ author: Wessel Bruinsma, Filippo Vicentini, and Ruan Comelli
 copyright: "2022"
 logo: logo.png
 
+# Enable definition lists.
+parse:
+  myst_enable_extensions:
+    - deflist
+
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
 execute:

docs/_toc.yml

@@ -6,11 +6,17 @@ root: intro
 chapters:
 - file: basic_usage
   sections:
+  - file: types
+  - file: dispatch
   - file: scope
   - file: classes
   - file: keyword_arguments
   - file: comparison
-  - file: type_system
-  - file: conversion_promotion
 - file: advanced_usage
+  sections:
+  - file: conversion_promotion
+  - file: precedence
+  - file: parametric
+  - file: union_aliases
+  - file: autoreload
 - file: api