8000 Add explanation of singletons in unions to PEP484 by ilevkivskyi · Pull Request #240 · python/typing · GitHub
[go: up one dir, main page]

Skip to content

Add explanation of singletons in unions to PEP484 #240

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

Merged
merged 3 commits into from
Jul 5, 2016
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Response to comments, added one more example, corrected a typo
  • Loading branch information
ilevkivskyi committed Jul 5, 2016
commit 28f9095199da4e9d2db955d5e6bcf756302afadf
25 changes: 20 additions & 5 deletions pep-0484.txt
Original file line number Diff line number Diff line change
Expand Up @@ -851,8 +851,8 @@ Support for singleton types in unions
-------------------------------------

A singleton instance is frequently used to mark some special condition,
in particular in situations when ``None`` is a valid value for a variable.
Example::
in particular in situations where ``None`` is also a valid value
for a variable. Example::

_empty = object()

Expand All @@ -866,7 +866,7 @@ Example::

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 could be caught statically::
by the standard library, so that type errors can be caught statically::

from typing import Union
from enum import Enum
Expand All @@ -886,9 +886,24 @@ by the standard library, so that type errors could be caught statically::
else: # At this point typechecker knows that x can only have type int
return x * 2

Since the subclasses of ``Enum`` could not be further subclassed,
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.
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:
Copy link
Contributor

Choose a reason for hiding this comment

The 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
Expand Down
0