Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
26 changes: 15 additions & 11 deletions concepts/string-formatting/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Some examples:
```

Replacement fields (_the `{}` in the f-string_) support output control mechanisms such as width, alignment, precision.
This specification is started in the [format specification mini-language][format-mini-language].
This is defined by the [format specification mini-language][format-mini-language].

A more complex example of an `f-string` that includes output control:

Expand All @@ -59,24 +59,25 @@ A more complex example of an `f-string` that includes output control:
# Reassigning verb to 'meet'.
>>> verb = 'meet'

# This example includes a function, str, a nested f-string, an arithmetic expression,
# This example includes a function, an arithmetic expression,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the new specifications are explicit about both nesting and not needing to switch out the quotes, should we now include examples of nesting and switching quotes so that escapes don't get applied in results?

# precision formatting, bracket escaping and object formatting.
>>> f'"Have a {"NICE".lower()} day, I will {verb} you after {f"{30e8 * 111_000:6.{precision}e}"} light-years."{{{the_end}}}'
>>> f'"Have a {"NICE".lower()} day, I will {verb} you after {30e8 * 111_000:6.{precision}e} light-years."{{{the_end}}}'
'"Have a nice day, I will meet you after 3.330e+14 light-years."{[\'end\', \'of\', \'transmission\']}'
```

There are a few limitations to be aware of.
`f-string` expressions cannot be empty, they cannot contain comments.
There are two main limitations to be aware of.
`f-string` expressions cannot be empty.
[Additionally, before Python 3.12, they cannot contain comments.][pep-0701]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Additionally, before Python 3.12, they cannot contain comments.][pep-0701]
[Additionally, before Python 3.12, they could not contain comments.][pep-0701]


```python
>>> f"An empty expression will error: {}"
SyntaxError: f-string: empty expression not allowed

>>> word = 'word'
>>> f"""A comment in a triple quoted f-string will error: {
>>> f"""A comment in a triple quoted f-string: {
word # I chose a nice variable
}"""
SyntaxError: f-string expression part cannot include '#'
'A comment in a triple quoted f-string: word'
```

~~~~exercism/caution
Expand Down Expand Up @@ -105,7 +106,7 @@ The complete formatting specifier pattern is `{[<name>][!<conversion>][:<format_
- `<name>` can be a named placeholder or a number or empty.
- `!<conversion>` is optional and should be one of this three conversions: `!s` for [`str()`][str-conversion], `!r` for [`repr()`][repr-conversion] or `!a` for [`ascii()`][ascii-conversion].
By default, `str()` is used.
- `:<format_specifier>` is optional and has a lot of options, which we are [listed here][format-specifiers].
- `:<format_specifier>` is optional and has a lot of options, which are [listed here][format-specifiers].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to go into some detail here with different number formatting/alignment, since it's pretty common for formatting outputs in a table. Trey Hunner has some good examples.


Example of conversions for a diacritical letter:

Expand Down Expand Up @@ -178,7 +179,9 @@ If you want to add multiple variables to a string, you need to supply a [tuple][
## Template Strings

[`string.Template()`][string.Template()] is a class from the `string` module (_as opposed to the built-in `str` type_), which is part of the Python standard library, but has to be imported for use.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[`string.Template()`][string.Template()] is a class from the `string` module (_as opposed to the built-in `str` type_), which is part of the Python standard library, but has to be imported for use.
[`string.Template()`][string.Template()] (_not to be confused with Python 3.14 [t-strings](https://realpython.com/python-t-strings/)_) is a class from the `string` module (_as opposed to the built-in `str` type_), which is part of the Python standard library, but has to be imported for use.

Template strings support `$`-based substitution and are much simpler and less capable than the other options mentioned here, but can be very useful for when complicated internationalization is needed, or outside inputs need to be sanitized.
Template strings support `$`-based substitution and are much simpler and less capable than the other options mentioned here.
However, they can be very useful for when complicated internationalization is needed, or outside inputs need to be sanitized.
`string.Template` is considered safer for untrusted user input because it prevents evaluating arbitrary expressions or accessing object attributes, which mitigates format-string injection attacks.

```python
>>> from string import Template
Expand All @@ -204,8 +207,8 @@ A few quick guidelines:
If you don't need to internationalize, they should be the Python 3.6+ preferred method.
2. `str.format()` is versatile, very powerful and compatible with both `gnu gettext` and most versions of Python.
3. If simplicity, safety, and/or heavy internationalization is what you need, `string.Template()` can be used to mitigate risks when inputs from users need to be handled, and for wrapping translation strings.
4. The `%` operator is not supported in some newer distributions of Python and should mostly be used for compatibility with old code.
`%` formatting` can lead to issues displaying non-ascii and unicode characters and has more errors and less functionality than other methods.
4. The `%` operator is generally considered deprecated for new code, though it still works in modern Python. It should mostly be used for compatibility with older codebases.
`%` formatting can lead to issues displaying non-ASCII and Unicode characters and has more errors and less functionality than other methods. Check your specific Python distribution for support details if you intend to use it.

If you want to go further: [all about formatting][all-about-formatting] and [Python String Formatting Best Practices][formatting best practices] are good places to start.

Expand All @@ -216,6 +219,7 @@ If you want to go further: [all about formatting][all-about-formatting] and [Pyt
[format-specifiers]: https://www.python.org/dev/peps/pep-3101/#standard-format-specifiers
[formatting best practices]: https://realpython.com/python-string-formatting/
[pep-0498]: https://peps.python.org/pep-0498
[pep-0701]: https://peps.python.org/pep-0701/
[printf-style-docs]: https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting
[repr-conversion]: https://www.w3resource.com/python/built-in-function/repr.php
[str-conversion]: https://www.w3resource.com/python/built-in-function/str.php
Expand Down
22 changes: 12 additions & 10 deletions concepts/string-formatting/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@
## String Formatting in Python

The [Zen of Python][zen-of-python] asserts there should be "one _obvious_ way to do something in Python".
But when it comes to string formatting, things are a little .... _less zen_.
It can be surprising to find out that there are **four** main ways to perform string formatting in Python - each for a different scenario.
Some of this is due to Python's long history and some of it is due to considerations like internationalization or input sanitation.
For Python 3.6+, **literal string interpolation** (**`f-strings`**) is often the obvious and preferred way to format strings:

With 4 different paths to take, how do you decide what to use?
```python
>>> adjective = "easy"
>>> f"This is an {adjective} way to format strings!"
'This is an easy way to format strings!'
```

1. `f-strings` are the newest and easiest to read.
If you don't need to internationalize, they should be the Python 3.6+ preferred method.
2. `str.format()` is versatile, very powerful and compatible with both `gnu gettext` and most versions of Python.
3. If simplicity, safety, and/or heavy internationalization is what you need, `string.Template()` can be used to mitigate risks when inputs need to be handled and for wrapping translation strings.
4. The `%` operator should mostly be used for compatibility with old code.
`%` formatting` can lead to issues displaying non-ascii and unicode characters and has more errors and less functionality than other methods.
However, given Python's long history and different considerations, it might not be surprising that there are **three** other common ways to perform string formatting in Python:

1. `str.format()` is versatile, very powerful and compatible with both `gnu gettext` and most versions of Python.
2. If simplicity, safety, and/or heavy internationalization is what you need, `string.Template()` can be used to mitigate risks when inputs need to be handled and for wrapping translation strings.
3. The `%` operator is generally considered deprecated for new code, though it still works in modern Python.
It should mostly be used for compatibility with older codebases. `%` formatting can lead to issues displaying non-ASCII and Unicode characters and has more errors and less functionality than other methods.Check your specific Python distribution for support details if you intend to use it.

If you want to go further: [all about formatting][all-about-formatting] and [Python String Formatting Best Practices][formatting best practices] are good places to start.

Expand Down
Loading