add typing information #475

ds-cbo · 2023-01-25T17:07:31Z

add typing stubs to help IDE's and type checkers such as mypy and pyright

This deprecates the outdated https://github.com/ryanwang520/voluptuous-stubs

alecthomas

I like the idea, but can't we just add the annotations to voluptuous directly? I'm okay with dropping support for older Pythons that don't support it.

ds-cbo · 2023-01-26T09:47:51Z

That's also fine. I didn't want to drop support just yet, but with your approval I'll merge them into the source :)

voluptuous/humanize.py

alecthomas · 2023-01-26T18:06:06Z

voluptuous/tests/tests.py


+Enum: typing.Union[type, None]


Oh, huh, I've never seen this syntax before, TIL.

Usually you won't have to do this because the type can be inferred from context, but here it assumed it's always a type due to the import and then complains about the = None in the except ModuleError, so you'll have to be a bit more explicit :)

ds-cbo · 2023-01-27T08:57:01Z

I'm not quite sure why CI is failing:

   File "/opt/hostedtoolcache/Python/3.10.9/x64/lib/python3.10/site-packages/tox_setuptools_version/hooks.py", line 8, in <module>
    from tox.config import Config
ImportError: cannot import name 'Config' from 'tox.config' (/opt/hostedtoolcache/Python/3.10.9/x64/lib/python3.10/site-packages/tox/config/__init__.py)

bluefish6 · 2023-02-02T14:35:44Z

I'm not quite sure why CI is failing:

This repo uses tox-setuptools-version, which states:

This is a tox plugin that preinstalls a specific version of setuptools in each tox environment.

Note: This relies on an unstable tox plugin interface. You may experience breakage with new tox versions. If you do, please feel free to report the issue on Github.

seems like nobody reported the issue ;)

It seems that tox-setuptools-version is not neccessary anymore, as setuptools pinning was already removed here: Extend README to include coverage run commands + unpin setupstools #465
Please try to remove the Install tox-setuptools-version (lines 34-37) step of the test job and maybe it will start working :)

ds-cbo · 2023-02-09T09:11:49Z

@alecthomas Could you perhaps approve running the workflows to check whether that was indeed the fix?

spacegaier · 2023-02-09T09:52:39Z

@alecthomas Could you perhaps approve running the workflows to check whether that was indeed the fix?

Approved, but unfortunately there are still failures

ds-cbo · 2023-02-09T13:20:52Z

    def __init__(self, message: str, path: typing.List[str] | None = None, error_message: str | None = None, error_type: str | None = None) -> None:
TypeError: unsupported operand type(s) for |: '_GenericAlias' and 'NoneType'

Ah, I think the Type | None syntax is too new for versions below py-310. I'll rewrite them to typing.Optional[Type] soon, that should fix it

spacegaier · 2023-02-09T17:43:22Z

Getting there step-by-step :) . 2.7 is not yet happy and neither is flake8. 3.6 does not seem to exist as Github actions (anymore)?

alecthomas · 2023-02-09T19:38:29Z

Feel free to drop 2.7 if you like.

bluefish6 · 2023-02-09T21:34:44Z

3.6 does not seem to exist as Github actions (anymore)?

Judging by the content of available python versions, it's still there, but only if you're running the job on ubuntu 20.04. However, as stated in the job log, ubuntu 22.04 is used. So either python 3.6 would need to be not tested anymore, or ubuntu-20.04 would need to be specified instead of ubuntu-latest in the workflow definition.

As Python 3.6 reached End Of Life at the end of 2021 (after 5 years from release, more than 1 year ago), I would like to suggest to the Voluptuous maintainers to consider dropping active support for it.

alecthomas · 2023-02-10T06:54:23Z

As Python 3.6 reached End Of Life at the end of 2021 (after 5 years from release, more than 1 year ago), I would like to suggest to the Voluptuous maintainers to consider dropping active support for it.

Definitely works for me!

ds-cbo · 2023-02-13T08:16:51Z

Should be another step closer :)

alecthomas · 2023-02-13T09:39:00Z

🤞

alecthomas · 2023-02-13T09:39:16Z

Success!

alecthomas · 2023-02-13T09:41:29Z

Lovely, thank you!

yilei · 2023-02-17T19:12:16Z

voluptuous/schema_builder.py

@@ -1148,7 +1159,7 @@ class Required(Marker):
 {'key': []}
 """

- def __init__(self, schema, msg=None, default=UNDEFINED, description=None):
+ def __init__(self, schema: dict, msg: typing.Optional[str] = None, default=UNDEFINED, description: typing.Optional[str] = None) -> None:


Is this correct? Required can also take other scalar types e.g. the example in its docstring: schema = Schema({Required('key'): str})

No I don't think it is. Want to send a PR?

Ah, I've overlooked that one. Commit coming up

antoni-szych-rtbhouse · 2023-12-11T18:50:13Z

Hi @ds-cbo, I've updated the typings to allow integers in paths in #497 (useful to show that the validation failed for e.g. 5th element of some list), but wanted to confirm with you - was there any special reason you decided to allow only strings in path?

ds-cbo · 2023-12-12T10:16:09Z

Hi @ds-cbo, I've updated the typings to allow integers in paths in #497 (useful to show that the validation failed for e.g. 5th element of some list), but wanted to confirm with you - was there any special reason you decided to allow only strings in path?

Answered in #497

m-aciek · 2024-02-23T14:54:18Z

voluptuous/schema_builder.py

@@ -7,6 +9,9 @@

 import itertools
 from voluptuous import error as er
+from collections.abc import Generator
+import typing
+from voluptuous.error import Error


Error could have been used as er.Error and this import would be not needed

ds-cbo added 2 commits January 25, 2023 18:06

add typing information

d05b161

add py.typed file to indicate that typing information is available

803f7db

alecthomas reviewed Jan 25, 2023

View reviewed changes

ds-cbo added 2 commits January 26, 2023 13:41

merge typing information

3908efa

more typing info

9946746

alecthomas approved these changes Jan 26, 2023

View reviewed changes

Remove tox-setuptools-version from CI

2e78f5e

replace |None with typing.Optional for backwards compat

1df2161

ds-cbo added 2 commits February 13, 2023 09:15

Drop support for Python 2.7 and 3.6

b8a1cdb

Make flake8 happy

af8cf03

Also remove python 2.7 and 3.6 from github workflow

92efd94

alecthomas approved these changes Feb 13, 2023

View reviewed changes

alecthomas merged commit bd2f9ad into alecthomas:master Feb 13, 2023

ds-cbo deleted the generate-stub branch February 13, 2023 15:03

yilei reviewed Feb 17, 2023

View reviewed changes

ds-cbo mentioned this pull request Feb 20, 2023

Fix type hint of schemas, for example for Required('key') #478

Merged

KapJI mentioned this pull request Nov 11, 2023

Publish new release #485

Closed

antoni-szych-rtbhouse mentioned this pull request Dec 11, 2023

fix: allow path to be a list of strings, integers or any other hashables #497

Merged

m-aciek reviewed Feb 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add typing information #475

add typing information #475

ds-cbo commented Jan 25, 2023 •

edited

Loading

alecthomas left a comment

ds-cbo commented Jan 26, 2023

alecthomas Jan 26, 2023

ds-cbo Jan 27, 2023

ds-cbo commented Jan 27, 2023

bluefish6 commented Feb 2, 2023

ds-cbo commented Feb 9, 2023

spacegaier commented Feb 9, 2023

ds-cbo commented Feb 9, 2023

spacegaier commented Feb 9, 2023

alecthomas commented Feb 9, 2023

bluefish6 commented Feb 9, 2023 •

edited

Loading

alecthomas commented Feb 10, 2023

ds-cbo commented Feb 13, 2023

alecthomas commented Feb 13, 2023

alecthomas commented Feb 13, 2023

alecthomas commented Feb 13, 2023

yilei Feb 17, 2023

alecthomas Feb 17, 2023

ds-cbo Feb 20, 2023

antoni-szych-rtbhouse commented Dec 11, 2023

ds-cbo commented Dec 12, 2023

m-aciek Feb 23, 2024

add typing information #475

add typing information #475

Conversation

ds-cbo commented Jan 25, 2023 • edited Loading

alecthomas left a comment

Choose a reason for hiding this comment

ds-cbo commented Jan 26, 2023

alecthomas Jan 26, 2023

Choose a reason for hiding this comment

ds-cbo Jan 27, 2023

Choose a reason for hiding this comment

ds-cbo commented Jan 27, 2023

bluefish6 commented Feb 2, 2023

ds-cbo commented Feb 9, 2023

spacegaier commented Feb 9, 2023

ds-cbo commented Feb 9, 2023

spacegaier commented Feb 9, 2023

alecthomas commented Feb 9, 2023

bluefish6 commented Feb 9, 2023 • edited Loading

alecthomas commented Feb 10, 2023

ds-cbo commented Feb 13, 2023

alecthomas commented Feb 13, 2023

alecthomas commented Feb 13, 2023

alecthomas commented Feb 13, 2023

yilei Feb 17, 2023

Choose a reason for hiding this comment

alecthomas Feb 17, 2023

Choose a reason for hiding this comment

ds-cbo Feb 20, 2023

Choose a reason for hiding this comment

antoni-szych-rtbhouse commented Dec 11, 2023

ds-cbo commented Dec 12, 2023

m-aciek Feb 23, 2024

Choose a reason for hiding this comment

ds-cbo commented Jan 25, 2023 •

edited

Loading

bluefish6 commented Feb 9, 2023 •

edited

Loading