Skip to content

Commit

Permalink
[3.11] gh-105578: Add more usage examples to typing.AnyStr docs (GH…
Browse files Browse the repository at this point in the history
…-107045) (#107504)

gh-105578: Add more usage examples to `typing.AnyStr` docs (GH-107045)

``typing.AnyStr`` has different semantics to ``str | bytes``, which often leads to user confusion
(cherry picked from commit f877b32)

Co-authored-by: Michael The <michael-the1@users.noreply.github.com>
  • Loading branch information
miss-islington and michael-the1 committed Jul 31, 2023
1 parent 1b40431 commit 3de42bb
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Doc/library/typing.rst
Expand Up @@ -801,6 +801,21 @@ using ``[]``.
concat(b"foo", b"bar") # OK, output has type 'bytes'
concat("foo", b"bar") # Error, cannot mix str and bytes

Note that, despite its name, ``AnyStr`` has nothing to do with the
:class:`Any` type, nor does it mean "any string". In particular, ``AnyStr``
and ``str | bytes`` are different from each other and have different use
cases::

# Invalid use of AnyStr:
# The type variable is used only once in the function signature,
# so cannot be "solved" by the type checker
def greet_bad(cond: bool) -> AnyStr:
return "hi there!" if cond else b"greetings!"

# The better way of annotating this function:
def greet_proper(cond: bool) -> str | bytes:
return "hi there!" if cond else b"greetings!"

.. data:: LiteralString

Special type that includes only literal strings.
Expand Down

0 comments on commit 3de42bb

Please sign in to comment.