misc: Automated linting fixes in examples, tests, scripts

Author: JDBetteridge

benchmarks/user/advisor/advisor_logging.py

@@ -9,18 +9,18 @@ def check(cond, msg):
 
 
 def err(msg):
-    print('\033[1;37;31m%s\033[0m' % msg)  # print in RED
+    print(f'\033[1;37;31m{msg}\033[0m')  # print in RED
 
 
 def log(msg):
-    print('\033[1;37;32m%s\033[0m' % msg)  # print in GREEN
+    print(f'\033[1;37;32m{msg}\033[0m')  # print in GREEN
 
 
 @contextmanager
 def progress(msg):
-    print('\033[1;37;32m%s ... \033[0m' % msg, end='', flush=True)  # print in GREEN
+    print(f'\033[1;37;32m{msg} ... \033[0m', end='', flush=True)  # print in GREEN
     yield
-    print('\033[1;37;32m%s\033[0m' % 'Done!')
+    print('\033[1;37;32m{}\033[0m'.format('Done!'))
 
 
 def log_process(process, logger):

benchmarks/user/advisor/roofline.py

@@ -205,7 +205,7 @@ def roofline(name, project, scale, precision, mode, th):
     log(f'\nFigure saved in {figpath}{name}.pdf.')
 
     # Save the JSON file
-    with open('%s.json' % name, 'w') as f:
+    with open(f'{name}.json', 'w') as f:
         f.write(json.dumps(roofline_data))
 
     log(f'\nJSON file saved as {name}.json.')

benchmarks/user/advisor/run_advisor.py

@@ -132,7 +132,7 @@ def run_with_advisor(path, output, name, exec_args):
     # Before collecting the `survey` and `tripcounts` a "pure" python run
     # to warmup the jit cache is preceded
 
-    log('Starting Intel Advisor\'s `roofline` analysis for `%s`' % name)
+    log(f'Starting Intel Advisor\'s `roofline` analysis for `{name}`')
     dt = datetime.datetime.now()
 
     # Set up a file logger that will track the output of the advisor profiling
@@ -142,7 +142,7 @@ def run_with_advisor(path, output, name, exec_args):
     advixe_formatter = logging.Formatter('%(asctime)s: %(message)s')
     logger_datetime = '%d.%d.%d.%d.%d.%d' % (dt.year, dt.month,
                                              dt.day, dt.hour, dt.minute, dt.second)
-    advixe_handler = logging.FileHandler('%s/%s_%s.log' % (output, name, logger_datetime))
+    advixe_handler = logging.FileHandler(f'{output}/{name}_{logger_datetime}.log')
     advixe_handler.setFormatter(advixe_formatter)
     advixe_logger.addHandler(advixe_handler)
 

benchmarks/user/benchmark.py

@@ -74,7 +74,7 @@ def run_op(solver, operator, **options):
     try:
         op = getattr(solver, operator)
     except AttributeError:
-        raise AttributeError("Operator %s not implemented for %s" % (operator, solver))
+        raise AttributeError(f"Operator {operator} not implemented for {solver}")
 
     # This is a bit ugly but not sure how to make clean input creation for different op
     if operator == "forward":
@@ -95,7 +95,7 @@ def run_op(solver, operator, **options):
         args = args[:-1]
         return op(*args, **options)
     else:
-        raise ValueError("Unrecognized operator %s" % operator)
+        raise ValueError(f"Unrecognized operator {operator}")
 
 
 @click.group()
@@ -157,15 +157,14 @@ def from_opt(ctx, param, value):
             # E.g., `('advanced', {'par-tile': True})`
             value = eval(value)
             if not isinstance(value, tuple) and len(value) >= 1:
-                raise click.BadParameter("Invalid choice `%s` (`opt` must be "
-                                         "either str or tuple)" % str(value))
+                raise click.BadParameter(f"Invalid choice `{str(value)}` (`opt` must be "
+                                         "either str or tuple)")
             opt = value[0]
         except NameError:
             # E.g. `'advanced'`
             opt = value
         if opt not in configuration._accepted['opt']:
-            raise click.BadParameter("Invalid choice `%s` (choose from %s)"
-                                     % (opt, str(configuration._accepted['opt'])))
+            raise click.BadParameter("Invalid choice `{}` (choose from {})".format(opt, str(configuration._accepted['opt'])))
         return value
 
     def config_blockshape(ctx, param, value):
@@ -188,11 +187,11 @@ def config_blockshape(ctx, param, value):
                 levels = [bs[x:x+3] for x in range(0, len(bs), 3)]
                 if any(len(level) != 3 for level in levels):
                     raise ValueError("Expected 3 entries per block shape level, but got "
-                                     "one level with less than 3 entries (`%s`)" % levels)
+                                     f"one level with less than 3 entries (`{levels}`)")
                 normalized_value.append(levels)
             if not all_equal(len(i) for i in normalized_value):
                 raise ValueError("Found different block shapes with incompatible "
-                                 "number of levels (`%s`)" % normalized_value)
+                                 f"number of levels (`{normalized_value}`)")
             configuration['opt-options']['blocklevels'] = len(normalized_value[0])
         else:
             normalized_value = []
@@ -205,8 +204,7 @@ def config_autotuning(ctx, param, value):
         elif value != 'off':
             # Sneak-peek at the `block-shape` -- if provided, keep auto-tuning off
             if ctx.params['block_shape']:
-                warning("Skipping autotuning (using explicit block-shape `%s`)"
-                        % str(ctx.params['block_shape']))
+                warning("Skipping autotuning (using explicit block-shape `{}`)".format(str(ctx.params['block_shape'])))
                 level = False
             else:
                 # Make sure to always run in preemptive mode
@@ -305,11 +303,11 @@ def run(problem, **kwargs):
 
     dumpfile = kwargs.pop('dump_norms')
     if dumpfile:
-        norms = ["'%s': %f" % (i.name, norm(i)) for i in retval[:-1]
+        norms = [f"'{i.name}': {norm(i):f}" for i in retval[:-1]
                  if isinstance(i, DiscreteFunction)]
         if rank == 0:
             with open(dumpfile, 'w') as f:
-                f.write("{%s}" % ', '.join(norms))
+                f.write("{{{}}}".format(', '.join(norms)))
 
     return retval
 
@@ -343,13 +341,13 @@ def run_jit_backdoor(problem, **kwargs):
     op = solver.op_fwd()
 
     # Get the filename in the JIT cache
-    cfile = "%s.c" % str(op._compiler.get_jit_dir().joinpath(op._soname))
+    cfile = f"{str(op._compiler.get_jit_dir().joinpath(op._soname))}.c"
 
     if not os.path.exists(cfile):
         # First time we run this problem, let's generate and jit-compile code
         op.cfunction
-        info("You may now edit the generated code in `%s`. "
-             "Then save the file, and re-run this benchmark." % cfile)
+        info(f"You may now edit the generated code in `{cfile}`. "
+             "Then save the file, and re-run this benchmark.")
         return
 
     info("Running wave propagation Operator...")
@@ -364,7 +362,7 @@ def _run_jit_backdoor():
     if dumpnorms:
         for i in retval[:-1]:
             if isinstance(i, DiscreteFunction):
-                info("'%s': %f" % (i.name, norm(i)))
+                info(f"'{i.name}': {norm(i):f}")
 
     return retval
 

conftest.py

@@ -40,29 +40,28 @@ def skipif(items, whole_module=False):
     accepted.update({'nodevice', 'noomp'})
     unknown = sorted(set(items) - accepted)
     if unknown:
-        raise ValueError("Illegal skipif argument(s) `%s`" % unknown)
+        raise ValueError(f"Illegal skipif argument(s) `{unknown}`")
     skipit = False
     for i in items:
         # Skip if won't run on GPUs
         if i == 'device' and isinstance(configuration['platform'], Device):
-            skipit = "device `%s` unsupported" % configuration['platform'].name
+            skipit = "device `{}` unsupported".format(configuration['platform'].name)
             break
         # Skip if won't run on a specific GPU backend
         langs = configuration._accepted['language']
-        if any(i == 'device-%s' % l and configuration['language'] == l for l in langs)\
+        if any(i == f'device-{l}' and configuration['language'] == l for l in langs)\
                 and isinstance(configuration['platform'], Device):
-            skipit = "language `%s` for device unsupported" % configuration['language']
+            skipit = "language `{}` for device unsupported".format(configuration['language'])
             break
-        if any(i == 'device-%s' % k and isinstance(configuration['compiler'], v)
+        if any(i == f'device-{k}' and isinstance(configuration['compiler'], v)
                for k, v in compiler_registry.items()) and\
                 isinstance(configuration['platform'], Device):
-            skipit = "compiler `%s` for device unsupported" % configuration['compiler']
+            skipit = "compiler `{}` for device unsupported".format(configuration['compiler'])
             break
         # Skip if must run on GPUs but not currently on a GPU
         if i in ('nodevice', 'nodevice-omp', 'nodevice-acc') and\
                 not isinstance(configuration['platform'], Device):
-            skipit = ("must run on device, but currently on `%s`" %
-                      configuration['platform'].name)
+            skipit = ("must run on device, but currently on `{}`".format(configuration['platform'].name))
             break
         # Skip if it won't run with nvc on CPU backend
         if i == 'cpu64-nvc' and \
@@ -137,9 +136,9 @@ def EVAL(exprs, *args):
 
 def get_testname(item):
     if item.cls is not None:
-        return "%s::%s::%s" % (item.fspath, item.cls.__name__, item.name)
+        return f"{item.fspath}::{item.cls.__name__}::{item.name}"
     else:
-        return "%s::%s" % (item.fspath, item.name)
+        return f"{item.fspath}::{item.name}"
 
 
 def set_run_reset(env_vars, call):
@@ -179,7 +178,7 @@ def parallel(item, m):
         if len(m) == 2:
             nprocs, scheme = m
         else:
-            raise ValueError("Can't run test: unexpected mode `%s`" % m)
+            raise ValueError(f"Can't run test: unexpected mode `{m}`")
 
     env_vars = {'DEVITO_MPI': scheme}
 

examples/cfd/01_convection.ipynb

@@ -52,7 +52,7 @@
     "c = 1.\n",
     "dx = 2. / (nx - 1)\n",
     "dy = 2. / (ny - 1)\n",
-    "print(\"dx %s, dy %s\" % (dx, dy))\n",
+    "print(f\"dx {dx}, dy {dy}\")\n",
     "sigma = .2\n",
     "dt = sigma * dx"
    ]
@@ -83,7 +83,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "\n",
     "# Create field and assign initial conditions\n",
     "u = np.empty((nx, ny))\n",
@@ -119,9 +119,9 @@
     "\n",
     "    # Apply boundary conditions.\n",
     "    u[0, :] = 1.  # left\n",
-    "    u[-1, :] = 1. # right\n",
+    "    u[-1, :] = 1.  # right\n",
     "    u[:, 0] = 1.  # bottom\n",
-    "    u[:, -1] = 1. # top\n",
+    "    u[:, -1] = 1.  # top\n",
     "    # Note that in the above expressions the NumPy index -1 corresponds to the final point of the array along the indexed dimension,\n",
     "    #    i.e. here u[-1, :] is equivalent to u[80, :].\n"
    ]
@@ -143,7 +143,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "\n",
     "# A small sanity check for auto-testing\n",
     "assert (u[45:55, 45:55] > 1.8).all()\n",
@@ -193,7 +193,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "from devito import Grid, TimeFunction\n",
     "\n",
     "grid = Grid(shape=(nx, ny), extent=(2., 2.))\n",
@@ -302,7 +302,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "from devito import Operator\n",
     "\n",
     "# Reset our initial condition in both buffers.\n",
@@ -364,7 +364,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "\n",
     "# Reset our data field and ICs in both buffers\n",
     "init_hat(field=u.data[0], dx=dx, dy=dy, value=2.)\n",

examples/cfd/01_convection_revisited.ipynb

@@ -77,7 +77,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "\n",
     "# Create field and assign initial conditions\n",
     "u = np.empty((nx, ny))\n",
@@ -114,9 +114,9 @@
     "    # Apply boundary conditions.\n",
     "    # Note: -1 here is the last index in the array, not the one at x=-1 or y=-1.\n",
     "    u[0, :] = 1.  # left\n",
-    "    u[-1, :] = 1. # right\n",
+    "    u[-1, :] = 1.  # right\n",
     "    u[:, 0] = 1.  # bottom\n",
-    "    u[:, -1] = 1. # top"
+    "    u[:, -1] = 1.  # top"
    ]
   },
   {
@@ -136,7 +136,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "\n",
     "# A small sanity check for auto-testing\n",
     "assert (u[45:55, 45:55] > 1.8).all()\n",
@@ -177,7 +177,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "from devito import Grid, TimeFunction\n",
     "\n",
     "grid = Grid(shape=(nx, ny), extent=(2., 2.))\n",
@@ -277,7 +277,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "from devito import Operator\n",
     "\n",
     "# Reset our initial condition in both buffers.\n",
@@ -339,7 +339,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "\n",
     "# Reset our data field and ICs in both buffers\n",
     "init_smooth(field=u.data[0], dx=dx, dy=dy)\n",

examples/cfd/02_convection_nonlinear.ipynb

@@ -73,7 +73,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "\n",
     "# Allocate fields and assign initial conditions\n",
     "u = np.empty((nx, ny))\n",
@@ -109,8 +109,8 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
-    "for n in range(nt + 1): ##loop across number of time steps\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
+    "for n in range(nt + 1):  # loop across number of time steps\n",
     "    un = u.copy()\n",
     "    vn = v.copy()\n",
     "    u[1:, 1:] = (un[1:, 1:] -\n",
@@ -159,7 +159,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "from devito import Grid, TimeFunction\n",
     "\n",
     "# First we need two time-dependent data fields, both initialized with the hat function\n",
@@ -211,8 +211,8 @@
     "update_u = Eq(u.forward, stencil_u, subdomain=grid.interior)\n",
     "update_v = Eq(v.forward, stencil_v, subdomain=grid.interior)\n",
     "\n",
-    "print(\"U update:\\n%s\\n\" % update_u)\n",
-    "print(\"V update:\\n%s\\n\" % update_v)"
+    "print(f\"U update:\\n{update_u}\\n\")\n",
+    "print(f\"V update:\\n{update_v}\\n\")"
    ]
   },
   {
@@ -271,7 +271,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "from devito import Operator\n",
     "\n",
     "# Reset our data field and ICs\n",
@@ -452,7 +452,7 @@
     }
    ],
    "source": [
-    "#NBVAL_IGNORE_OUTPUT\n",
+    "# NBVAL_IGNORE_OUTPUT\n",
     "op = Operator([update_U] + bc_u + bc_v)\n",
     "op(time=nt, dt=dt)\n",
     "\n",