tweak Nathan's code and run formatter

Author: ChrisMayfield

examples/9_leaderboard/test_leaderboard.py

@@ -9,11 +9,10 @@ def test_multiple_metrics():
     """Example of setting multiple leaderboard entries."""
     # Simulate some work
     time.sleep(0.1)
-    
+
     # Add various metrics to the leaderboard
     test_multiple_metrics.leaderboard = [
         {"name": "Advanced Score", "value": 950},
         {"name": "Response Time", "value": 125, "order": "asc"},
         {"name": "Rating", "value": "★★★★☆"}
     ]
-

examples/README.md

@@ -10,6 +10,7 @@ The following "assignments" are used for testing `jmu_pytest_utils` and provided
 * [6_provided_data](6_provided_data) -- file I/O assignment
 * [7_class_package](7_class_package) -- classes and packages
 * [8_test_coverage](8_test_coverage) -- grading student's tests
+* [9_leaderboard](9_leaderboard) -- Gradescope leaderboard
 
 
 ## API Docs

jmu_pytest_utils/audit.py

@@ -101,6 +101,7 @@ def count_nodes(filename):
     tree = ast.parse(source, filename)
     return Counter(type(node).__name__ for node in ast.walk(tree))
 
+
 def count_while_loops(filename):
     """Count the number of while loops in a program.
 

jmu_pytest_utils/remove_comments.py

@@ -1,34 +1,36 @@
-""" Strip comments and docstrings from a file.
-#https://gist.github.com/BroHui/aca2b8e6e6bdf3cb4af4b246c9837fa3
-"""
+""" Strip comments and docstrings from a file."""
+
+# Source: https://gist.github.com/BroHui/aca2b8e6e6bdf3cb4af4b246c9837fa3
+
+import sys
+import token
+import tokenize
+import io
 
-import sys, token, tokenize, io
 
 def remove_comments(fname):
-    """ Run on just one file.
-    """
-    source = open(fname)
-    mod = io.StringIO() #open(fname + ",strip", "w")
+    """Run on just one file."""
+    source = open(fname, encoding="utf-8")
+    mod = io.StringIO()  # open(fname + ",strip", "w")
 
     prev_toktype = token.INDENT
-    first_line = None
     last_lineno = -1
     last_col = 0
 
     tokgen = tokenize.generate_tokens(source.readline)
     for toktype, ttext, (slineno, scol), (elineno, ecol), ltext in tokgen:
-        if 0:   # Change to if 1 to see the tokens fly by.
+        if 0:  # Change to if 1 to see the tokens fly by.
             print("%10s %-14s %-20r %r" % (
                 tokenize.tok_name.get(toktype, toktype),
                 "%d.%d-%d.%d" % (slineno, scol, elineno, ecol),
                 ttext, ltext
-                ))
+            ))
         if slineno > last_lineno:
             last_col = 0
         if scol > last_col:
             mod.write(" " * (scol - last_col))
         if (toktype == token.STRING and
-            (prev_toktype == token.INDENT or prev_toktype == token.NEWLINE)):
+                (prev_toktype == token.INDENT or prev_toktype == token.NEWLINE)):
             # Docstring
             # mod.write("#--")
             pass
@@ -43,6 +45,6 @@ def remove_comments(fname):
         last_lineno = elineno
     return mod.getvalue()
 
+
 if __name__ == '__main__':
     print(remove_comments(sys.argv[1]))
-

jmu_pytest_utils/template/setup.sh

@@ -15,7 +15,7 @@ source .venv/bin/activate
 pip install --upgrade pip
 
 # Install libraries
-pip install git+https://github.com/JMU-CS/jmu_pytest_utils.git@nrs
+pip install git+https://github.com/JMU-CS/jmu_pytest_utils.git
 if [ -f "requirements.txt" ]; then
     pip install -r requirements.txt
 fi