-
Notifications
You must be signed in to change notification settings - Fork 58
Improve public API type annotations & fix unit test type errors #248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
kafka.conversion.from_binary() and from_structured() return AnyCloudEvent type var according to their event_type argument, but when event_type is None, type checkers cannot infer the return type. We now use an overload to declare that the return type is http.CloudEvent when event_type is None. Previously users had to explicitly annotate this type when calling without event_type. This happens quite a lot in this repo's test_kafka_conversions.py — this fixes quite a few type errors like: > error: Need type annotation for "result" [var-annotated] Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
The v1.Event self-returning Set*() methods like SetData() were returning BaseEvent, which doesn't declare the same Set* methods. As a result, chaining more than one Set* method would make the return type unknown. This was causing type errors in test_event_pipeline.py. The Set*() methods now return the Self type. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
mypy was failing with lots of type errors in test modules. I've not annotated all fixtures, mostly fixed existing type errors. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
from_http() conversion function was requiring its headers argument to be a typing.Dict, which makes it incompatible with headers types of http libraries, which support features like multiple values per key. typing.Mapping and even _typeshed.SupportsItems do not cover these types. For example, samples/http-image-cloudevents/image_sample_server.py was failing to type check where it calls `from_http(request.headers, ...)`. To support these kind of headers types in from_http(), we now define our own SupportsDuplicateItems protocol, which is broader than _typeshed.SupportsItems. I've only applied this to from_http(), as typing.Mapping is OK for most other methods that accept dict-like objects, and using this more lenient interface everywhere would impose restrictions on our implementation, even though it might be more flexible for users. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
Tox now runs mypy on cloudevents itself, and the samples. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
Mapping imposes less restrictions on callers, because it's read-only and allows non-dict types to be passed without copying them as dict(), or passing dict-like values and ignoring the resulting type error. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
Tests were failing because the sanic dependency dropped support for py3.8 in its current release. sanic is now pinned to the last compatible version for py3.8 only. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
Thanks for running CI, I see mypy failed, I should be able to fix it up later on. |
Thank you for the PR. I haven't got the time to review it yet, but hope to allocate some soon. |
Pydantic added by_alias and by_name keyword arguments to BaseModel.model_validate_json in 2.11.1: pydantic/pydantic@acb0f10 This caused mypy to report that that the Pydantic v2 CloudEvent did not override model_validate_json() correctly. Our override now accepts these newly-added arguments. They have no effect, as the implementation does not use Pydantic to validate the JSON, but we also don't use field aliases, so the only effect they could have in the superclass would be to raise an error if they're both False. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
Cool, that's no problem. CI should pass now (passes in my fork). There's a chance that a dependency will update and drop Python 3.8 support as it's out of support, which could cause mypy to fail. Currently |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@h4l overall LGTM. I'm hesitant regarding the SupportsDuplicateItems
usage while it breaks the existing typing APIs and will be a breaking change for the library users. We need to make it work without narrowing down the typings
Thanks for looking at this. I'll take another look at the changes around |
Although our types.SupportsDuplicateItems type is wider than Dict and Mapping, it's not a familar type to users, so explicitly accepting Mapping in the from_http() functions should make it more clear to users that a dict-like object is required for the headers argument. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
@xSAVIKx I just had a look into this and pushed an update. The I needed to widen the type originally because HTTP header types from libraries like requests do not satisfy Dict/Mapping, so using these types on Does that help with your concern? If not perhaps I've misunderstood you. I also needed to stop running CI/mypy against Python 3.8 because it's now well out of support, and multiple dependencies are shipping versions that mypy fails on with 3.8 compatibility. I've also added 3.12 and 3.13 to the the CI matrix. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@h4l , you had the 3.8 support prior to the latest change I believe, right? I'd rather keep it if possible for this change and then remove support for it in a separate PR. I understand it requires outdated dependencies which is fine imo. Otherwise the typings we're using I believe all were already supported by 3.8, right?
@xSAVIKx yes, 3.8 was working when I opened the PR. However because the repo has un-pinned dependencies in requirements.txt without a lockfile, some deps have new versions now that no longer work with 3.8. We can keep 3.8 but it will mean adding extra rules to requirements.txt to pin deps to old versions. I could do that if you prefer though. (Type checking was failing because of this when I made this change today.) |
I'd say pinning versions with Python version checks makes sense. And those were test dependencies only, right? |
Thanks a lot for your efforts @h4l 🙏 |
Python 3.8 is unsupported and dependencies (such as pydantic) are now shipping releases that fail to type check with mypy running in 3.8 compatibility mode. We run mypy in py 3.8 compatibility mode, so the mypy tox environments must only use deps that support 3.8. And unit tests run by py 3.8 must only use deps that support 3.8. To constrain the deps for 3.8 support, we use two constraint files, one for general environments that only constrains the dependencies that python 3.8 interpreters use, and another for mypy that constraints the dependencies that all interpreters use. Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
@xSAVIKx no problem!
There are two deps causing trouble at the moment,
|
Hey, thanks for the Python
cloudevents
library, I've been using it (viafunctions_framework
). In working with it I've noticed a few ways the types of your API could be tweaked to make things smoother for users. Also, while looking into the code, I noticed there were quite a few type errors in the test modules when running mypy, and mypy wasn't being run in CI to enforce the types. I figured I could help with that while offering some tweaks to the public API types.Changes
This PR:
@overload
s forfrom_binary
andfrom_structured
to correctly type the return when theevent_type
arg is NoneSet*()
methods oncloudevents.sdk.event.v1.Event
(previously you couldn't chain more than one call without type errors, as the return type did not haveSet*
methods)from_http()
conversion functions. They were requiring real dict types, so passing a headers object from an http request object would be a type error.from_dict()
) are now typed to takeMapping
rather than the exactdict
type, to allow passing dict-like objects, as well as read-only dicts.-> None:
function returns.One line description for the changelog
Improve public API type annotations, fix type errors in tests/examples and run type checks in CI
Tests pass
Appropriate changes to README are included in PR