Skip to content
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

Relax TypeDecorator.process_*_param to return Optional[Any] #206

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

huonw
Copy link

@huonw huonw commented Jan 25, 2021

The process_bind_param and process_literal_param methods are called to
do decorator-specific conversion of values, before deferring to the
underlying .impl's conversion methods. This means they can return any
value accepted by those methods, not just str (or typing.Text). These
are related to the process_result_value method, which is effectively
the inverse, doing decorator-specific conversion of the output of the
underlying .impl, and indeed this method accepts value: Optional[Any],
representing the unknown type of the output of the underlying .impl.

Unfortunately, modelling this accurately is likely to be
impossible (or at least, much more difficult), because, for instance,
the impl property itself can only be typed as Any, let alone the
input/output type it uses.

Fixes #205

The process_bind_param and process_literal_param methods are called to
do decorator-specific conversion of values, before deferring to the
underlying .impl's conversion methods. This means they can return any
value accepted by those methods, not just str (or typing.Text). These
are related to the process_result_value method, which is effectively
the inverse, doing decorator-specific conversion of the output of the
underlying .impl, and indeed this method accepts value: Optional[Any],
representing the unknown type of the output of the underlying .impl.

Unfortunately, modelling this accurately is likely to be
impossible (or at least, much more difficult), because, for instance,
the `impl` property itself can only be typed as `Any`, let alone the
input/output type it uses.

Fixes dropbox#205
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TypeDecorator.process_bind_param can return more than Optional[Text]
2 participants