Rust like Option and Result types in Python

Last update: Dec 13, 2022

Overview

Option

Rust-like Option and Result types in Python, slotted and fully typed.

An Option type represents an optional value, every Option is either Some and contains Some value, or NONE

A Result type represents a value that might be an error. Every Result is either Ok and contains a success value, or Err and contains an error value.

Using an Option type forces you to deal with None values in your code and increase type safety.

Using a Result type simplifies error handling and reduces try except blocks.

Quick Start

from option import Result, Option, Ok, Err
from requests import get


def call_api(url, params) -> Result[dict, int]:
    result = get(url, params)
    code = result.status_code
    if code == 200:
        return Ok(result.json())
    return Err(code)


def calculate(url, params) -> Option[int]:
    return call_api(url, params).ok().map(len)


dict_len = calculate('https://example.com', {})

Install

Option can be installed from PyPi:

pip install option

Documentation

The documentation lives at https://mat1g3r.github.io/option/

License

MIT

Comments

Enable mypy strict mode + add build-system requires in pyproject.toml
Added configuration for mypy strict mode in pyproject.toml

Added annotations for un-annotated parameters and return types

Without strict mode, all un-annotated variables are treated as Any, which disables a lot of type safety checks, And it becomes annoying to use this if you have enabled strict mode yourself, because of all the errors that can only be fixed by modifying the code for the library.
opened by saaketp 9
Bump typing-extensions from 4.3.0 to 4.4.0
Bumps typing-extensions from 4.3.0 to 4.4.0.

Changelog

Sourced from typing-extensions's changelog.

Release 4.4.0 (October 6, 2022)

Add typing_extensions.Any a backport of python 3.11's Any class which is subclassable at runtime. (backport from python/cpython#31841, by Shantanu and Jelle Zijlstra). Patch by James Hilton-Balfe (@Gobot1234).

Add initial support for TypeVarLike default parameter, PEP 696. Patch by Marc Mueller (@cdce8p).

Runtime support for PEP 698, adding typing_extensions.override. Patch by Jelle Zijlstra.

Add the infer_variance parameter to TypeVar, as specified in PEP 695. Patch by Jelle Zijlstra.

Commits

b5f375a Prepare release 4.4.0 (#82)

354b938 Add to README (#81)

3c21f33 Add @typing.override (#78)

ba776ea Add TypeVar(infer_variance=True) (#80)

fafb5c5 Initial support for TypeVarLike default parameter (PEP 696) (#77)

2979419 Backport python/cpython#96479 (#73)

3a61a94 Remove mention of Python 3.6 from README (#67)

7d1aeea Implement typing_extensions.Any (#68)

9683c1a Backport test case from #python/cpython/96358 (#71)

db79268 Silence a flake8-bugbear warning (#72)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 4
Surprising behavior for option.Option.Some(None)
I was learning this package to use in my own work. I was surprised by the behavior of this test:

def test_ctor_some_but_none(): sut = option.Some(None) # assert_that(sut.is_none) assert_that(sut.is_some)

I'll be the first to admit that I do not fully understand the expectations for an Option type, but I expected option.Some(None) to behave similarly to option.maybe(None).

What is the reason for this choice?
opened by mrwizard82d1 3
Bump mypy from 0.971 to 0.982
Bumps mypy from 0.971 to 0.982.

Commits

1c2b899 Bump version to 0.982

51d9858 Restore Type vs Callable special-casing that was broken in refactoring (#13784)

d03f201 Suggest using upper bound for unbound tvar (#13730)

5b17cc6 Fix overload overlap check for UninhabitedType (#13461)

c7b4714 Update version to 0.981

2bd7da2 [0.980 backport] build changes (#13688)

2b2953a [0.980 backport] Update pos-only unit tests for Python 3.10.7 (#13660) (#13665)

ada0078 Remove dev from version

efd1d38 [0.980 backport] Fix stubtest custom_typeshed_dir regression (#13656) (#13658)

70bc348 [0.980 backport] Allow unpacking from TypeVars with iterable bounds (#13425) ...

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 5.1.1 to 5.2.3
Bumps sphinx from 5.1.1 to 5.2.3.

Release notes

Sourced from sphinx's releases.

v5.2.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.2.3 (released Sep 30, 2022)

#10878: Fix base64 image embedding in sphinx.ext.imgmath

#10886: Add :nocontentsentry: flag and global domain table of contents entry control option. Patch by Adam Turner

Release 5.2.2 (released Sep 27, 2022)

#10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

#10861: Always normalise the pycon3 lexer to pycon.

Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by Adam Turner.

Deprecated

#10843: Support for HTML 4 output. Patch by Adam Turner.

Features added

#10738: napoleon: Add support for docstring types using 'of', like type of type. Example: tuple of int.

#10286: C++, support requires clauses not just between the template parameter lists and the declaration.

... (truncated)

Commits

cbb19d6 Bump to 5.2.3 final

650f63b Finer grained control over domain ToC entries (#10886)

6627618 imgmath: Fix embed mode (#10878)

a651e6b Bump to 5.2.2 final

335f335 Restore anchor links to top of module docstring

19c2783 Correct error in release date for Sphinx 5.2.1

635540c Restore anchor links to top of module docstring

89b4f14 Fix mypy violations for v0.981 (#10875)

e0dbbc5 Bump to 5.2.1 final

15c1cba Fix error in changelog for Sphinx 5.2.0

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump pytest from 7.1.2 to 7.1.3
Bumps pytest from 7.1.2 to 7.1.3.

Release notes

Sourced from pytest's releases.

7.1.3

pytest 7.1.3 (2022-08-31)

Bug Fixes

#10060: When running with --pdb, TestCase.tearDown is no longer called for tests when the class has been skipped via unittest.skip or pytest.mark.skip.

#10190: Invalid XML characters in setup or teardown error messages are now properly escaped for JUnit XML reports.

#10230: Ignore .py files created by pyproject.toml-based editable builds introduced in pip 21.3.

#3396: Doctests now respect the --import-mode flag.

#9514: Type-annotate FixtureRequest.param as Any as a stop gap measure until 8073{.interpreted-text role="issue"} is fixed.

#9791: Fixed a path handling code in rewrite.py that seems to work fine, but was incorrect and fails in some systems.

#9917: Fixed string representation for pytest.approx{.interpreted-text role="func"} when used to compare tuples.

Improved Documentation

#9937: Explicit note that tmpdir{.interpreted-text role="fixture"} fixture is discouraged in favour of tmp_path{.interpreted-text role="fixture"}.

Trivial/Internal Changes

#10114: Replace atomicwrites dependency on windows with [os.replace]{.title-ref}.

Commits

4645bcd Remove incorrect output in how-to/fixtures.rst

fadfb4f Prepare release version 7.1.3

ab96ea8 Merge pull request #10258 from pytest-dev/backport-10252-to-7.1.x

fc0e024 [7.1.x] Fix regendoc

8f5088f Merge pull request #10249 from pytest-dev/backport-10231-to-7.1.x

aae93d6 Ignore type-errors related to attr.asdict

71b79fc [7.1.x] Ignore editable installation modules

89f7518 Merge pull request #10222 from pytest-dev/backport-10171-to-7.1.x

88fc45b [7.1.x] Update fixtures.rst w/ finalizer order

d0b53d6 Merge pull request #10221 from pytest-dev/backport-10217-to-7.1.x

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 5.0.2 to 5.1.0
Bumps sphinx from 5.0.2 to 5.1.0.

Release notes

Sourced from sphinx's releases.

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.1.0 (released Jul 24, 2022)

Dependencies

#10656: Support Docutils 0.19_. Patch by Adam Turner.

.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05

Deprecated

#10467: Deprecated sphinx.util.stemmer in favour of snowballstemmer. Patch by Adam Turner.

#9856: Deprecated sphinx.ext.napoleon.iterators.

Features added

#10444: html theme: Allow specifying multiple CSS files through the stylesheet setting in theme.conf or by setting html_style to an iterable of strings.

#10366: std domain: Add support for emphasising placeholders in :rst:dir:option directives through a new :confval:option_emphasise_placeholders configuration option.

#10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify.

#10571: quickstart: Reduce content in the generated conf.py file. Patch by Pradyun Gedam.

#10648: LaTeX: CSS-named-alike additional :ref:'sphinxsetup' <latexsphinxsetup> keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives.

#10655: LaTeX: Explain non-standard encoding in LatinRules.xdy

#10599: HTML Theme: Wrap consecutive footnotes in an <aside> element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner.

#10518: config: Add include_patterns as the opposite of exclude_patterns. Patch by Adam Turner.

Bugs fixed

#10594: HTML Theme: field term colons are doubled if using Docutils 0.18+

#10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing Node.findall()

#10506: LaTeX: build error if highlighting inline code role in figure caption (refs: #10251)

#10634: Make -P (pdb) option work better with exceptions triggered from events

... (truncated)

Commits

cc1f6cb Bump to 5.1.0 final

8effd15 Update message catalogs (#10698)

e3337c7 Update include_patterns implementation (#10680)

89db13d Merge pull request #10676 from AA-Turner/authors

40caf0c Merge pull request #10696 from jfbu/latex_fix_for_old_latex

d1b4a75 LaTeX: fix another incompatibility with old pict2e LaTeX

faccc21 Fix #10695: old LaTeX does not allow @ifpackageloaded usage in body

afac558 Merge branch '5.0.x' into 5.x

94f62e7 Merge pull request #10693 from tk0miya/mypy-0.971

5b89c39 Fix mypy violations (with mypy-0.971)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump mypy from 0.961 to 0.971
Bumps mypy from 0.961 to 0.971.

Commits

1f08cf4 Update version to 0.971

61c0064 Add back workaround to avoid confusing mypy.types and types in pyinfo (#13176)

d8d900c Update version to 0.971+dev

72fa325 Update version to 0.970

2132036 Handle cwd correctly in pyinfo (#13161) (#13162)

ee10d29 flush keepalives on operator assignment statements (#13144) (#13151)

88c1b85 [mypyc] Add LoadAddress op for PyFloat_Type & PyTuple_Type (#13078) (#13150)

d06dcf0 [0.970 backport] add typing_extensions.NamedTuple (#13149)

9f99400 Fix crash overriding partial-type attribute with method (#12943)

49b4b3d Don't add match_args for dataclasses and named tuples with --python-versi...

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump mypy from 0.971 to 0.991
Bumps mypy from 0.971 to 0.991.

Commits

b7788fc Update version to remove "+dev" for releasing 0.991

6077d19 manually CP typeshed #9130

ab0ea1e Fix crash with function redefinition (#14064)

592a9ce Fix another crash with report generation on namespace packages (#14063)

1650ae0 Update --no-warn-no-return docs for empty body changes (#14065)

b9daa31 Don't ignore errors in files passed on the command line (#14060)

02fd8a5 Filter out wasm32 wheel in upload-pypi.py (#14035)

131c8d7 Fix crash on inference with recursive alias to recursive instance (#14038)

1368338 Change version to 0.991+dev in preparation for the point release

b71dc3d Remove +dev from version

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump pytest from 7.1.2 to 7.2.0
Bumps pytest from 7.1.2 to 7.2.0.

Release notes

Sourced from pytest's releases.

7.2.0

pytest 7.2.0 (2022-10-23)

Deprecations

#10012: Update pytest.PytestUnhandledCoroutineWarning{.interpreted-text role="class"} to a deprecation; it will raise an error in pytest 8.

#10396: pytest no longer depends on the py library. pytest provides a vendored copy of py.error and py.path modules but will use the py library if it is installed. If you need other py.* modules, continue to install the deprecated py library separately, otherwise it can usually be removed as a dependency.

#4562: Deprecate configuring hook specs/impls using attributes/marks.

Instead use :pypytest.hookimpl{.interpreted-text role="func"} and :pypytest.hookspec{.interpreted-text role="func"}. For more details, see the docs <legacy-path-hooks-deprecated>{.interpreted-text role="ref"}.

#9886: The functionality for running tests written for nose has been officially deprecated.

This includes:

Plain setup and teardown functions and methods: this might catch users by surprise, as setup() and teardown() are not pytest idioms, but part of the nose support.

Setup/teardown using the @with_setup decorator.

For more details, consult the deprecation docs <nose-deprecation>{.interpreted-text role="ref"}.

Features

#9897: Added shell-style wildcard support to testpaths.

Improvements

#10218: @pytest.mark.parametrize() (and similar functions) now accepts any Sequence[str] for the argument names, instead of just list[str] and tuple[str, ...].

(Note that str, which is itself a Sequence[str], is still treated as a comma-delimited name list, as before).

#10381: The --no-showlocals flag has been added. This can be passed directly to tests to override --showlocals declared through addopts.

#3426: Assertion failures with strings in NFC and NFD forms that normalize to the same string now have a dedicated error message detailing the issue, and their utf-8 representation is expresed instead.

#7337: A warning is now emitted if a test function returns something other than [None]{.title-ref}. This prevents a common mistake among beginners that expect that returning a [bool]{.title-ref} (for example [return foo(a, b) == result]{.title-ref}) would cause a test to pass or fail, instead of using [assert]{.title-ref}.

#8508: Introduce multiline display for warning matching via :pypytest.warns{.interpreted-text role="func"} and enhance match comparison for :py_pytest._code.ExceptionInfo.match{.interpreted-text role="func"} as returned by :pypytest.raises{.interpreted-text role="func"}.

#8646: Improve :pypytest.raises{.interpreted-text role="func"}. Previously passing an empty tuple would give a confusing error. We now raise immediately with a more helpful message.

#9741: On Python 3.11, use the standard library's tomllib{.interpreted-text role="mod"} to parse TOML.

tomli{.interpreted-text role="mod"}` is no longer a dependency on Python 3.11.

#9742: Display assertion message without escaped newline characters with -vv.

#9823: Improved error message that is shown when no collector is found for a given file.

... (truncated)

Commits

3af3f56 Prepare release version 7.2.0

bc2c3b6 Merge pull request #10408 from NateMeyvis/patch-2

d84ed48 Merge pull request #10409 from pytest-dev/asottile-patch-1

ffe49ac Merge pull request #10396 from pytest-dev/pylib-hax

d352098 allow jobs to pass if codecov.io fails

c5c562b Fix typos in CONTRIBUTING.rst

d543a45 add deprecation changelog for py library vendoring

f341a5c Merge pull request #10407 from NateMeyvis/patch-1

1027dc8 [pre-commit.ci] auto fixes from pre-commit.com hooks

6b905ee Add note on tags to CONTRIBUTING.rst

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump sphinx from 5.1.1 to 5.3.0
Bumps sphinx from 5.1.1 to 5.3.0.

Release notes

Sourced from sphinx's releases.

v5.3.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.3.0 (released Oct 16, 2022)

#10759: LaTeX: add :confval:latex_table_style and support the 'booktabs', 'borderless', and 'colorrows' styles. (thanks to Stefan Wiehler for initial pull requests #6666, #6671)

#10840: One can cross-reference including an option value like :option:`--module=foobar```, :option:--module[=foobar]``` or ``:option:--module foobar```. Patch by Martin Liska.

#10881: autosectionlabel: Record the generated section label to the debug log.

#10268: Correctly URI-escape image filenames.

#10887: domains: Allow sections in all the content of all object description directives (e.g. :rst:dir:py:function). Patch by Adam Turner

Release 5.2.3 (released Sep 30, 2022)

#10878: Fix base64 image embedding in sphinx.ext.imgmath

#10886: Add :nocontentsentry: flag and global domain table of contents entry control option. Patch by Adam Turner

Release 5.2.2 (released Sep 27, 2022)

#10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

#10861: Always normalise the pycon3 lexer to pycon.

Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by

... (truncated)

Commits

c1f2a52 Bump to 5.3.0 final

10db540 Allow sections in object description directives (#10919)

0fd4539 Simplify bug report template

b58eb61 Update all GitHub actions workflows to Ubuntu latest

3e04952 Add sphinx-build --bug-report

fa6d425 URI-escape image filenames (#10268)

e008e16 Revert "Fix detection for out of date files (#9360)" (#10908)

cef1a03 Update image for LaTeX job (#10916)

b5ba1ed s/5.2.0/5.3.0 in various code comments as #10759 got merged in 5.3.0

3deb527 Update CHANGES for PR #10759

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0

Introduce a safe eval function

Hi there - I love this little library, but I think some utility functions would really be beneficial for migrating exception code to using results.

Some thoughts, similar to the dry-returns library, we should introduce a safe function for a following use case:

Imagine refactoring this piece of (very hypothetical code):

def foo(a, b, c):
    try:
        a(b, c)
    except ZeroDivisionError:
        raise ValueError("cannot divide by zero")
    except Exception:
        raise TypeError("What?")

It can be very easily refactored with the introduction of safe function:

from functools import wraps
from option.result import Result

def _safe(func):
    @wraps(func)
    def safe_chain(*args, **kwargs):
        z = Result.Ok(func)
        try:
            return z.map(lambda x: x(*args, **kwargs))
        except Exception as e:  # noqa
            return Result.Err(e)
    return safe_chain

then refactoring foo becomes:


def foo(a, b, c):
  a = _safe(a)
  rval = a(b, c)
  if rval.is_ok:
      return rval
  if rval.unwrap_err() is ZeroDivisionError:
      return Result.Err("cannot divide by zero")
  else:
      return Result.Err("what?")

This works very well for languages that do not support try/except for control flows, which is something that can be mapped to non-Turing complete language subsets such as Starlark.

Thoughts?

opened by mahmoudimus 1

Typed Return Type for `flatmap` contradicts documentation
The documentation for flatmap states: "This is different than Option.map() because the result of the callback isn’t wrapped in a new Option." This test verifies that behavior:

def test_flatmap_some(): assert_that(option.Some(4).flatmap(lambda x: x + 1), equal_to(5))

However, the return type of the function is specified to be Option[U].

What is the expected behavior flatmap?
opened by mrwizard82d1 5

Releases(v2.1.0)

v2.1.0(Apr 18, 2022)
What's Changed

Update dependencies and copyright year by @MaT1g3R in https://github.com/MaT1g3R/option/pull/4

Remove support for python 3.6 by @MaT1g3R in https://github.com/MaT1g3R/option/pull/9

[no release] Remove coverage by @MaT1g3R in https://github.com/MaT1g3R/option/pull/10

Enable mypy strict mode + add build-system requires in pyproject.toml by @saaketp in https://github.com/MaT1g3R/option/pull/8

New Contributors

@saaketp made their first contribution in https://github.com/MaT1g3R/option/pull/8

Full Changelog: https://github.com/MaT1g3R/option/commits/v2.1.0
Source code(tar.gz)
Source code(zip)

Owner

You can find my public key here: https://github.com/MaT1g3R/dotfiles/blob/master/peijun.ma%40protonmail.com.pub

GitHub https://mat1g3r.github.io/option/

Utilities for refactoring imports in python-like syntax.

aspy.refactor_imports Utilities for refactoring imports in python-like syntax. Installation pip install aspy.refactor_imports Examples aspy.refactor_i

20 Nov 1, 2022

Simple Python style checker in one Python file

pycodestyle (formerly called pep8) - Python style guide checker pycodestyle is a tool to check your Python code against some of the style conventions

4.7k Jan 1, 2023

Optional static typing for Python 3 and 2 (PEP 484)

Mypy: Optional Static Typing for Python Got a question? Join us on Gitter! We don't have a mailing list; but we are always happy to answer questions o

14.4k Jan 8, 2023

The strictest and most opinionated python linter ever!

wemake-python-styleguide Welcome to the strictest and most opinionated python linter ever. wemake-python-styleguide is actually a flake8 plugin with s

2.1k Jan 1, 2023

A plugin for Flake8 finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycodestyle.

flake8-bugbear A plugin for Flake8 finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycode

869 Dec 30, 2022

A Python Parser

parso - A Python Parser Parso is a Python parser that supports error recovery and round-trip parsing for different Python versions (in multiple Python

520 Dec 26, 2022

A simple program which checks Python source files for errors

Pyflakes A simple program which checks Python source files for errors. Pyflakes analyzes programs and detects various errors. It works by parsing the

1.2k Dec 30, 2022

Performant type-checking for python.

Pyre is a performant type checker for Python compliant with PEP 484. Pyre can analyze codebases with millions of lines of code incrementally – providi

6.2k Jan 4, 2023

A static type analyzer for Python code

pytype - ?? ✔ Pytype checks and infers types for your Python code - without requiring type annotations. Pytype can: Lint plain Python code, flagging c

4k Dec 31, 2022

Static type checker for Python

Static type checker for Python Speed Pyright is a fast type checker meant for large Python source bases. It can run in a “watch” mode and performs fas

9.2k Jan 3, 2023

Tool to check the completeness of MANIFEST.in for Python packages

check-manifest Are you a Python developer? Have you uploaded packages to the Python Package Index? Have you accidentally uploaded broken packages with

270 Dec 26, 2022

A python documentation linter which checks that the docstring description matches the definition.

Darglint A functional docstring linter which checks whether a docstring's description matches the actual function/method implementation. Darglint expe

463 Dec 31, 2022

Flake8 plugin that checks import order against various Python Style Guides

flake8-import-order A flake8 and Pylama plugin that checks the ordering of your imports. It does not check anything else about the imports. Merely tha

270 Nov 24, 2022

Flake8 extension for checking quotes in python

Flake8 Extension to lint for quotes. Major update in 2.0.0 We automatically encourage avoiding escaping quotes as per PEP 8. To disable this, use --no

157 Dec 13, 2022

Check for python builtins being used as variables or parameters

Flake8 Builtins plugin Check for python builtins being used as variables or parameters. Imagine some code like this: def max_values(list, list2):

98 Jan 8, 2023

flake8 plugin to run black for checking Python coding style

flake8-black Introduction This is an MIT licensed flake8 plugin for validating Python code style with the command line code formatting tool black. It

146 Dec 15, 2022

Custom Python linting through AST expressions

bellybutton bellybutton is a customizable, easy-to-configure linting engine for Python. What is this good for? Tools like pylint and flake8 provide, o

249 Dec 31, 2022

Unbearably fast O(1) runtime type-checking in pure Python.

Look for the bare necessities, the simple bare necessities. Forget about your worries and your strife. — The Jungle Book.

1.4k Jan 1, 2023

Naming Convention checker for Python

PEP 8 Naming Conventions Check your code against PEP 8 naming conventions. This module provides a plugin for flake8, the Python code checker. (It repl

411 Dec 23, 2022

Rust like Option and Result types in Python

Related tags

Overview

Option

Quick Start

Install

Documentation

License

Comments

Release 4.4.0 (October 6, 2022)

v5.2.3

v5.2.2

v5.2.1

v5.2.0

Release 5.2.3 (released Sep 30, 2022)

Release 5.2.2 (released Sep 27, 2022)

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

Release 5.2.0.post0 (released Sep 24, 2022)

Release 5.2.0 (released Sep 24, 2022)

Dependencies

Deprecated

Features added

7.1.3

pytest 7.1.3 (2022-08-31)

Bug Fixes

Improved Documentation

Trivial/Internal Changes

v5.1.0

Release 5.1.0 (released Jul 24, 2022)

Dependencies

Deprecated

Features added

Bugs fixed

7.2.0

pytest 7.2.0 (2022-10-23)

Deprecations

Features

Improvements

v5.3.0

v5.2.3

v5.2.2

v5.2.1

v5.2.0

Release 5.3.0 (released Oct 16, 2022)

Release 5.2.3 (released Sep 30, 2022)

Release 5.2.2 (released Sep 27, 2022)

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

Release 5.2.0.post0 (released Sep 24, 2022)

Release 5.2.0 (released Sep 24, 2022)

Dependencies

Releases(v2.1.0)

v2.1.0(Apr 18, 2022)

What's Changed

New Contributors

Owner

Utilities for refactoring imports in python-like syntax.

Simple Python style checker in one Python file

Optional static typing for Python 3 and 2 (PEP 484)

The strictest and most opinionated python linter ever!

A plugin for Flake8 finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycodestyle.

A Python Parser

A simple program which checks Python source files for errors

Performant type-checking for python.

A static type analyzer for Python code

Static type checker for Python

Tool to check the completeness of MANIFEST.in for Python packages

A python documentation linter which checks that the docstring description matches the definition.

Flake8 plugin that checks import order against various Python Style Guides

Flake8 extension for checking quotes in python

Check for python builtins being used as variables or parameters

flake8 plugin to run black for checking Python coding style

Custom Python linting through AST expressions

Unbearably fast O(1) runtime type-checking in pure Python.

Naming Convention checker for Python