Merge pull request #4326 from tybug/fix-readme-job

Move build to pyproject.toml

Author: Zac-HD

.github/workflows/main.yml

@@ -257,8 +257,8 @@ jobs:
           CFLAGS=-g2 LDFLAGS=-g2 pyodide build
       - name: Set up Pyodide venv and install dependencies
         run: |
-          pip install --upgrade setuptools pip wheel
-          python hypothesis-python/setup.py bdist_wheel
+          pip install --upgrade setuptools pip wheel build
+          python -m build --wheel hypothesis-python --outdir dist/
           pip download --dest=dist/ hypothesis-python/ pytest tzdata  # fetch all the wheels
 
           rm dist/packaging-*.whl  # fails with `invalid metadata entry 'name'`
@@ -312,5 +312,4 @@ jobs:
         GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_TOKEN }}
         CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
       run: |
-        cp README.md hypothesis-python/
         TASK=${{ matrix.task }} ./build.sh

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="./brand/dragonfly-rainbow.svg" width="300">
+  <img src="https://raw.githubusercontent.com/HypothesisWorks/hypothesis/master/brand/dragonfly-rainbow.svg" width="300">
 </div>
 
 # Hypothesis

hypothesis-python/MANIFEST.in

@@ -1,47 +1 @@
-<div align="center">
-  <img src="./brand/dragonfly-rainbow.svg" width="300">
-</div>
-
-# Hypothesis
-
-* [Website](https://hypothesis.works/)
-* [Documentation](https://hypothesis.readthedocs.io/en/latest/)
-* [Source code](https://github.com/hypothesisWorks/hypothesis/)
-* [Contributing](https://github.com/HypothesisWorks/hypothesis/blob/master/CONTRIBUTING.rst)
-* [Community](https://hypothesis.readthedocs.io/en/latest/community.html)
-
-Hypothesis is the property-based testing library for Python. A property-based test asserts something for *all* inputs, and lets Hypothesis generate them — including inputs you may not have thought of.
-
-```python
-from hypothesis import given, strategies as st
-
-
-@given(st.lists(st.integers() | st.floats()))
-def test_matches_builtin(ls):
-    assert sorted(ls) == my_sort(ls)
-```
-
-Additionally, when a property fails, Hypothesis doesn't just report any failing example — it reports the simplest possible one. This makes property-based tests a powerful tool for debugging, as well as testing.
-
-For instance,
-
-```python
-def my_sort(ls):
-    return list(reversed(sorted(ls, reverse=True)))
-```
-
-fails with:
-
-```
-Falsifying example: test_matches_builtin(ls=[0, math.nan])
-```
-
-### Installation
-
-To install Hypothesis:
-
-```
-pip install hypothesis
-```
-
-There are also [optional extras available](https://hypothesis.readthedocs.io/en/latest/extras.html).
+The Hypothesis python readme has moved to [the main readme](../README.md)!

hypothesis-python/README.md

@@ -45,11 +45,10 @@ Hypothesis has *mandatory* dependencies on the following libraries:
 
 Hypothesis has *optional* dependencies on the following libraries:
 
-.. literalinclude:: ../setup.py
-   :prepend: extras_require = {
-   :start-after: extras = {
-   :end-before: }
-   :append: }
+.. literalinclude:: ../pyproject.toml
+   :prepend: [project.optional-dependencies]
+   :start-after: [project.optional-dependencies]
+   :end-before: # Avoid changing this by hand
 
 The way this works when installing Hypothesis normally is that these features become available if the relevant
 library is installed.

hypothesis-python/docs/packaging.rst

@@ -134,9 +134,9 @@ test is using Hypothesis:
 
 .. _entry-points:
 
---------------------------------------------------
-Hypothesis integration via setuptools entry points
---------------------------------------------------
+---------------------------------------
+Hypothesis integration via entry points
+---------------------------------------
 
 If you would like to ship Hypothesis strategies for a custom type - either as
 part of the upstream library, or as a third-party extension, there's a catch:
@@ -150,9 +150,9 @@ either
 - the user has to call a 'register the strategies' helper that you provide
   before running their tests
 
-`Entry points <https://amir.rachum.com/blog/2017/07/28/python-entry-points/>`__
+`Entry points <https://setuptools.pypa.io/en/latest/userguide/entry_point.html>`__
 are Python's standard way of automating the latter: when you register a
-``"hypothesis"`` entry point in your ``setup.py``, we'll import and run it
+``"hypothesis"`` entry point in your ``pyproject.toml``, we'll import and run it
 automatically when *hypothesis* is imported.  Nothing happens unless Hypothesis
 is already in use, and it's totally seamless for downstream users!
 
@@ -175,17 +175,19 @@ package that does all the Hypothesis-related setup work:
 
         st.register_type_strategy(MyCustomType, st.integers(min_value=0))
 
-and then tell ``setuptools`` that this is your ``"hypothesis"`` entry point:
+and then declare this as your ``"hypothesis"`` entry point:
 
-.. code-block:: python
+.. code-block:: toml
 
-    # setup.py
+    # pyproject.toml
 
     # You can list a module to import by dotted name
-    entry_points = {"hypothesis": ["_ = mymodule.a_submodule"]}
+    [project.entry-points.hypothesis]
+    _ = "mymodule.a_submodule"
 
-    # Or name a specific function too, and Hypothesis will call it for you
-    entry_points = {"hypothesis": ["_ = mymodule:_hypothesis_setup_hook"]}
+    # Or name a specific function, and Hypothesis will call it for you
+    [project.entry-points.hypothesis]
+    _ = "mymodule:_hypothesis_setup_hook"
 
 And that's all it takes!
 

hypothesis-python/docs/strategies.rst

@@ -0,0 +1,136 @@
+[build-system]
+# require a recent setuptools for `license = ` support
+requires = ["setuptools >= 78.1.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hypothesis"
+# see [tool.setuptools.dynamic]
+dynamic = ["version"]
+authors = [
+    { name = "David R. MacIver and Zac Hatfield-Dodds", email = "[email protected]" }
+]
+description = "A library for property-based testing"
+# Avoid changing this by hand. This is automatically updated by update_changelog_and_version
+readme = {"text" = """<div align="center">
+  <img src="https://raw.githubusercontent.com/HypothesisWorks/hypothesis/master/brand/dragonfly-rainbow.svg" width="300">
+</div>
+
+# Hypothesis
+
+* [Website](https://hypothesis.works/)
+* [Documentation](https://hypothesis.readthedocs.io/en/latest/)
+* [Source code](https://github.com/hypothesisWorks/hypothesis/)
+* [Contributing](https://github.com/HypothesisWorks/hypothesis/blob/master/CONTRIBUTING.rst)
+* [Community](https://hypothesis.readthedocs.io/en/latest/community.html)
+
+Hypothesis is the property-based testing library for Python. A property-based test asserts something for *all* inputs, and lets Hypothesis generate them — including inputs you may not have thought of.
+
+```python
+from hypothesis import given, strategies as st
+
+
+@given(st.lists(st.integers() | st.floats()))
+def test_matches_builtin(ls):
+    assert sorted(ls) == my_sort(ls)
+```
+
+Additionally, when a property fails, Hypothesis doesn't just report any failing example — it reports the simplest possible one. This makes property-based tests a powerful tool for debugging, as well as testing.
+
+For instance,
+
+```python
+def my_sort(ls):
+    return list(reversed(sorted(ls, reverse=True)))
+```
+
+fails with:
+
+```
+Falsifying example: test_matches_builtin(ls=[0, math.nan])
+```
+
+### Installation
+
+To install Hypothesis:
+
+```
+pip install hypothesis
+```
+
+There are also [optional extras available](https://hypothesis.readthedocs.io/en/latest/extras.html).
+""", "content-type" = "text/markdown"}
+license = "MPL-2.0"
+requires-python = ">= 3.9"
+keywords = ["python", "testing", "fuzzing", "property-based-testing"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Hypothesis",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "Operating System :: Unix",
+    "Operating System :: POSIX",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Topic :: Education :: Testing",
+    "Topic :: Software Development :: Testing",
+    "Typing :: Typed",
+]
+
+dependencies = [
+    "attrs>=22.2.0",
+    "exceptiongroup>=1.0.0; python_version<'3.11'",
+    "sortedcontainers>=2.1.0,<3.0.0",
+]
+
+[project.urls]
+homepage = "https://hypothesis.works"
+source = "https://github.com/HypothesisWorks/hypothesis"
+changelog = "https://hypothesis.readthedocs.io/en/latest/changes.html"
+documentation = "https://hypothesis.readthedocs.io"
+issues = "https://github.com/HypothesisWorks/hypothesis/issues"
+
+[project.optional-dependencies]
+cli = ["click>=7.0", "black>=19.10b0", "rich>=9.0.0"]
+codemods = ["libcst>=0.3.16"]
+ghostwriter = ["black>=19.10b0"]
+pytz = ["pytz>=2014.1"]
+dateutil = ["python-dateutil>=1.4"]
+lark = ["lark>=0.10.1"]  # probably still works with old `lark-parser` too
+numpy = ["numpy>=1.19.3"]  # oldest with wheels for non-EOL Python (for now)
+pandas = ["pandas>=1.1"]
+pytest = ["pytest>=4.6"]
+dpcontracts = ["dpcontracts>=0.4"]
+redis = ["redis>=3.0.0"]
+crosshair = ["hypothesis-crosshair>=0.0.20", "crosshair-tool>=0.0.84"]
+# zoneinfo is an odd one: every dependency is platform-conditional.
+zoneinfo = ["tzdata>=2025.1; sys_platform == 'win32' or sys_platform == 'emscripten'"]
+# We only support Django versions with upstream support - see
+# https://www.djangoproject.com/download/#supported-versions
+# We also leave the choice of timezone library to the user, since it
+# might be zoneinfo or pytz depending on version and configuration.
+django = ["django>=4.2"]
+watchdog = ["watchdog>=4.0.0"]
+# Avoid changing this by hand. This is automatically updated by update_changelog_and_version
+all = ["black>=19.10b0", "click>=7.0", "crosshair-tool>=0.0.84", "django>=4.2", "dpcontracts>=0.4", "hypothesis-crosshair>=0.0.20", "lark>=0.10.1", "libcst>=0.3.16", "numpy>=1.19.3", "pandas>=1.1", "pytest>=4.6", "python-dateutil>=1.4", "pytz>=2014.1", "redis>=3.0.0", "rich>=9.0.0", "tzdata>=2025.1; sys_platform == 'win32' or sys_platform == 'emscripten'", "watchdog>=4.0.0"]
+
+[tool.setuptools.dynamic]
+version = {attr = "hypothesis.version.__version__"}
+
+[tool.setuptools.package-data]
+hypothesis = ["vendor/tlds-alpha-by-domain.txt"]
+
+[project.scripts]
+hypothesis = "hypothesis.extra.cli:main"
+
+[project.entry-points.pytest11]
+hypothesispytest = "_hypothesis_pytestplugin"

hypothesis-python/pyproject.toml

@@ -36,7 +36,7 @@ $PYTEST tests/typing_extensions/
 pip uninstall -y typing_extensions
 
 pip install ".[lark]"
-pip install "$(grep -oE 'lark>=([0-9.]+)' ../hypothesis-python/setup.py | tr '>' =)"
+pip install "$(grep -m 1 -oE 'lark>=([0-9.]+)' ../hypothesis-python/pyproject.toml | tr '>' =)"
 $PYTEST -Wignore tests/lark/
 pip install "$(grep 'lark==' ../requirements/coverage.txt)"
 $PYTEST tests/lark/

hypothesis-python/scripts/basic-test.sh

@@ -40,7 +40,7 @@ $PYTEST tests/test_annotated_types.py
 pip uninstall -y annotated-types
 
 pip install ".[lark]"
-pip install "$(grep -oE 'lark>=([0-9.]+)' ../hypothesis-python/setup.py | tr '>' =)"
+pip install "$(grep -m 1 -oE 'lark>=([0-9.]+)' ../hypothesis-python/pyproject.toml | tr '>' =)"
 $PYTEST -Wignore tests/lark/
 pip install "$(grep 'lark==' ../requirements/coverage.txt)"
 $PYTEST tests/lark/