Implement review comments, and add a test

python · Sep 21, 2020 · fba9086 · fba9086
1 parent e340ac1
commit fba9086
Show file tree

Hide file tree

Showing 5 changed files with 671 additions and 5 deletions.
diff --git a/base-requirements.txt b/base-requirements.txt
@@ -37,4 +37,4 @@ django-waffle==0.14
 djangorestframework==3.8.2
 django-filter==1.1.0
 
-pygments==2.1.3
+pygments==2.1.3  # This will be not needed when PEPs are moved to RtD.
diff --git a/peps/converters.py b/peps/converters.py
@@ -19,6 +19,11 @@
 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]
 
 def get_peps_last_updated():
@@ -145,16 +150,16 @@ def convert_pep_page(pep_number, content):
     # Fix PEP links
     pep_content = BeautifulSoup(data['content'], 'lxml')
     body_links = pep_content.find_all("a")
-    # Fix hihglighting code
-    code_blocks = pep_content.find_all("pre", class_="code")
+    # Fix highlighting code
+    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)
     # Highlight existing pure-Python PEPs
     if int(pep_number) in PURE_PYTHON_PEPS:
-        literal_blocks = pep_content.find_all("pre", class_="literal-block")
+        literal_blocks = pep_content.find_all('pre', class_='literal-block')
         for lb in literal_blocks:
             block = lb.string
             if block: