Update Result

### Breaking
- Dropped Python 3.8 & 3.9 to simplify maintenance

### Features
- Added Python 3.13
- Added support for `@as_generator_result` and `@as_async_generator_result`, which function like `@as_result` but wrap the yield values of a generator
- Allow bubbling up unwrapping of nested `Result` inside the `@as_*` decorated classes. If you unwrap an `Err` of an exception type that you handle in the generator, it will return that `Err(Exception)`from the decorated function as if you had thrown the Exception directly.

### Fixes
- Switch to a uv build system with hatch
- Switched linter to Ruff
- Updated the links to point to forked repo

Author: montasaurus

.github/workflows/ci.yml

@@ -2,7 +2,7 @@
 on:
   push:
     branches:
-      - main
+      # - main
   pull_request:
 
 name: CI
@@ -14,67 +14,27 @@ jobs:
     strategy:
       matrix:
         python:
+          - '3.13'
           - '3.12'
           - '3.11'
           - '3.10'
-          - '3.9'
-          - '3.8'
     name: Python ${{ matrix.python }}
     steps:
-      # Python
-      - name: Setup python ${{ matrix.python }}
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Install the latest version of uv and set the python version
+        uses: astral-sh/setup-uv@v5
         with:
           python-version: ${{ matrix.python }}
-
-      # Check out code
-      - uses: actions/checkout@v2
-
-      # Cached dependencies
-      - uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-py${{ matrix.python }}-${{ hashFiles('**/requirements-dev.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-py${{ matrix.python }}-
-      - name: Install dev dependencies
-        # There's no virtual env in CI environment, just bypass it with a dummy
-        # env var value
-        run: VIRTUAL_ENV=none make install
-
-      # Tests
-      - name: Run tests
-        run: pytest --ignore=tests/test_pattern_matching.py --ignore=tests/type_checking/test_result.yml
-      - name: Run tests (type checking)
-        if: matrix.python != '3.8' && matrix.python != '3.9'
-        # These started breaking for <= 3.9, due to the type checker using a
-        # '|' for unions rather than 'Union[...]', so it's not possible to run
-        # the tests without maintaining two duplicate files (one for <= 3.9 and
-        # one for > 3.9)
-        run: pytest tests/type_checking/test_result.yml
-      - name: Run tests (pattern matching)
-        if: matrix.python == '3.10' || matrix.python == '3.11' || matrix.python == '3.12'
-        run: pytest tests/test_pattern_matching.py
-
-      # Linters
-      - name: Run flake8 (Python >= 3.10)
-        run: make lint-flake
-        if: matrix.python != '3.9' && matrix.python != '3.8'
-      - name: Run flake8 (Python < 3.10)
-        run: make lint-flake-pre310
-        if: matrix.python == '3.9' || matrix.python == '3.8'
-      - name: Run mypy
-        run: make lint-mypy
+      
+      # Quality
+      - name: Test with python ${{ matrix.python }}
+        run: uv run --frozen pytest
+      - name: Lint
+        run: make lint
+      - name: Type check
+        run: make type-check
 
       # Packaging
       - name: Build packages
-        run: |
-          pip install --upgrade build pip setuptools wheel
-          python -m build
+        run: uv build
 
-      # Coverage
-      - name: Upload coverage to codecov.io
-        uses: codecov/codecov-action@v1
-        if: matrix.python == '3.9'
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}

.python-version

@@ -0,0 +1 @@
+3.13

CHANGELOG.md

@@ -1,17 +1,21 @@
 # Changelog
 
-This project follows semantic versioning.
+## [Unreleased]
 
-Possible log types:
+### Breaking
+- Dropped Python 3.8 & 3.9 to simplify maintenance
 
-- `[added]` for new features.
-- `[changed]` for changes in existing functionality.
-- `[deprecated]` for once-stable features removed in upcoming releases.
-- `[removed]` for deprecated features removed in this release.
-- `[fixed]` for any bug fixes.
-- `[security]` to invite users to upgrade in case of vulnerabilities.
+### Features
+- Added Python 3.13
+- Added support for `@as_generator_result` and `@as_async_generator_result`, which function like `@as_result` but wrap the yield values of a generator
+- Allow bubbling up unwrapping of nested `Result` inside the `@as_*` decorated classes. If you unwrap an `Err` of an exception type that you handle in the generator, it will return that `Err(Exception)`from the decorated function as if you had thrown the Exception directly.
 
-## [Unreleased]
+### Fixes
+- Switch to a uv build system with hatch
+- Switched linter to Ruff
+- Updated the links to point to forked repo
+
+## [0.18.0.dev0] - Unreleased, Forked from Upstream
 
 - `[changed]` Improve type narrowing for `is_ok` and `is_err` type guards by
   replacing `typing.TypeGuard` with `typing.TypeIs` (#193)

MANIFEST.in

@@ -2,30 +2,19 @@
 .PHONY: phony
 
 install: phony
-ifndef VIRTUAL_ENV
-	$(error install can only be run inside a Python virtual environment)
-endif
-	@echo Installing dependencies...
-	pip install -r requirements-dev.txt
-	pip install -e .
+	uv sync
 
-lint: phony lint-flake lint-mypy
+lint: phony
+	uv run ruff check .
 
-lint-flake: phony
-	flake8
-
-lint-flake-pre310: phony
-	# Python <3.10 doesn't support pattern matching.
-	flake8 --extend-exclude tests/test_pattern_matching.py
-
-lint-mypy: phony
-	mypy
+type-check: phony
+	uv run mypy
 
 test: phony
-	pytest
+	uv run pytest
 
 docs: phony
-	lazydocs \
+	uv run --python 3.10 lazydocs \
 		--overview-file README.md \
-		--src-base-url https://github.com/rustedpy/result/blob/main/ \
+		--src-base-url https://github.com/montasaurus/result/blob/main/ \
 		./src/result

Makefile

@@ -1,23 +1,17 @@
 # Result
 
-[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/rustedpy/result/ci.yml?branch=main)](https://github.com/rustedpy/result/actions/workflows/ci.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/rustedpy/result/branch/main/graph/badge.svg)](https://codecov.io/gh/rustedpy/result)
-
 A simple Result type for Python 3 [inspired by
 Rust](https://doc.rust-lang.org/std/result/), fully type annotated.
 
-## Installation
-
-Latest release:
+> [!WARNING]
+> Forked from the original [result](https://github.com/rustedpy/result) library after it became unmaintained. This version is experimental and mainly used for my own projects--use it at your own risk!
 
-``` sh
-$ pip install result
-```
+## Installation
 
 Latest GitHub `main` branch version:
 
 ``` sh
-$ pip install git+https://github.com/rustedpy/result
+uv add git+https://github.com/montasaurus/result
 ```
 
 ## Summary
@@ -422,29 +416,6 @@ Sometimes regular `do()` can handle async values, but this error means
 you have hit a case where it does not. You should use `do_async()` here
 instead.
 
-## Contributing
-
-These steps should work on any Unix-based system (Linux, macOS, etc) with Python
-and `make` installed. On Windows, you will need to refer to the Python
-documentation (linked below) and reference the `Makefile` for commands to run
-from the non-unix shell you're using on Windows.
-
-1. Setup and activate a virtual environment. See [Python docs][pydocs-venv] for more
-   information about virtual environments and setup.
-2. Run `make install` to install dependencies
-3. Switch to a new git branch and make your changes
-4. Test your changes:
-  - `make test`
-  - `make lint`
-  - You can also start a Python REPL and import `result`
-5. Update documentation
-  - Edit any relevant docstrings, markdown files
-  - Run `make docs`
-6. Add an entry to the [changelog](./CHANGELOG.md)
-5. Git commit all your changes and create a new PR.
-
-[pydocs-venv]: https://docs.python.org/3/library/venv.html
-
 ## FAQ
 
 -   **Why should I use the `is_ok` (`is_err`) type guard function over the `is_ok` (`is_err`) method?**

README.md

@@ -15,7 +15,9 @@
 
 ## Functions
 
+- [`result.as_async_generator_result`](./result.md#function-as_async_generator_result)
 - [`result.as_async_result`](./result.md#function-as_async_result): Make a decorator to turn an async function into one that returns a ``Result``.
+- [`result.as_generator_result`](./result.md#function-as_generator_result)
 - [`result.as_result`](./result.md#function-as_result): Make a decorator to turn a function into one that returns a ``Result``.
 - [`result.do`](./result.md#function-do): Do notation for Result (syntactic sugar for sequence of `and_then()` calls).
 - [`result.do_async`](./result.md#function-do_async): Async version of do. Example: