Skip to content

gh-127833: Use productionlist nodes to implement the grammar-snippet directive #130376

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
AA-Turner merged 18 commits into from
Mar 20, 2025
Merged

gh-127833: Use productionlist nodes to implement the grammar-snippet directive #130376

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
21d52e1
Extract `grammar_re` to class-level
AA-Turner Feb 20, 2025
e5624ed
Factor out `make_production()`
AA-Turner Feb 20, 2025
02210ca
Update to 8.2 `make_name_target()`
AA-Turner Feb 20, 2025
587c7f9
Use `productionlist` and `production` nodes
AA-Turner Feb 20, 2025
7ce49bf
Update topics.py
AA-Turner Feb 20, 2025
93d80df
Add highlighting back
encukou Feb 26, 2025
8c3f133
Merge each multi-line productions into a single production node
encukou Feb 26, 2025
9ad7e8f
Add Blaise as co-author
blaisep Feb 26, 2025
cde13e2
Run ruff format
encukou Feb 26, 2025
a9237dd
Fill in the rawsource lines
encukou Mar 5, 2025
c958165
Fix initial case
encukou Mar 5, 2025
e591450
Small tweaks
AA-Turner Mar 12, 2025
6b4ec3d
Extract production lines logic into `production_definitions()`
AA-Turner Mar 12, 2025
f5b5ff5
Dict → tuple
encukou Mar 17, 2025
be8f9e7
Provide more info on error
encukou Mar 17, 2025
8144750
Merge in the main branch
encukou Mar 19, 2025
5b39df3
Merge branch 'main' into docs/productionlist-grammar
AA-Turner Mar 19, 2025
1c793eb
Regenerate ``pydoc_data/topics.py``
AA-Turner Mar 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
Factor out make_production()
  • Loading branch information
@AA-Turner
AA-Turner committed Feb 20, 2025
commit e5624ed4ad714bdab10fecaa7b09285817da09e1
63 changes: 31 additions & 32 deletions Doc/tools/extensions/grammar_snippet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,40 +79,39 @@ def make_grammar_snippet(
)

for line in content:
last_pos = 0
for match in self.grammar_re.finditer(line):
# Handle text between matches
if match.start() > last_pos:
literal += nodes.Text(line[last_pos : match.start()])
last_pos = match.end()

# Handle matches
group_dict = {
name: content
for name, content in match.groupdict().items()
if content is not None
}
match group_dict:
case {'rule_name': name}:
literal += self.make_link_target_for_token(
group_name, name
)
case {'rule_ref': ref_text}:
literal += token_xrefs(ref_text, group_name)
case {'single_quoted': name} | {'double_quoted': name}:
literal += snippet_string_node('', name)
case _:
raise ValueError('unhandled match')
literal += nodes.Text(line[last_pos:] + '\n')

node = nodes.paragraph(
'',
'',
literal,
)

self.make_production(line, group_name=group_name, literal=literal)
node = nodes.paragraph('', '', literal)
return [node]

def make_production(
self, line: str, *, group_name: str, literal: nodes.literal_block
):
last_pos = 0
for match in self.grammar_re.finditer(line):
# Handle text between matches
if match.start() > last_pos:
literal += nodes.Text(line[last_pos : match.start()])
last_pos = match.end()

# Handle matches
group_dict = {
name: content
for name, content in match.groupdict().items()
if content is not None
}
match group_dict:
case {'rule_name': name}:
literal += self.make_link_target_for_token(
group_name, name
)
case {'rule_ref': ref_text}:
literal += token_xrefs(ref_text, group_name)
case {'single_quoted': name} | {'double_quoted': name}:
literal += snippet_string_node('', name)
case _:
raise ValueError('unhandled match')
literal += nodes.Text(line[last_pos:] + '\n')

def make_link_target_for_token(
self, group_name: str, name: str
) -> addnodes.literal_strong:
Expand Down