housekeeping

Author: mbdevpl

open_fortran_parser/ofc_wrapper.py

@@ -20,6 +20,7 @@ class CodeForm(enum.IntEnum):
 def execute_compiler(
         input_path: pathlib.Path, output_path: t.Optional[pathlib.Path],
         indent: int = 4, form: t.Optional[CodeForm] = None) -> subprocess.CompletedProcess:
+    """Run Open Fortran Compiler with given parameters."""
     assert isinstance(input_path, pathlib.Path), type(input_path)
     assert output_path is None or isinstance(output_path, pathlib.Path), type(output_path)
     assert isinstance(indent, int), type(indent)

test/__init__.py

@@ -1,3 +1,4 @@
+"""Tests for open_fortran_parser package."""
 
 import pathlib
 

test/test_apps.py

@@ -37,7 +37,8 @@ def test_miranda_io(self):
 
     def test_flash(self):
         flash_relative_repo_path = pathlib.Path('..', 'flash-subset')
-        flash_src_dir = _HERE.parent.joinpath(flash_relative_repo_path, 'FLASH4.4', 'source').resolve()
+        flash_src_dir = _HERE.parent.joinpath(flash_relative_repo_path,
+                                              'FLASH4.4', 'source').resolve()
         if not flash_src_dir.is_dir():
             self.skipTest('FLASH directory not found')
         tested_flash_kernel_paths = [

test/test_compatibility.py

@@ -22,7 +22,8 @@ def all_fortran_paths(root_path: pathlib.Path):
     if not root_path.exists():
         return []
     all_input_paths = []
-    for extension in itertools.chain(*[(_, _.upper()) for _ in ('.f', '.f90', '.f03', '.f08', '.h')]):
+    for extension in itertools.chain(
+            *[(_, _.upper()) for _ in ('.f', '.f90', '.f03', '.f08', '.h')]):
         input_paths = root_path.glob(
             f'**/*{extension}')
         for input_path in input_paths:
@@ -41,6 +42,7 @@ class Tests(unittest.TestCase):
     maxDiff = None
 
     def check_cases(self, input_paths, relative=True):
+        """Try to parse all given files, fail on first failure."""
         for input_path in input_paths:
             if relative:
                 input_path = _OFP_TESTS_DIR.joinpath(input_path).resolve()
@@ -65,6 +67,7 @@ def check_cases_and_report(
             success_reports_path: pathlib.Path, input_paths_root: pathlib.Path,
             input_paths: t.Sequence[pathlib.Path], minimum_passed_cases: int = None,
             fall_back_to_ofc: bool = False):
+        """Try to parse all given files, fail if there are not enough successes."""
         all_count = len(input_paths)
         if minimum_passed_cases is None:
             minimum_passed_cases = all_count
@@ -250,7 +253,7 @@ def test_ofp_do(self):
             'rule-tests/R843.f03']]
         self.check_cases(input_paths)
 
-    def test_ofp_do_concurrent_and_forall(self):
+    def test_ofp_do_concurr_and_forall(self):
         input_paths = [pathlib.Path(_) for _ in [
             'annex_c/c_4_5.f03',
             'annex_c/c_4_6.f03',

test/test_ofc.py

@@ -5,7 +5,8 @@
 import platform
 import unittest
 
-from open_fortran_parser.ofc_wrapper import CodeForm, execute_compiler, transpile
+# CodeForm,
+from open_fortran_parser.ofc_wrapper import execute_compiler, transpile
 
 _LOG = logging.getLogger(__name__)
 

test/test_script.py

@@ -4,11 +4,11 @@
 import io
 import os
 import pathlib
-import runpy
-import sys
 import tempfile
 import unittest
 
+from .test_setup import run_module
+
 INPUT_PATH = pathlib.Path('test', 'examples', 'empty.f')
 
 
@@ -20,15 +20,11 @@ class Tests(unittest.TestCase):
 
     maxDiff = None
 
-    def run_script(self, *args):
-        sys.argv = ['open_fortran_parser'] + list(args)
-        runpy.run_module('open_fortran_parser', run_name='__main__')
-
     def test_help(self):
         f = io.StringIO()
         with contextlib.redirect_stderr(f):
             with self.assertRaises(SystemExit):
-                self.run_script()
+                run_module('open_fortran_parser')
         text = f.getvalue()
         self.assertIn('usage', text)
         self.assertIn('open_fortran_parser', text)
@@ -38,16 +34,16 @@ def test_verbosity_flag(self):
         for verbosity in verbosities:
             f = io.StringIO()
             with contextlib.redirect_stdout(f):
-                self.run_script('-v', str(verbosity), str(INPUT_PATH))
+                run_module('open_fortran_parser', '-v', str(verbosity), str(INPUT_PATH))
             self.assertGreater(len(f.getvalue()), 0)
 
     def test_output_flag(self):
         output_file = tempfile.NamedTemporaryFile(delete=False)
         output_file.close()
         f = io.StringIO()
         with contextlib.redirect_stdout(f):
-            self.run_script(str(INPUT_PATH))
-        self.run_script(str(INPUT_PATH), output_file.name)
+            run_module('open_fortran_parser', str(INPUT_PATH))
+        run_module('open_fortran_parser', str(INPUT_PATH), output_file.name)
         with open(output_file.name) as output_file:
             self.assertEqual(normalize_newlines(f.getvalue()),
                              normalize_newlines(output_file.read()))