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

Add support for syntax highlighting in PEPs #1638

Closed
wants to merge 6 commits into from
Closed

Add support for syntax highlighting in PEPs #1638

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2f4c8fc
Add support for syntax highlighting in PEPs
ilevkivskyi Mar 16, 2017
a91ec43
Implement review comments, and add a test
ilevkivskyi Mar 23, 2017
ee186f6
Default to Python highlighting for '::' code blocks.
hugovk Dec 11, 2020
fc47728
Remove unused constant
hugovk Dec 18, 2020
367f758
Merge branch 'main' into ilevkivskyi-colour
hugovk Jul 27, 2021
3cbae81
Merge branch 'main' into ilevkivskyi-colour
hugovk Sep 9, 2021
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
2 changes: 2 additions & 0 deletions base-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,5 @@ django-filter==1.1.0
django-ordered-model==3.4.1
django-widget-tweaks==1.4.8
django-countries==6.1.3

pygments==2.7.3 # This will be not needed when PEPs are moved to RtD.
Copy link
Member

Choose a reason for hiding this comment

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

Not sure I understand this comment. Is there a plan to host the PEPs elsewhere?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, the plan is to build PEPs using Sphinx and host them on Read the Docs at peps.python.org: python/peps#2 (June 2016).

There's a PR to do add Sphinx support, but it's a big one and hasn't been reviewed yet: python/peps#1385 (April 2020).

Hence reviving this PR.

26 changes: 26 additions & 0 deletions peps/converters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,21 @@
from django.core.files import File
from django.db.models import Max

from pygments import highlight
from pygments.lexers import PythonLexer
from pygments.formatters import HtmlFormatter

from pages.models import Page, Image

PEP_TEMPLATE = 'pages/pep-page.html'
pep_url = lambda num: 'dev/peps/pep-{}/'.format(num)

# To simplify syntax highlighting, all literal blocks (those produced by ::)
# in the following PEPs will be automatically highlighted using Python lexer.
# PEP editors/authors could make simple PRs extending this list.
# This will be not needed when PEPs are moved to RtD and all code blocks are
# formatted using .. code:: language.
PURE_PYTHON_PEPS = [483, 484, 526]
Copy link
Member

Choose a reason for hiding this comment

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

Seems like it would make more sense to update the PEPs with appropriate code blocks rather than do this. I think this would also remove the need for the following lines (although I'm not sure what "Fix highlighting code" is currently doing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree, I'll comment below what's happening.

Copy link
Member

Choose a reason for hiding this comment

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

This is no longer used.


def get_peps_last_updated():
last_update = Page.objects.filter(
Expand Down Expand Up @@ -140,6 +150,22 @@ def convert_pep_page(pep_number, content):
# Fix PEP links
pep_content = BeautifulSoup(data['content'], 'lxml')
body_links = pep_content.find_all("a")
# Fix highlighting code
Copy link
Member Author

Choose a reason for hiding this comment

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

This chunk (from here to the next comment) is dealing with blocks with an explicit language, such as .. code-block:: python or .. code-block:: c.

More detail: the generated PEPs from https://github.com/python/peps has HTML like for these:

<pre class="code python literal-block">
...
<pre class="code c literal-block">

And with no language specified (::) have:

<pre class="literal-block">

This chunk finds all <pre class="code ...">, deletes those classes from the pre, and wraps them in a <div class="highlight"> for later processing.

code_blocks = pep_content.find_all('pre', class_='code')
for cb in code_blocks:
del cb['class']
div = pep_content.new_tag('div')
div['class'] = ['highlight']
cb.wrap(div)

# Default to Python highlighting for '::' code blocks.
# Other languages can be set like '.. code-block:: c'.
literal_blocks = pep_content.find_all('pre', class_='literal-block')
for lb in literal_blocks:
block = lb.string
if block:
highlighted = highlight(block, PythonLexer(), HtmlFormatter())
lb.replace_with(BeautifulSoup(highlighted, 'lxml').html.body.div)

pep_href_re = re.compile(r'pep-(\d+)\.html')

Expand Down
Loading