gh-85583: Add overview of formatted string literals (f-strings) to str
#132689
+141
−3
Conversation
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
This comment was marked as resolved.
This comment was marked as resolved.
bedevere-app
bot
added
awaiting core review
docs
Co-authored-by: Ezio Melotti <[email protected]> Originally-authored-by: [email protected]
AA-Turner
force-pushed
the
docs/f-strings
branch
from
9641c06 to
8d4bf9c
Compare
AA-Turner
changed the title
strstr
There was a problem hiding this comment.
Also more links to other pages? e.g. lexical analysis
(Should the title not be "...to stdtypes"?)
| .. code-block:: pycon | ||
|
|
||
| >>> nationality = 'Spanish' | ||
| >>> f'The {name} Inquisition!' |
There was a problem hiding this comment.
Suggested change
| >>> f'The {name} Inquisition!' | |
| >>> f'The {nationality} Inquisition!' |
Error
| A single opening curly bracket, ``'{'``, marks a *replacement field* that | ||
| can contain any Python expression: | ||
|
|
||
| .. code-block:: pycon |
There was a problem hiding this comment.
Are these still needed, sphinx is smart enough to detect the '>>>' in other files, why should it be different here?
I see later you don't use it?
| Once the output has been evaluated, it can be formatted using a | ||
| :ref:`format specifier <formatstrings>` following a colon (``':'``). | ||
| After the expression has been evaluated, and possibly converted to a string, | ||
| the :meth:`__format__` method of the result is called with the format specifier, |
There was a problem hiding this comment.
Suggested change
| the :meth:`__format__` method of the result is called with the format specifier, | |
| the :meth:`~object.__format__` method of the result is called with the format specifier, |
Comment on lines
+2492
to
+2496
| For example: | ||
|
|
||
| .. code-block:: pycon | ||
|
|
||
| >>> who = 'nobody' |
There was a problem hiding this comment.
Suggested change
| For example: | |
| .. code-block:: pycon | |
| >>> who = 'nobody' | |
| For example:: | |
| >>> who = 'nobody' |
Comment on lines
+2501
to
+2505
| It is also possible to use a multi line f-string: | ||
|
|
||
| .. code-block:: pycon | ||
|
|
||
| >>> f'''This is a string |
There was a problem hiding this comment.
Suggested change
| It is also possible to use a multi line f-string: | |
| .. code-block:: pycon | |
| >>> f'''This is a string | |
| It is also possible to use a multi line f-string:: | |
| >>> f'''This is a string |
Comment on lines
+2526
to
+2530
| Functions can also be used, and :ref:`format specifier <formatstrings>`: | ||
|
|
||
| .. code-block:: pycon | ||
|
|
||
| >>> from math import sqrt |
There was a problem hiding this comment.
Suggested change
| Functions can also be used, and :ref:`format specifier <formatstrings>`: | |
| .. code-block:: pycon | |
| >>> from math import sqrt | |
| Functions can also be used, and :ref:`format specifier <formatstrings>`:: | |
| >>> from math import sqrt |
Comment on lines
+2534
to
+2538
| Any non-string expression is converted using :func:`str`, by default: | ||
|
|
||
| .. code-block:: pycon | ||
|
|
||
| >>> from fractions import Fraction |
There was a problem hiding this comment.
Suggested change
| Any non-string expression is converted using :func:`str`, by default: | |
| .. code-block:: pycon | |
| >>> from fractions import Fraction | |
| Any non-string expression is converted using :func:`str`, by default:: | |
| >>> from fractions import Fraction |
Comment on lines
+2553
to
+2557
| For example: | ||
|
|
||
| .. code-block:: pycon | ||
|
|
||
| >>> from fractions import Fraction |
There was a problem hiding this comment.
Suggested change
| For example: | |
| .. code-block:: pycon | |
| >>> from fractions import Fraction | |
| For example:: | |
| >>> from fractions import Fraction |
Comment on lines
+2570
to
+2574
| For example: | ||
|
|
||
| .. code-block:: pycon | ||
|
|
||
| >>> from fractions import Fraction |
There was a problem hiding this comment.
Suggested change
| For example: | |
| .. code-block:: pycon | |
| >>> from fractions import Fraction | |
| For example:: | |
| >>> from fractions import Fraction |
| the :meth:`__format__` method of the result is called with the format specifier, | ||
| or the empty string if no format specifier is given. | ||
| The formatted result is then used as the final value for the replacement field. | ||
| For example: |
There was a problem hiding this comment.
Suggested change
| For example: | |
| For example:: |
Is it not required?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Replaces #21552.
📚 Documentation preview 📚: https://cpython-previews--132689.org.readthedocs.build/en/132689/library/stdtypes.html#formatted-string-literals-f-strings