Drop python3.9, m2r2, use myst-parser (#1971)

sobolevn · web-flow · commit 28f14f8dc106 · 2024-12-01T19:12:49.000+03:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v4
@@ -56,7 +56,6 @@ jobs:
         # Different python versions are covered differently:
         poetry run pytest returns docs/pages tests
 
-        poetry run doc8 -q docs
         poetry run codespell returns tests docs typesafety README.md CONTRIBUTING.md CHANGELOG.md
 
         poetry run poetry check
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,16 +6,19 @@ incremental in minor, bugfixes only are patches.
 See [0Ver](https://0ver.org/).
 
 
-## 0.24.0 WIP
+## 0.24.0
 
 ### Features
 
+- Drop `python3.9` support
+- Add `python3.13` support
+- Add support for `mypy>=1.12`
 - Add picky exceptions to `future_safe` decorator like `safe` has.
 - Improve inference of `ResultLike` objects when exception catching
   decorator is applied with explicit exception types
 - Add picky exceptions to `impure_safe` decorator like `safe` has. Issue #1543
 - Add partition function to result module. Issue #1905
-- Adds `default_error` parameter to `returns.converters.maybe_to_result`,
+- Add `default_error` parameter to `returns.converters.maybe_to_result`,
   which provides a default error value for `Failure`
 
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -117,8 +117,7 @@ Before submitting your code please do the following steps:
 6. Run `pytest` again to make sure it is still working
 7. Run `mypy` to ensure that types are correct
 8. Run `flake8` to ensure that style is correct
-9. Run `doc8` to ensure that docs are correct
-10. Run `slotscheck` to ensure that slots are correct
+9. Run `slotscheck` to ensure that slots are correct
 
 
 ## Other help
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,7 +51,7 @@ def _get_project_meta():
     'sphinx.ext.napoleon',
 
     # Used to include .md files:
-    'm2r2',
+    'myst_parser',
 
     # Used to insert typehints into the final docs:
     'sphinx_autodoc_typehints',
@@ -71,6 +71,11 @@ def _get_project_meta():
     'show-inheritance': True,
 }
 
+suppress_warnings = [
+    'myst.header',
+    'myst.xref_missing',
+]
+
 # https://pypi.org/project/sphinx-autodoc-typehints/
 always_document_param_types = True
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,8 @@
-.. mdinclude:: ../README.md
+returns
+=======
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
 Contents
 --------
diff --git a/docs/pages/changelog.rst b/docs/pages/changelog.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../../CHANGELOG.md
+.. include:: ../../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -46,7 +46,7 @@ _ = "returns.contrib.hypothesis._entrypoint:_setup_hook"
 
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.10"
 
 typing-extensions = ">=4.0,<5.0"
 pytest = { version = "^8.0", optional = true }
@@ -72,7 +72,6 @@ pytest-mypy-plugins = "^3.1"
 pytest-subtests = "^0.13"
 pytest-shard = "^0.1"
 
-doc8 = "^1.1"
 
 [tool.poetry.group.docs]
 optional = true
@@ -83,7 +82,7 @@ sphinx = "^7.3"
 sphinx-autodoc-typehints = "^2.3"
 sphinxcontrib-mermaid = "^1.0"
 furo = "^2024.5"
-m2r2 = "^0.3"
+myst-parser = "^4.0"
 tomli = "^2.0"
 
 [tool.poetry.extras]
diff --git a/setup.cfg b/setup.cfg
@@ -203,14 +203,6 @@ disallow_subclassing_any = False
 disallow_subclassing_any = False
 
 
-[doc8]
-# doc8 configuration: https://pypi.org/project/doc8/
-ignore-path = docs/_build
-max-line-length = 80
-sphinx = True
-ignore-path-errors=docs/pages/railway.rst;D000
-
-
 [codespell]
 # codespell configuration: https://pypi.org/project/codespell
 ignore-words-list = appliable,falsy
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/typesafety/test_curry/test_curry/test_curry_arguments.yml b/typesafety/test_curry/test_curry/test_curry_arguments.yml
@@ -1,6 +1,5 @@
 - case: curry_pos_only_args
   disable_cache: false
-  skip: sys.version_info[:2] < (3, 8)
   main: |
     from returns.curry import curry
 
diff --git a/typesafety/test_curry/test_partial/test_partial_arguments.yml b/typesafety/test_curry/test_partial/test_partial_arguments.yml
@@ -53,7 +53,6 @@
 
 - case: partial_pos_only_args
   disable_cache: false
-  skip: sys.version_info[:2] < (3, 8)
   main: |
     from returns.curry import partial
 
diff --git a/typesafety/test_curry/test_partial/test_partial_generic.yml b/typesafety/test_curry/test_partial/test_partial_generic.yml
@@ -79,46 +79,9 @@
     main:22: note: Revealed type is "builtins.int"
 
 
-- case: partial_double_generic_complex37
-  disable_cache: false
-  skip: sys.version_info[:2] >= (3, 8)
-  main: |
-    from returns.curry import partial
-    from typing import List, TypeVar, Union
-
-    A = TypeVar('A')
-    B = TypeVar('B')
-
-    def multiple(
-        a: int,
-        *,
-        b: List[B],
-        c: List[A],
-    ) -> Union[A, B]:
-        ...
-
-    x: List[int]
-    y: List[str]
-
-    reveal_type(partial(multiple))
-    reveal_type(partial(multiple, 1))
-    reveal_type(partial(multiple, 1, b=x))
-    reveal_type(partial(multiple, 1, c=x))
-    reveal_type(partial(multiple, 1, b=y))
-    reveal_type(partial(multiple, 1, c=y))
-  out: |
-    main:18: note: Revealed type is "def [B, A] (a: builtins.int, *, b: builtins.list[B`-1], c: builtins.list[A`-2]) -> Union[A`-2, B`-1]"
-    main:19: note: Revealed type is "def [B, A] (*, b: builtins.list[B`-1], c: builtins.list[A`-2]) -> Union[A`-2, B`-1]"
-    main:20: note: Revealed type is "def [A] (*, c: builtins.list[A`-2]) -> Union[A`-2, builtins.int]"
-    main:21: note: Revealed type is "def [B] (*, b: builtins.list[B`-1]) -> Union[builtins.int, B`-1]"
-    main:22: note: Revealed type is "def [A] (*, c: builtins.list[A`-2]) -> Union[A`-2, builtins.str]"
-    main:23: note: Revealed type is "def [B] (*, b: builtins.list[B`-1]) -> Union[builtins.str, B`-1]"
-
-
 # Python3.8+ sorts generic arguments differently:
 - case: partial_double_generic_complex38
   disable_cache: false
-  skip: sys.version_info[:2] < (3, 8)
   main: |
     from returns.curry import partial
     from typing import List, TypeVar, Union
diff --git a/typesafety/test_future/test_future_container/test_do.yml b/typesafety/test_future/test_future_container/test_do.yml
@@ -1,5 +1,4 @@
 - case: do_sync_error
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.future import Future
@@ -27,7 +26,6 @@
 
 
 - case: do_with_if
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.future import Future
diff --git a/typesafety/test_future/test_future_result_container/test_do.yml b/typesafety/test_future/test_future_result_container/test_do.yml
@@ -1,5 +1,4 @@
 - case: do_sync_error
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.future import FutureResult, FutureSuccess
@@ -81,7 +80,6 @@
 
 
 - case: do_with_if
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.future import FutureSuccess, FutureResult
diff --git a/typesafety/test_io/test_io_container/test_do.yml b/typesafety/test_io/test_io_container/test_do.yml
@@ -12,7 +12,6 @@
 
 
 - case: do_with_if
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.io import IO
diff --git a/typesafety/test_io/test_ioresult_container/test_do.yml b/typesafety/test_io/test_ioresult_container/test_do.yml
@@ -66,7 +66,6 @@
 
 
 - case: do_with_if
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.io import IOSuccess, IOResult
diff --git a/typesafety/test_maybe/test_do.yml b/typesafety/test_maybe/test_do.yml
@@ -40,7 +40,6 @@
 
 
 - case: do_with_if
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.maybe import Maybe
diff --git a/typesafety/test_result/test_do.yml b/typesafety/test_result/test_do.yml
@@ -51,7 +51,6 @@
 
 
 - case: do_with_if
-  skip: sys.version_info[:2] < (3, 8)
   disable_cache: false
   main: |
     from returns.result import Success, Result

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-.. mdinclude:: ../../CHANGELOG.md`
	`1`	`+.. include:: ../../CHANGELOG.md`
	`2`	`+ :parser: myst_parser.sphinx_`