Skip to content

gh-105578: Add more usage examples to typing.AnyStr docs #107045

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.

Sign up for GitHub

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
AlexWaygood merged 5 commits into from
Jul 31, 2023
Merged

gh-105578: Add more usage examples to typing.AnyStr docs #107045

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a3be84b
Add more usage examples to typing.AnyStr
michael-the1 Jul 22, 2023
202b372
Clarify extra examples
michael-the1 Jul 23, 2023
1fa3471
Improve comments surrounding new AnyStr examples
michael-the1 Jul 25, 2023
78e7254
stray "OK" comment
AlexWaygood Jul 26, 2023
2cb6a5f
Remove sentence in `AnyStr` docs
michael-the1 Jul 30, 2023
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
Next Next commit
Add more usage examples to typing.AnyStr
  • Loading branch information
@michael-the1
michael-the1 committed Jul 22, 2023
commit a3be84bc956a4c9b6952d2c7c0635ce9b24f3609
16 changes: 16 additions & 0 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -849,6 +849,22 @@ using ``[]``.
concat(b"foo", b"bar") # OK, output has type 'bytes'
concat("foo", b"bar") # Error, cannot mix str and bytes

Note that ``AnyStr`` and ``str | bytes`` are different from each other and
have different use cases. ``str | bytes`` does allow you to mix str and bytes::

def concat(a: str | bytes, b: str | bytes) -> str | bytes:
return a + b

concat("foo", b"bar") # Passes typecheck but raises an error at runtime
Comment thread
AlexWaygood marked this conversation as resolved.
Outdated

As a type variable, ``AnyStr`` is only used if it's at least part of the input arguments::
Comment thread
AlexWaygood marked this conversation as resolved.
Outdated

def greet_bad(cond: bool) -> AnyStr:
return "hi there!" if cond else b"greetings!" # Error
Comment thread
michael-the1 marked this conversation as resolved.
Outdated

def greet_proper(cond: bool) -> str | bytes:
return "hi there!" if cond else b"greetings!" # OK
Comment thread
michael-the1 marked this conversation as resolved.
Outdated

.. data:: LiteralString

Special type that includes only literal strings.
Expand Down