8000 gh-132661: Document t-strings and `templatelib` by davepeck · Pull Request #135229 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-132661: Document t-strings and templatelib #135229

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

Open
wants to merge 51 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
5a8dbfa
Initial commit.
davepeck Jun 6, 2025
09a1e9e
Make clear the preceding discussion about t-strings creating an insta…
pauleveritt Jun 8, 2025
ec44c2b
Get the import order sorted.
pauleveritt Jun 8, 2025
d8904b6
Correct the Interpolation() calls.
pauleveritt Jun 8, 2025
550aa6d
Add documentation for Interpolation.
pauleveritt Jun 8, 2025
a20e058
Convert to use Sphinx modifiers for type, returns, and rtype.
pauleveritt Jun 8, 2025
1f30739
Add an entry to the glossary.
pauleveritt Jun 8, 2025
d935dd6
Find any occurrences of f-strings that should also mention t-strings.
pauleveritt Jun 8, 2025
1e47362
Fix doctests for str.templatelib
davepeck Jun 12, 2025
7b660be
Start writing the t-strings part of lexical analysis
davepeck Jun 12, 2025
00a535d
Merge branch 'main' into docs/pep750-first-pass
davepeck Jun 12, 2025
fcd74e6
Fix lint issues
davepeck Jun 17, 2025
a796f5d
Fix further sphinx warnings
davepeck Jun 17, 2025
21d337c
More!
davepeck Jun 17, 2025
d043381
Merge branch 'main' into docs/pep750-first-pass
davepeck Jun 26, 2025
9a0a301
Wrap up lexical analysis updates... I think?
davepeck Jun 26, 2025
f2e5ca4
Document the new AST nodes (TemplateStr and Interpolation)
davepeck Jun 26, 2025
8484b81
First pass at documenting BUILD_TEMPLATE and BUILD_INTERPOLATION
davepeck Jun 26, 2025
56ef703
Merge branch 'main' into docs/pep750-first-pass
davepeck Jun 27, 2025
5a8cf1b
Clarify distinction between string.Template and string.templatelib.Te…
davepeck Jun 27, 2025
127ebc6
Simplify the NOTE
davepeck Jun 27, 2025
73e1222
Okay, I'll stop wordsmithing this for now
davepeck Jun 27, 2025
530cb6d
Fix formatting/parameters for TemplateStr/Interpolation AST nodes
davepeck Jun 27, 2025
eaec534
Further ast/dis documentation cleanup
davepeck Jun 27, 2025
05b5beb
Substantial updates to string.templatelib.rst docs
davepeck Jun 27, 2025
680189a
Clarify BUILD_INTERPOLATION behavior
davepeck Jun 27, 2025
71ddbf4
Write a template string "tutorial" in the "fancy input output formatt…
davepeck Jun 29, 2025
1c0ed70
Fix lint issue in inputoutput.rst
davepeck Jun 30, 2025
ecc86c3
Merge branch 'main' into docs/pep750-first-pass
davepeck Jun 30, 2025
64c6758
Fix further lint issues in inputoutput.rst
davepeck Jun 30, 2025
16a995d
Merge branch 'main' into docs/pep750-first-pass
davepeck Jun 30, 2025
7f376d7
Merge branch 'main' into docs/pep750-first-pass
davepeck Jul 8, 2025
9e87880
Minor updates for clarity.
davepeck Jul 8, 2025
574c29c
Merge branch 'main' into docs/pep750-first-pass
davepeck Jul 8, 2025
6f0f95a
Update Doc/reference/lexical_analysis.rst
davepeck Jul 8, 2025
95df68f
Merge branch 'main' into docs/pep750-first-pass
davepeck Jul 9, 2025
e562c4e
Merge branch 'main' into docs/pep750-first-pass
davepeck Jul 9, 2025
25d9a6f
Merge branch 'main' into docs/pep750-first-pass
davepeck Jul 10, 2025
72b36fe
Merge branch 'main' into docs/pep750-first-pass
davepeck Jul 10, 2025
15dd810
Take care of @hugovk's suggestions.
davepeck Jul 10, 2025
fd38fba
Take care of all but one of @encukou's feedbacks
davepeck Jul 10, 2025
84dbc16
Attempt to improve "Template strings" intro paragraph
davepeck Jul 10, 2025
54914fe
Update Doc/library/string.templatelib.rst
davepeck Jul 12, 2025
7eca01e
Update Doc/library/string.templatelib.rst
davepeck Jul 12, 2025
687c506
Better use of ..describe per @encukou.
davepeck Jul 12, 2025
3827427
Merge branch 'docs/pep750-first-pass' of github.com:t-strings/cpython…
davepeck Jul 12, 2025
79169d1
Update Doc/library/string.templatelib.rst
davepeck Jul 12, 2025
5d7491c
Remove t-string tutorial (for now)
davepeck Jul 12, 2025
115eaa5
Merge branch 'main' into docs/pep750-first-pass
davepeck Jul 15, 2025
04c2e8d
Add documentation for string.templatelib.convert()
davepeck Jul 15, 2025
2da418b
Update Doc/library/string.templatelib.rst
davepeck Jul 19, 2025
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
Find any occurrences of f-strings that should also mention t-strings.
  • Loading branch information
pauleveritt committed Jun 8, 2025
commit d935dd6fff0976f96e540f528cc6ab6d60b4f4bc
7 changes: 4 additions & 3 deletions Doc/library/string.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,11 +195,12 @@
Format String Syntax
--------------------

The :meth:`str.format` method and the :class:`Formatter` class share the same

Check warning on line 198 in Doc/library/string.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

undefined label: 't-strings' [ref.ref]
syntax for format strings (although in the case of :class:`Formatter`,
subclasses can define their own format string syntax). The syntax is
related to that of :ref:`formatted string literals <f-strings>`, but it is
less sophisticated and, in particular, does not support arbitrary expressions.
related to that of :ref:`formatted string literals <f-strings>` and
:ref:`template string literals <t-strings>`, but it is less sophisticated
and, in particular, does not support arbitrary expressions.

.. index::
single: {} (curly brackets); in string formatting
Expand Down Expand Up @@ -304,9 +305,9 @@
Format Specification Mini-Language
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

"Format specifications" are used within replacement fields contained within a

Check warning on line 308 in Doc/library/string.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

undefined label: 't-strings' [ref.ref]
format string to define how individual values are presented (see
:ref:`formatstrings` and :ref:`f-strings`).
:ref:`formatstrings`, :ref:`f-strings`, and :ref:`t-strings`).
They can also be passed directly to the built-in
:func:`format` function. Each formattable type may define how the format
specification is to be interpreted.
Expand Down
4 changes: 2 additions & 2 deletions Doc/reference/compound_stmts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -850,10 +850,10 @@
: | "False"
signed_number: ["-"] NUMBER

The rule ``strings`` and the token ``NUMBER`` are defined in the

Check warning on line 853 in Doc/reference/compound_stmts.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

undefined label: 't-strings' [ref.ref]
:doc:`standard Python grammar <./grammar>`. Triple-quoted strings are
supported. Raw strings and byte strings are supported. :ref:`f-strings` are
not supported.
supported. Raw strings and byte strings are supported. :ref:`f-strings`
and :ref:`t-strings` are not supported.

The forms ``signed_number '+' NUMBER`` and ``signed_number '-' NUMBER`` are
for expressing :ref:`complex numbers <imaginary>`; they require a real number
Expand Down
Loading
0