-
Notifications
You must be signed in to change notification settings - Fork 246
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
Add explanation of singletons in unions to PEP484 #240
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -846,6 +846,66 @@ This is equivalent to:: | |
|
||
def handle_employee(e: Optional[Employee] = None) -> None: ... | ||
|
||
|
||
Support for singleton types in unions | ||
------------------------------------- | ||
|
||
A singleton instance is frequently used to mark some special condition, | ||
in particular in situations where ``None`` is also a valid value | ||
for a variable. Example:: | ||
|
||
_empty = object() | ||
|
||
def func(x=_empty): | ||
if x is _empty: # default argument value | ||
return 0 | ||
elif x is None: # argument was provided and it's None | ||
return 1 | ||
else: | ||
return x * 2 | ||
|
||
To allow precise typing in such situations, the user should use | ||
the ``Union`` type in conjuction with the ``enum.Enum`` class provided | ||
by the standard library, so that type errors can be caught statically:: | ||
|
||
from typing import Union | ||
from enum import Enum | ||
|
||
class Empty(Enum): | ||
token = 0 | ||
_empty = Empty.token | ||
|
||
def func(x: Union[int, None, Empty]=_empty) -> int: | ||
|
||
boom = x * 42 # This fails type check | ||
|
||
if x is _empty: | ||
return 0 | ||
elif x is None: | ||
return 1 | ||
else: # At this point typechecker knows that x can only have type int | ||
return x * 2 | ||
|
||
Since the subclasses of ``Enum`` cannot be further subclassed, | ||
the type of variable ``x`` can be statically inferred in all branches | ||
of the above example. The same approach is applicable if more than one | ||
singleton object is needed: one can use an enumeration that has more than | ||
one value:: | ||
|
||
class Reason(Enum): | ||
timeout = 1 | ||
error = 2 | ||
|
||
def process(response: Union[str, Reason]='') -> str: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar to above, spaces around |
||
if response is Reason.timeout: | ||
return 'TIMEOUT' | ||
elif response is Reason.error: | ||
return 'ERROR' | ||
else: | ||
# response can be only str, all other possible values exhausted | ||
return 'PROCESSED: ' + response | ||
|
||
|
||
The ``Any`` type | ||
---------------- | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Style nit: add spaces around
=
.