Merge branch 'master' of github.com:RomanMIzulin/returns into gatherlike

Author: romanmatveevsky

.github/workflows/test.yml

@@ -20,10 +20,12 @@ 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
+      with:
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
@@ -56,29 +58,31 @@ 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
+        # TODO: re-enable after all problems are fixed
+        # poetry run poetry check
         poetry run pip check
         poetry run python -m slotscheck returns --verbose
 
     - name: Upload coverage to Codecov
       if: matrix.python-version == 3.11
       uses: codecov/codecov-action@v5
       with:
-        file: ./coverage.xml
+        files: ./coverage.xml
 
   typesafety-tests:
     runs-on: ubuntu-latest
     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']
         shard: [0, 1, 2, 3]
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5

.github/zizmor.yml

@@ -0,0 +1,5 @@
+rules:
+  unpinned-uses:
+    config:
+      policies:
+        "*": ref-pin

.pre-commit-config.yaml

@@ -0,0 +1,58 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: check-case-conflict
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.33.0
+    hooks:
+      - id: check-dependabot
+      - id: check-readthedocs
+      - id: check-github-workflows
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+  - repo: https://github.com/woodruffw/zizmor-pre-commit
+    rev: v1.6.0
+    hooks:
+      - id: zizmor
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: v2.5.1
+    hooks:
+      - id: pyproject-fmt
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.7
+    hooks:
+      - id: ruff
+        args: ["--exit-non-zero-on-fix"]
+      - id: ruff-format
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v1.0.0
+    hooks:
+      - id: sphinx-lint
+        args: [--enable=default-role]
+        files: ^docs/
+
+  # Should be the last:
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+
+ci:
+  autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
+  autofix_prs: true
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: weekly
+  submodules: false

.readthedocs.yml

@@ -4,15 +4,19 @@ version: 2
 # Set the version of Python and other tools you might need
 build:
   os: ubuntu-lts-latest
-  tools: {python: "3.11"}
+  tools: {python: "3.12"}
   jobs:
     pre_create_environment:
       - asdf plugin add poetry
       - asdf install poetry latest
       - asdf global poetry latest
       - poetry config virtualenvs.create false
       - poetry self add poetry-plugin-export
-      - poetry export --only main --only docs --extras check_laws --format=requirements.txt --output=requirements.txt
+      - poetry export
+        --only main --only docs
+        --extras check_laws --extras compatible_mypy
+        --format=requirements.txt
+        --output=requirements.txt
 
 python:
   install:

CHANGELOG.md

@@ -6,23 +6,48 @@ incremental in minor, bugfixes only are patches.
 See [0Ver](https://0ver.org/).
 
 
-## 0.24.0 WIP
+## 0.25.0
 
 ### Features
 
-- Add picky exceptions to `future_safe` decorator like `safe` has.
+- A lot of new features added to our `hypothesis` plugins.
+  It now allows to create custom strategies, better instantiate containers,
+  docouple it from built-in ones, check laws from user-defined interfaces
+
+### Bugfixes
+
+- Fixes that `UnwrapFailedError` was not picklable
+
+
+## 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 methods module. Issue #1905
-- Adds `default_error` parameter to `returns.converters.maybe_to_result`,
+- Add partition function to result module. Issue #1905
+- Add `default_error` parameter to `returns.converters.maybe_to_result`,
   which provides a default error value for `Failure`
 - Add `returns.methods.gather` utility method
 
 
-### Misc
+## 0.24.1
+
+### Features
+
+- Make `hypothesis` plugin test laws from user-defined interfaces too
+- Make `hypothesis` plugin accept user-defined strategies
+- Allow users to override the `hypothesis` plugin's strategies for types, such
+  as `TypeVar` and `Callable`.
+
+### Bugfixes
 
-- Now requires `mypy>=1.11`
+- Add pickling support for `UnwrapFailedError` exception
 
 
 ## 0.23.0

CONTRIBUTING.md

@@ -30,7 +30,14 @@ To install them you would need to run the `install` command:
 poetry install
 ```
 
-To activate your `virtualenv` run `poetry shell`.
+To install extra dependencies for working on the `hypothesis` or `mypy` plugin:
+
+```bash
+poetry install --extras check-laws
+poetry install --extras compatible-mypy
+```
+
+To activate your `virtualenv` run `eval $(poetry env activate)`.
 
 
 ## Tests
@@ -117,8 +124,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

README.md

@@ -2,7 +2,7 @@
 
 -----
 
-[![Build Status](https://github.com/dry-python/returns/workflows/test/badge.svg?branch=master&event=push)](https://github.com/dry-python/returns/actions?query=workflow%3Atest)
+[![test](https://github.com/dry-python/returns/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/dry-python/returns/actions/workflows/test.yml)
 [![codecov](https://codecov.io/gh/dry-python/returns/branch/master/graph/badge.svg)](https://codecov.io/gh/dry-python/returns)
 [![Documentation Status](https://readthedocs.org/projects/returns/badge/?version=latest)](https://returns.readthedocs.io/en/latest/?badge=latest)
 [![Python Version](https://img.shields.io/pypi/pyversions/returns.svg)](https://pypi.org/project/returns/)
@@ -59,7 +59,7 @@ or:
 plugins = ["returns.contrib.mypy.returns_plugin"]
 ```
 
-We also recommend to use the same `mypy` settings [we use](https://github.com/wemake-services/wemake-python-styleguide/blob/master/styles/mypy.toml).
+We also recommend to use the same `mypy` settings we use, which you'll find in the `[tool.mypy]` sections in our [pyproject.toml](https://github.com/wemake-services/wemake-python-styleguide/blob/master/pyproject.toml) file.
 
 Make sure you know how to get started, [check out our docs](https://returns.readthedocs.io/en/latest/)!
 [Try our demo](https://repl.it/@sobolevn/returns#ex.py).
@@ -204,7 +204,7 @@ from words_app.logic import calculate_points
 
 def view(request: HttpRequest) -> HttpResponse:
     user_word: str = request.POST['word']  # just an example
-    points = calculate_points(user_words)(settings)  # passing the dependencies
+    points = calculate_points(user_word)(settings)  # passing the dependencies
     ...  # later you show the result to user somehow
 
 # Somewhere in your `words_app/logic.py`:

docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = returns
 SOURCEDIR     = .

docs/conf.py

@@ -10,24 +10,25 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-import os
+import pathlib
 import sys
 
 import tomli
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, str(pathlib.Path('..').resolve()))
 
 
 # -- Project information -----------------------------------------------------
 
+
 def _get_project_meta():
-    with open('../pyproject.toml', mode='rb') as pyproject:
+    with pathlib.Path('../pyproject.toml').open(mode='rb') as pyproject:
         return tomli.load(pyproject)['tool']['poetry']
 
 
 pkg_meta = _get_project_meta()
 project = str(pkg_meta['name'])
-copyright = '2019, dry-python team'  # noqa: WPS125
+copyright = '2019, dry-python team'  # noqa: A001
 author = 'dry-python team'
 
 # The short X.Y version
@@ -49,13 +50,10 @@ def _get_project_meta():
     'sphinx.ext.viewcode',
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
-
     # Used to include .md files:
-    'm2r2',
-
+    'myst_parser',
     # Used to insert typehints into the final docs:
     'sphinx_autodoc_typehints',
-
     # Used to build graphs:
     'sphinxcontrib.mermaid',
 ]
@@ -71,6 +69,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
 

docs/index.rst

@@ -1,4 +1,8 @@
-.. mdinclude:: ../README.md
+returns
+=======
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
 Contents
 --------