Code tidying

gprMax/utilities/logging.py

@@ -58,7 +58,8 @@ class CustomFormatter(logging.Formatter):
         colored_record = copy(record)
         levelname = colored_record.levelname
         seq = MAPPING.get(levelname, 37) # default white
-        colored_levelname = ('{0}{1}m{2}{3}').format(PREFIX, seq, levelname, SUFFIX)
+        colored_levelname = ('{0}{1}m{2}{3}').format(PREFIX, seq, 
+                                                     levelname, SUFFIX)
         colored_record.levelname = colored_levelname
         return logging.Formatter.format(self, colored_record)
 
@@ -67,10 +68,10 @@ def logging_config(name='gprMax', level=logging.INFO, format_style='std', log_fi
     """Setup and configure logging.
 
     Args:
-        name (str): name of logger to create.
-        level (logging level): set logging level to stdout.
-        format_style (str): set formatting - 'std' or 'full'
-        log_file (bool): additional logging to file.
+        name: string of name of logger to create.
+        level: logging level to set logging level to stdout.
+        format_style: string to set formatting - 'std' or 'full'
+        log_file: bool for additional logging to file.
     """
 
     format_std = "%(message)s"
@@ -97,7 +98,8 @@ def logging_config(name='gprMax', level=logging.INFO, format_style='std', log_fi
 
     # Config for logging to file if required
     if log_file:
-        filename = name + '-log-' + datetime.datetime.now().strftime("%Y%m%d-%H%M%S") + '.txt'
+        filename = (name + '-log-' + 
+                    datetime.datetime.now().strftime("%Y%m%d-%H%M%S") + '.txt')
         handler = logging.FileHandler(filename, mode='w')
         formatter = logging.Formatter(format_full)
         handler.setLevel(logging.DEBUG)

gprMax/utilities/utilities.py

@@ -35,15 +35,16 @@ try:
     from time import thread_time as timer_fn
 except ImportError:
     from time import perf_counter as timer_fn
-    logger.debug('"thread_time" not currently available in macOS and bug'\
-                   ' (https://bugs.python.org/issue36205) with "process_time", so use "perf_counter".')
+    logger.debug('"thread_time" not currently available in macOS and bug'
+                   ' (https://bugs.python.org/issue36205) with "process_time", '
+                   'so use "perf_counter".')
 
 
 def get_terminal_width():
     """Get/set width of terminal being used.
 
     Returns:
-        terminalwidth (int): Terminal width
+        terminalwidth: an int for the terminal width.
     """
 
     terminalwidth = get_terminal_size()[0]
@@ -57,19 +58,31 @@ def logo(version):
     """Print gprMax logo, version, and licencing/copyright information.
 
     Args:
-        version (str): Version number.
+        version: string for version number.
 
     Returns:
-        (str): Containing logo, version, and licencing/copyright information.
+        str: string containing logo, version, and licencing/copyright info.
     """
 
-    description = '\n=== Electromagnetic modelling software based on the Finite-Difference Time-Domain (FDTD) method'
+    description = ('\n=== Electromagnetic modelling software based on the '
+                   'Finite-Difference Time-Domain (FDTD) method')
     current_year = datetime.datetime.now().year
-    copyright = f'Copyright (C) 2015-{current_year}: The University of Edinburgh, United Kingdom'
+    copyright = (f'Copyright (C) 2015-{current_year}: The University of '
+                  'Edinburgh, United Kingdom')
     authors = 'Authors: Craig Warren, Antonis Giannopoulos, and John Hartley'
-    licenseinfo1 = 'gprMax is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\n'
-    licenseinfo2 = 'gprMax is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.'
-    licenseinfo3 = 'You should have received a copy of the GNU General Public License along with gprMax.  If not, see www.gnu.org/licenses.'
+    licenseinfo1 = ('gprMax is free software: you can redistribute it and/or '
+                    'modify it under the terms of the GNU General Public '
+                    'License as published by the Free Software Foundation, '
+                    'either version 3 of the License, or (at your option) any '
+                    'later version.\n')
+    licenseinfo2 = ('gprMax is distributed in the hope that it will be useful, '
+                    'but WITHOUT ANY WARRANTY; without even the implied '
+                    'warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR '
+                    'PURPOSE.  See the GNU General Public License for more '
+                    'details.')
+    licenseinfo3 = ('You should have received a copy of the GNU General Public '
+                    'License along with gprMax.  If not, '
+                    'see www.gnu.org/licenses.')
 
     logo = """    www.gprmax.com   __  __
      __ _ _ __  _ __|  \/  | __ ___  __
@@ -81,53 +94,43 @@ def logo(version):
 
     str = f"{description} {'=' * (get_terminal_width() - len(description) - 1)}\n\n"
     str += Fore.CYAN + f'{logo}'
-    str += Style.RESET_ALL + textwrap.fill(copyright, width=get_terminal_width() - 1, initial_indent=' ') + '\n'
-    str += textwrap.fill(authors, width=get_terminal_width() - 1, initial_indent=' ') + '\n\n'
-    str += textwrap.fill(licenseinfo1, width=get_terminal_width() - 1, initial_indent=' ', subsequent_indent='  ') + '\n'
-    str += textwrap.fill(licenseinfo2, width=get_terminal_width() - 1, initial_indent=' ', subsequent_indent='  ') + '\n'
-    str += textwrap.fill(licenseinfo3, width=get_terminal_width() - 1, initial_indent=' ', subsequent_indent='  ')
+    str += Style.RESET_ALL + textwrap.fill(copyright, 
+                                           width=get_terminal_width() - 1, 
+                                           initial_indent=' ') + '\n'
+    str += textwrap.fill(authors, width=get_terminal_width() - 1, 
+                         initial_indent=' ') + '\n\n'
+    str += textwrap.fill(licenseinfo1, width=get_terminal_width() - 1, 
+                         initial_indent=' ', subsequent_indent='  ') + '\n'
+    str += textwrap.fill(licenseinfo2, width=get_terminal_width() - 1, 
+                         initial_indent=' ', subsequent_indent='  ') + '\n'
+    str += textwrap.fill(licenseinfo3, width=get_terminal_width() - 1, 
+                         initial_indent=' ', subsequent_indent='  ')
 
     return str
 
 
-def pretty_xml(roughxml):
-    """Nicely format XML string.
-
-    Args:
-        roughxml (str): XML string to format
-
-    Returns:
-        prettyxml (str): nicely formatted XML string
-    """
-
-    prettyxml = xml.dom.minidom.parseString(roughxml).toprettyxml()
-    # Remove the weird newline issue
-    prettyxml = os.linesep.join(
-        [s for s in prettyxml.splitlines() if s.strip()])
-
-    return prettyxml
-
-
 def round_value(value, decimalplaces=0):
     """Rounding function.
 
     Args:
-        value (float): Number to round.
-        decimalplaces (int): Number of decimal places of float to represent
+        value: float of number to round.
+        decimalplaces: int for number of decimal places of float to represent
                         rounded value.
 
     Returns:
-        rounded (int/float): Rounded value.
+        rounded: int/float of rounded value.
     """
 
     # Rounds to nearest integer (half values are rounded downwards)
     if decimalplaces == 0:
-        rounded = int(d.Decimal(value).quantize(d.Decimal('1'), rounding=d.ROUND_HALF_DOWN))
+        rounded = int(d.Decimal(value).quantize(d.Decimal('1'), 
+                      rounding=d.ROUND_HALF_DOWN))
 
     # Rounds down to nearest float represented by number of decimal places
     else:
         precision = '1.{places}'.format(places='0' * decimalplaces)
-        rounded = float(d.Decimal(value).quantize(d.Decimal(precision), rounding=d.ROUND_FLOOR))
+        rounded = float(d.Decimal(value).quantize(d.Decimal(precision), 
+                        rounding=d.ROUND_FLOOR))
 
     return rounded
 
@@ -142,15 +145,16 @@ def fft_power(waveform, dt):
         converted to decibels and shifted so that maximum power is 0dB
 
     Args:
-        waveform (ndarray): time domain waveform
-        dt (float): time step
+        waveform: array containing time domain waveform.
+        dt: float of time step.
 
     Returns:
-        freqs (ndarray): frequency bins
-        power (ndarray): power
+        freq: array of frequency bins.
+        power: array containing power spectra.
     """
 
-    # Calculate magnitude of frequency spectra of waveform (ignore warning from taking a log of any zero values)
+    # Calculate magnitude of frequency spectra of waveform (ignore warning from 
+    # taking a log of any zero values)
     with np.errstate(divide='ignore'):
         power = 10 * np.log10(np.abs(np.fft.fft(waveform))**2)
 
@@ -170,11 +174,12 @@ def human_size(size, a_kilobyte_is_1024_bytes=False):
     """Convert a file size to human-readable form.
 
     Args:
-        size (int): file size in bytes.
-        a_kilobyte_is_1024_bytes (boolean) - true for multiples of 1024, false for multiples of 1000.
+        size: int for file size in bytes.
+        a_kilobyte_is_1024_bytes: bool - true for multiples of 1024, 
+                                    or false for multiples of 1000.
 
     Returns:
-        Human-readable (string).
+        Human-readable string of size.
     """
 
     suffixes = {1000: ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'], 1024: ['KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB']}
@@ -207,9 +212,10 @@ def timer():
 
 
 def numeric_list_to_int_list(l):
-    """Return a list of int from a numerical list"""
+    """Return a list of int from a numerical list."""
     return list(map(int, l))
 
+
 def numeric_list_to_float_list(l):
-    """Return a list of int from a numerical list"""
+    """Return a list of float from a numerical list."""
     return list(map(float, l))