Using TypedDict to type check **kwargs #3123
Replies: 1 comment 3 replies
-
|
I'm a bit torn on this, because being able to provide API parameters for arbitrary endpoints directly as function arguments makes this library more convenient to use and the user code more pythonic. On the other hand I assume without moving to |
Beta Was this translation helpful? Give feedback.
-
The TypedDict means a fixed keys. I believe it is impossible to have a TypedDict where only some keys have fixed keys and typed values.
Isn't it more explicit to have a dedicated keyword argument to add extra HTTP query instead of implicitly converting extra arguments. |
Beta Was this translation helpful? Give feedback.
-
|
That's true. My thinking was more that for the higher-level functions, most of the time the query parameters are the only arguments users need to care about, and it's the other arguments that are more like extra args. So it feels more natural (to me) to use them like that as arguments rather than nesting them in a dict. For some custom methods/endpoints for example, we even expose them directly. But maybe we should think about having a dedicated object that we can validate a bit in the long run. I think @JohnVillalovos had some similar ideas in the past regarding this, though. |
Beta Was this translation helpful? Give feedback.
-
|
It should be possible to have common and documented HTTP query parameters to still have named keys in the TypedDict. For example, |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Currently the most of the methods that have an underlying HTTP request takes a
**kwargs: Anyarguments that passed down to the HTTP handling functions. For example, it can betimeoutorextra_headers.However, because they are using
Anythere is no type checking on the arguments used. This means a wrong argument name can be used.To type hint
**kwargsaTypedDictcombined withUnpackcan be used:https://peps.python.org/pep-0692/
https://docs.python.org/3/library/typing.html#typing.Unpack
One of the issues implementing this can be that all unused
kwargswill be converted in to an HTTP query args in thehttp_requestfunction. However, there is already aquery_parametersargument that was added to avoid collisions. Maybe make thequery_parametersthe official way of adding extra http query and leave the extra kwargs only for backwards compatibility.Beta Was this translation helpful? Give feedback.
All reactions