Skip to content

Add a post-process hook to the snippets preprocessor (#2726) #2727

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a post-process hook to the snippets preprocessor (#2726) #2727

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions pymdownx/snippets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,9 @@ def download(self, url):
continue
raise SnippetMissingError(f"Cannot download snippet '{url}' (HTTP Error {e.code})") from e

def post_process_snippet(self, s_lines, snippet):
"""Override to post-process the snippet's content."""
return s_lines

def parse_snippets(self, lines, file_name=None, is_url=False, is_section=False):
"""Parse snippets snippet."""
Expand Down Expand Up @@ -390,6 +393,10 @@ def parse_snippets(self, lines, file_name=None, is_url=False, is_section=False):
elif section:
s_lines = self.extract_section(section, s_lines)

# call the post-process hook
if s_lines:
s_lines = self.post_process_snippet(s_lines, snippet)

# Process lines looking for more snippets
new_lines.extend(
[
Expand Down