Skip to content
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

Prevent leading whitespace in markdown code blocks from being stripped #2203

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Prevent leading whitespace in markdown code blocks from being stripped #2203

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f11975
[BUG] Fix handling of leading whitespaces in code blocks
peytondmurray Jan 6, 2025
2302544
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 6, 2025
e4d3cf1
Add the ability to set pygments lexer options via traitlets
peytondmurray Jan 23, 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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

### Maintenance and upkeep improvements

- enhancement dep-chain: directly depend on bleach[css], instead of pulling in tinycss2. [#2166](https://github.com/jupyter/nbconvert/pull/2166) ([@xiacunshun](https://github.com/xiacunshun))
- enhancement dep-chain: directly depend on bleach\[css\], instead of pulling in tinycss2. [#2166](https://github.com/jupyter/nbconvert/pull/2166) ([@xiacunshun](https://github.com/xiacunshun))
- chore: update pre-commit hooks [#2146](https://github.com/jupyter/nbconvert/pull/2146) ([@pre-commit-ci](https://github.com/pre-commit-ci))

### Contributors to this release
Expand Down Expand Up @@ -1613,6 +1613,7 @@ raw template
{%- endblock in_prompt -%}
"""


exporter_attr = AttrExporter()
output_attr, _ = exporter_attr.from_notebook_node(nb)
assert "raw template" in output_attr
Expand Down
2 changes: 1 addition & 1 deletion nbconvert/filters/highlight.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ def _pygments_highlight(source, output_formatter, language="ipython", metadata=N

if lexer is None:
try:
lexer = get_lexer_by_name(language, stripall=True)
lexer = get_lexer_by_name(language, stripall=False)
except ClassNotFound:
warn("No lexer found for language %r. Treating as plain text." % language, stacklevel=2)
from pygments.lexers.special import TextLexer
Expand Down
2 changes: 1 addition & 1 deletion nbconvert/filters/markdown_mistune.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ def block_code(self, code: str, info: Optional[str] = None) -> str:
try:
if info.strip().split(None, 1):
lang = info.strip().split(maxsplit=1)[0]
lexer = get_lexer_by_name(lang, stripall=True)
lexer = get_lexer_by_name(lang, stripall=False)
except ClassNotFound:
code = f"{lang}\n{code}"
lang = None
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,6 @@ ignore = [
"T201", # `print` found
"RUF012", # Mutable class attributes should be annotated
"UP031", # Use format specifiers instead of percent format

]
unfixable = [
"T201", # Don't touch print statements
Expand Down Expand Up @@ -253,6 +252,7 @@ unfixable = [
"nbconvert/__init__.py" = ["F401", "F403"]
# PLR2004 Magic value used in comparison
"nbconvert/filters/ansi.py" = ["PLR2004"]
"tests/exporters/test_html.py" = ["RUF001"]

[tool.interrogate]
ignore-init-module=true
Expand Down
35 changes: 35 additions & 0 deletions tests/exporters/test_html.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,3 +262,38 @@ def test_language_code_error(self):
(output, resources) = exporter.from_filename(self._get_notebook())

assert '<html lang="en">' in output


def test_syntax_highlight_leading_whitespace():
"""Test that syntax highlight doesn't strip leading spaces."""
nb = v4.reads(r"""
{
"cells": [
{
"cell_type": "markdown",
"id": "29da71a9-ae40-4098-8c3b-31a98e79fc12",
"metadata": {},
"source": [
"```APL\n",
" 1+2×⍳3\n",
"3 5 7\n",
"```\n",
"\n",
"```\n",
" 1+2×⍳3\n",
"3 5 7\n",
"```"
]
}
],
"metadata": {},
"nbformat": 4,
"nbformat_minor": 5
}
""")
output, _ = HTMLExporter().from_notebook_node(nb)
# Check that the second code block has the leading spaces
assert "<pre><code> 1+2×⍳3\n3 5 7\n</code></pre>" in output

# Check that the APL-formatted code block has the leading spaces
assert '<span class="w"> </span>' in output
Loading