Apply linting to example folder.

Author: windelbouwman

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
     - name: Check code style
       run: black --check .
     - name: Static code analysis
-      run: flake8 ppci test
+      run: flake8 ppci test tools
     - name: Test with pytest
       run: pytest
 

docs/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # ppci documentation build configuration file, created by
 # sphinx-quickstart on Fri Aug 15 09:45:38 2014.
@@ -13,8 +12,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
 from importlib.metadata import distribution
 
 # If extensions (or modules to document with autodoc) are in another directory,

docs/exts/gen_programs.py

@@ -3,7 +3,6 @@
 """
 
 import os
-import json
 
 from ppci import programs
 
@@ -61,37 +60,29 @@ def write_programs_rst():
         programs.IntermediateProgram,
         programs.MachineProgram,
     ):
-        parts.append(
-            ".. autoclass:: ppci.programs.{}".format(program.__name__)
-        )
+        parts.append(f".. autoclass:: ppci.programs.{program.__name__}")
         parts.append("   :members:\n\n")
 
     # Add concrete classes
     parts.append("Source code programs")
     parts.append("-" * len(parts[-1]))
     parts.append("")
     for program in programs1:
-        parts.append(
-            ".. autoclass:: ppci.programs.{}".format(program.__name__)
-        )
+        parts.append(f".. autoclass:: ppci.programs.{program.__name__}")
         parts.append("   :members:\n\n")
 
     parts.append("Intermediate programs")
     parts.append("-" * len(parts[-1]))
     parts.append("")
     for program in programs2:
-        parts.append(
-            ".. autoclass:: ppci.programs.{}".format(program.__name__)
-        )
+        parts.append(f".. autoclass:: ppci.programs.{program.__name__}")
         parts.append("   :members:\n\n")
 
     parts.append("Machine code programs")
     parts.append("-" * len(parts[-1]))
     parts.append("")
     for program in programs3:
-        parts.append(
-            ".. autoclass:: ppci.programs.{}".format(program.__name__)
-        )
+        parts.append(f".. autoclass:: ppci.programs.{program.__name__}")
         parts.append("   :members:\n\n")
 
     files_to_remove.append(os.path.join("reference", "programs.rst"))

docs/exts/uml.py

@@ -1,11 +1,11 @@
-import tempfile
-import subprocess
 import os
+import subprocess
+import tempfile
+
+import pylint  # ensure that pyreverse is available  # noqa: F401
 from docutils.parsers.rst import Directive
 from sphinx.ext.graphviz import graphviz
 
-import pylint  # ensure that pyreverse is available
-
 __version__ = "0.1"
 
 
@@ -36,7 +36,7 @@ def run(self):
             cmd.extend(["-c", c])
         cmd.append(module)
         subprocess.check_call(cmd)
-        with open("classes_{}.dot".format(basename)) as f:
+        with open(f"classes_{basename}.dot") as f:
             dotcode = f.read()
         os.chdir(save_dir)
 

examples/6502/christmas.py

@@ -1,15 +1,14 @@
 """Create a nice christmas card."""
 
-import sys
-import os
 import io
-from ppci import api
-from ppci.lang.basic.c64 import write_basic_program, BasicLine
-from ppci.binutils.layout import Layout, Memory, Section
-from ppci.utils.reporting import HtmlReportGenerator
+import sys
+
 import qrcode
 from PIL import Image
 
+from ppci import api
+from ppci.binutils.layout import Layout, Memory, Section
+from ppci.lang.basic.c64 import BasicLine, write_basic_program
 
 # Mapping of 2x2 pixels to charcode:
 # Value order:

examples/6502/make.py

@@ -1,15 +1,16 @@
-import sys
 import os
+import sys
+
 from ppci import api
-from ppci.utils.reporting import html_reporter
 from ppci.lang.basic.c64 import BasicLine, write_basic_program
+from ppci.utils.reporting import html_reporter
 
 arch = api.get_arch("mcs6500")
 print("Using arch", arch)
 
 
 if len(sys.argv) > 1:
-    with open(sys.argv[1], "r") as f:
+    with open(sys.argv[1]) as f:
         text_message = f.read()
 else:
     text_message = "you can provide a text file to customize this message"

examples/c/cdecl.py

@@ -8,9 +8,10 @@
 
 import argparse
 import io
+
 from ppci.api import get_current_arch
-from ppci.lang.c import CLexer, CParser, COptions, CContext, CSemantics
-from ppci.lang.c.nodes import types, declarations
+from ppci.lang.c import CContext, CLexer, COptions, CParser, CSemantics
+from ppci.lang.c.nodes import declarations, types
 from ppci.lang.c.preprocessor import prepare_for_parsing
 
 parser = argparse.ArgumentParser(
@@ -38,13 +39,13 @@
 # Explain:
 def explain(x):
     if isinstance(x, declarations.VariableDeclaration):
-        return "{} is {}".format(x.name, explain(x.typ))
+        return f"{x.name} is {explain(x.typ)}"
     elif isinstance(x, types.PointerType):
-        return "a pointer to {}".format(explain(x.element_type))
+        return f"a pointer to {explain(x.element_type)}"
     elif isinstance(x, types.ArrayType):
-        return "an array of {}".format(explain(x.element_type))
+        return f"an array of {explain(x.element_type)}"
     elif isinstance(x, types.BasicType):
-        return "{}".format(x.type_id)
+        return f"{x.type_id}"
     else:
         print("???", x)
 

examples/c/demo_cparser.py

@@ -3,10 +3,10 @@
 """A demo showing the usage of the preprocessor and the parser"""
 
 import argparse
-from ppci.common import CompilerError
-from ppci.lang.c import create_ast, CAstPrinter, CPrinter
-from ppci.api import get_current_arch
 
+from ppci.api import get_current_arch
+from ppci.common import CompilerError
+from ppci.lang.c import CAstPrinter, CPrinter, create_ast
 
 if __name__ == "__main__":
     # Argument handling:
@@ -15,8 +15,8 @@
     args = arg_parser.parse_args()
     filename = args.source
 
-    print("============= [ {} ] ===============".format(args.source))
-    with open(args.source, "r") as f:
+    print(f"============= [ {args.source} ] ===============")
+    with open(args.source) as f:
         for row, line in enumerate(f, 1):
             print(row, ":", line.rstrip())
     print("====================================")
@@ -25,7 +25,7 @@
     arch_info = get_current_arch().info
 
     try:
-        with open(filename, "r") as f:
+        with open(filename) as f:
             ast = create_ast(f, arch_info, filename=filename)
     except CompilerError as ex:
         ex.print()

examples/c/demo_pycparser.py

@@ -4,9 +4,10 @@
 
 import argparse
 import io
-from ppci.api import preprocess
+
 from pycparser.c_parser import CParser
 
+from ppci.api import preprocess
 
 if __name__ == "__main__":
     # Argument handling:
@@ -17,7 +18,7 @@
 
     # Preprocessing:
     f2 = io.StringIO()
-    with open(filename, "r") as f:
+    with open(filename) as f:
         preprocess(f, f2)
     source = f2.getvalue()
 

examples/c/hello/make.py

@@ -1,8 +1,9 @@
 import logging
+
 from ppci.api import cc
 
 logging.basicConfig(level=logging.DEBUG)
-with open("main.c", "r") as f:
+with open("main.c") as f:
     obj = cc(f, "x86_64", debug=True)
 
 print("Object file created:", obj)