From 1347afdb2e02ef2cb8557978fa39f72930436128 Mon Sep 17 00:00:00 2001
From: Zach Smith <zd@zdsmith.com>
Date: Wed, 25 Apr 2018 20:12:20 -0400
Subject: Resolve linter errors/minor cleanup

---
 pycco/__init__.py       |  2 +-
 pycco/generate_index.py |  4 ++-
 pycco/main.py           | 68 +++++++++++++++++++++++++++----------------------
 tests/test_pycco.py     | 17 +++++++++----
 4 files changed, 54 insertions(+), 37 deletions(-)

diff --git a/pycco/__init__.py b/pycco/__init__.py
index 7794314..042afa6 100644
--- a/pycco/__init__.py
+++ b/pycco/__init__.py
@@ -1,3 +1,3 @@
-from .main import *
+from .main import *  # noqa
 
 __all__ = ("process",)
diff --git a/pycco/generate_index.py b/pycco/generate_index.py
index ab0ead0..7652466 100644
--- a/pycco/generate_index.py
+++ b/pycco/generate_index.py
@@ -52,7 +52,9 @@ def generate_tree_html(tree):
         if 'entry' in subtree:
             html = u'<li><a href="{}">{}</a></li>'.format(subtree['entry']['relpath'], node)
         else:
-            html = u'<dl><dt>{}</dt><dd><ul>{}</ul></dd></dl>'.format(node, generate_tree_html(subtree))
+            html = u'<dl><dt>{}</dt><dd><ul>{}</ul></dd></dl>'.format(
+                node, generate_tree_html(subtree)
+            )
 
         items.append(html)
 
diff --git a/pycco/main.py b/pycco/main.py
index f0d4fcf..735d7eb 100644
--- a/pycco/main.py
+++ b/pycco/main.py
@@ -146,7 +146,7 @@ def parse(code, language):
                 line = line.replace(multistart, '')
                 line = line.replace(multiend, '')
                 docs_text += line.strip() + '\n'
-                indent_level = re.match("\s*", line).group(0)
+                indent_level = re.match(r"\s*", line).group(0)
 
                 if has_code and docs_text.strip():
                     save(docs_text, code_text[:-1])
@@ -229,8 +229,8 @@ def preprocess(comment, preserve_paths=True, outdir=None):
             name=match.group(2)
         )
 
-    comment = re.sub('^([=]+)([^=]+)[=]*\s*$', replace_section_name, comment)
-    comment = re.sub('(?<!`)\[\[(.+?)\]\]', replace_crossref, comment)
+    comment = re.sub(r'^([=]+)([^=]+)[=]*\s*$', replace_section_name, comment)
+    comment = re.sub(r'(?<!`)\[\[(.+?)\]\]', replace_crossref, comment)
 
     return comment
 
@@ -250,21 +250,25 @@ def highlight(sections, language, preserve_paths=True, outdir=None):
     if not outdir:
         raise TypeError("Missing the required 'outdir' keyword argument.")
 
-    output = pygments.highlight(language["divider_text"].join(section["code_text"].rstrip() for section in sections),
-                                language["lexer"],
-                                formatters.get_formatter_by_name("html"))
+    divider_text = language["divider_text"]
+    joined_text = divider_text.join(
+        section["code_text"].rstrip() for section in sections
+    )
+    lexer = language["lexer"]
+    html_formatter = formatters.get_formatter_by_name("html")
+    output = pygments.highlight(joined_text, lexer, html_formatter)
 
     output = output.replace(highlight_start, "").replace(highlight_end, "")
     fragments = re.split(language["divider_html"], output)
     for i, section in enumerate(sections):
-        section["code_html"] = highlight_start + \
-            shift(fragments, "") + highlight_end
+        section["code_html"] = highlight_start + shift(fragments, "") + highlight_end
+        docs_text = section['docs_text']
         try:
             docs_text = unicode(section["docs_text"])
         except UnicodeError:
             docs_text = unicode(section["docs_text"].decode('utf-8'))
         except NameError:
-            docs_text = section['docs_text']
+            pass
         section["docs_html"] = markdown(preprocess(docs_text,
                                                    preserve_paths=preserve_paths,
                                                    outdir=outdir))
@@ -313,65 +317,69 @@ def generate_html(source, sections, preserve_paths=True, outdir=None):
 # the name of the Pygments lexer and the symbol that indicates a comment. To
 # add another language to Pycco's repertoire, add it here.
 languages = {
-    ".coffee": {"name": "coffee-script", "symbol": "#",
+    ".coffee": {"name": "coffee-script", "comment_symbol": "#",
                 "multistart": '###', "multiend": '###'},
 
-    ".pl": {"name": "perl", "symbol": "#"},
+    ".pl": {"name": "perl", "comment_symbol": "#"},
 
-    ".sql": {"name": "sql", "symbol": "--"},
+    ".sql": {"name": "sql", "comment_symbol": "--"},
 
-    ".sh": {"name": "bash", "symbol": "#"},
+    ".sh": {"name": "bash", "comment_symbol": "#"},
 
-    ".c": {"name": "c", "symbol": "//",
+    ".c": {"name": "c", "comment_symbol": "//",
            "multistart": "/*", "multiend": "*/"},
 
-    ".h": {"name": "c", "symbol": "//",
+    ".h": {"name": "c", "comment_symbol": "//",
            "multistart": "/*", "multiend": "*/"},
 
-    ".cpp": {"name": "cpp", "symbol": "//"},
+    ".cpp": {"name": "cpp", "comment_symbol": "//"},
 
-    ".cl": {"name": "c", "symbol": "//",
+    ".cl": {"name": "c", "comment_symbol": "//",
             "multistart": "/*", "multiend": "*/"},
 
-    ".js": {"name": "javascript", "symbol": "//",
+    ".js": {"name": "javascript", "comment_symbol": "//",
             "multistart": "/*", "multiend": "*/"},
 
-    ".rb": {"name": "ruby", "symbol": "#",
+    ".rb": {"name": "ruby", "comment_symbol": "#",
             "multistart": "=begin", "multiend": "=end"},
 
-    ".py": {"name": "python", "symbol": "#",
+    ".py": {"name": "python", "comment_symbol": "#",
             "multistart": '"""', "multiend": '"""'},
 
-    ".scm": {"name": "scheme", "symbol": ";;",
+    ".scm": {"name": "scheme", "comment_symbol": ";;",
              "multistart": "#|", "multiend": "|#"},
 
-    ".lua": {"name": "lua", "symbol": "--",
+    ".lua": {"name": "lua", "comment_symbol": "--",
              "multistart": "--[[", "multiend": "--]]"},
 
-    ".erl": {"name": "erlang", "symbol": "%%"},
+    ".erl": {"name": "erlang", "comment_symbol": "%%"},
 
-    ".tcl": {"name": "tcl", "symbol": "#"},
+    ".tcl": {"name": "tcl", "comment_symbol": "#"},
 
-    ".hs": {"name": "haskell", "symbol": "--",
+    ".hs": {"name": "haskell", "comment_symbol": "--",
             "multistart": "{-", "multiend": "-}"},
 }
 
 # Build out the appropriate matchers and delimiters for each language.
 for ext, l in languages.items():
+    language_name = l["name"]
+    comment_symbol = l["comment_symbol"]
+
     # Does the line begin with a comment?
-    l["comment_matcher"] = re.compile(r"^\s*" + l["symbol"] + "\s?")
+    l["comment_matcher"] = re.compile(r"^\s*{}\s?".format(comment_symbol))
 
     # The dividing token we feed into Pygments, to delimit the boundaries between
     # sections.
-    l["divider_text"] = "\n" + l["symbol"] + "DIVIDER\n"
+    l["divider_text"] = "\n{}DIVIDER\n".format(comment_symbol)
 
     # The mirror of `divider_text` that we expect Pygments to return. We can split
     # on this to recover the original sections.
     l["divider_html"] = re.compile(
-        r'\n*<span class="c[1]?">' + l["symbol"] + 'DIVIDER</span>\n*')
+        r'\n*<span class="c[1]?">{}DIVIDER</span>\n*'.format(comment_symbol)
+    )
 
     # Get the Pygments Lexer for this language.
-    l["lexer"] = lexers.get_lexer_by_name(l["name"])
+    l["lexer"] = lexers.get_lexer_by_name(language_name)
 
 
 def get_language(source, code, language=None):
@@ -625,7 +633,7 @@ def main():
     if opts.watch:
         try:
             import watchdog.events
-            import watchdog.observers
+            import watchdog.observers  # noqa
         except ImportError:
             sys.exit('The -w/--watch option requires the watchdog package.')
 
diff --git a/tests/test_pycco.py b/tests/test_pycco.py
index 6db8265..6a98eda 100644
--- a/tests/test_pycco.py
+++ b/tests/test_pycco.py
@@ -4,7 +4,7 @@ import tempfile
 import time
 import os.path
 import pytest
-from hypothesis import given, example, assume
+from hypothesis import given, example
 from hypothesis.strategies import lists, text, booleans, choices, none
 
 import pycco.generate_index as generate_index
@@ -41,8 +41,8 @@ def test_destination(filepath, preserve_paths, outdir):
 
 @given(choices(), text())
 def test_parse(choice, source):
-    l = get_language(choice)
-    parsed = p.parse(source, l)
+    lang = get_language(choice)
+    parsed = p.parse(source, lang)
     for s in parsed:
         assert {"code_text", "docs_text"} == set(s.keys())
 
@@ -63,7 +63,9 @@ def test_multi_line_leading_spaces():
 
 
 def test_comment_with_only_cross_ref():
-    source = '''# ==Link Target==\n\ndef test_link():\n    """[[testing.py#link-target]]"""\n    pass'''
+    source = (
+        '''# ==Link Target==\n\ndef test_link():\n    """[[testing.py#link-target]]"""\n    pass'''
+    )
     sections = p.parse(source, PYTHON)
     p.highlight(sections, PYTHON, outdir=tempfile.gettempdir())
     assert sections[1][
@@ -160,7 +162,12 @@ def test_process(preserve_paths, index, choice):
               language=lang_name)
 
 
-@given(lists(lists(text(min_size=1), min_size=1, max_size=30), min_size=1), lists(text(min_size=1), min_size=1))
+one_or_more_chars = text(min_size=1)
+paths = lists(one_or_more_chars, min_size=1, max_size=30)
+@given(
+    lists(paths, min_size=1),
+    lists(one_or_more_chars, min_size=1)
+)
 def test_generate_index(path_lists, outdir_list):
     file_paths = [os.path.join(*path_list) for path_list in path_lists]
     outdir = os.path.join(*outdir_list)
-- 
cgit v1.2.1