pep8 refactoring (part 6)

Author: rizac

egsim/api/forms/__init__.py

@@ -175,8 +175,9 @@ def errors_json_data(self) -> dict:
 
         # build message. Sort params to make tests deterministic
         return {
-            'message': '; '.join(sorted(f'{", ".join(sorted(ps))}: {err}'
-                                        for err, ps in errors.items()))
+            'message': '; '.join(sorted(
+                f'{", ".join(sorted(ps))}: {err}' for err, ps in errors.items()
+            ))
         }
 
     def param_name_of(self, field: str) -> str:
@@ -317,6 +318,8 @@ def get_region_selected_model_names(
     The returned dict keys are ground motion models, mapped to the hazard source
     regionalizations they were defined for (e.g. {'CauzziEtAl2014: ['share']})
 
+    :param lat: latitude, in degrees
+    :param lon: longitude, in degrees
     :param reg_names: sequence of strings or None, indicating the names of the
         regionalizations to use None (the default) will use all regionalizations
     """
@@ -423,9 +426,8 @@ class GsimInfoForm(GsimForm, APIForm):
     gsim = GsimForm.base_fields['gsim'].__class__(
         required=False,
         help_text=f"{GsimForm.base_fields['gsim'].help_text}. For any input value, "
-                  f"any model whose name contains (case-insensitive search) the value "
-                  f"is used. The model names are usually formatted as "
-                  f"[AuthorYearAdditionalInformation]"
+                  f"any model whose name contains the value is used (case-insensitive search). "
+                  f"The model names are usually formatted as [AuthorYearAdditionalInformation]"
     )
 
     _field2params: dict[str, list[str]] = {'gsim': ('name', 'model')}
@@ -478,7 +480,10 @@ def output(self) -> dict:
             }
             # pretty print doc (removing all newlines, double quotes, etc.):
             doc = " ".join(
-                line.strip().replace("\n", " ").replace("\t", " ").replace('"', "''").
+                line.strip().
+                replace("\n", " ").
+                replace("\t", " ").
+                replace('"', "''").
                 replace(":class:`", "`")
                 for line in doc.strip().split("\n") if line.strip()
             )

egsim/api/forms/flatfile.py

@@ -17,7 +17,8 @@
     get_dtype_of,
     column_exists,
     column_type,
-    column_categorical_dtype, column_aliases,
+    column_categorical_dtype,
+    column_aliases,
     column_dtype,
     column_help,
     query as flatfile_query,

egsim/api/forms/scenarios.py

@@ -83,16 +83,16 @@ class PredictionsForm(GsimImtForm, APIForm):
     # RUPTURE PARAMS:
     magnitude = ArrayField(
         FloatField(),
-        help_text='Magnitude(s). Each magnitude defines a Rupture of the user-defined scenario',
-        required=True
+        required=True,
+        help_text='Magnitude(s). Each magnitude defines a Rupture of the user-defined scenario'
     )
     distance = ArrayField(
         FloatField(),
-        help_text='Distances (km). Each distance defines a Site of the user-defined Scenario',
-        required=True
+        required=True,
+        help_text='Distances (km). Each distance defines a Site of the user-defined Scenario'
     )
     aspect = FloatField(
-        help_text='Rupture Length / Width ≥ 0 and ≤ 1', min_value=0., initial=1.0
+        min_value=0., initial=1.0, help_text='Rupture Length / Width ≥ 0 and ≤ 1'
     )
     dip = FloatField(
         min_value=0., max_value=90., initial=90, help_text="Dip of rupture (deg) ≥ 0 and ≤ 90"
@@ -107,13 +107,13 @@ class PredictionsForm(GsimImtForm, APIForm):
         min_value=0., max_value=360., initial=0., help_text="Strike of rupture (deg) ≥ 0 and ≤ 360"
     )
     ztor = FloatField(
-        help_text='Top of Rupture Depth (km) ≥ 0', min_value=0., initial=0.
+        min_value=0., initial=0., help_text='Top of Rupture Depth (km) ≥ 0'
     )
     # WARNING IF RENAMING FIELD BELOW: RENAME+MODIFY also `clean_msr`
     msr = ChoiceField(
-        help_text='Magnitude-Area Scaling Relationship',
         choices=[(_, _) for _ in _mag_scalerel],
-        initial="WC1994"
+        initial="WC1994",
+        help_text='Magnitude-Area Scaling Relationship'
     )
     # WARNING IF RENAMING FIELD BELOW: RENAME+MODIFY also `clean_location`
     initial_point = ArrayField(

egsim/api/models.py

@@ -159,34 +159,10 @@ def read_from_filepath(self, **kwargs) -> Any:
 
 class Regionalization(MediaFile, Reference):
     """
-    Class handling regionalizations stored in the file system. A regionalization
-    is a collection of regions, where each region is an object denoted by:
-     - a geometry (e.g. a Polygon enclosed by poitns in (lat, lon) coordinates), 
-     - a unique name (identifier) 
-     - a list of ground shaking models selected for the region.
-    For each row of this table, the associated media file is a geoJSON file where a 
-    regionalization is stored as FeatureCollection object, and each region is a 
-    geoJSON Feature object. E.g.:
-    ```
-    {
-        "type": 'FeatureCollection',
-        "features" : [
-            {
-                "type": "Feature",
-                "geometry": list,
-                "properties": {
-                    "region": str,
-                    "models": list[str],
-                    ...
-                }
-            },
-            ...
-        ]
-    }
-    ```
-    Note for developers:. See `read_from_filepath` to convert a Feature
-    geometry to a shapely `shape` object
-    """  # noqa
+    Class handling regionalizations stored in the file system.  For each row of this table,
+    the associated media file is a geoJSON text file representing a valid regionalization
+    mapping regions to models (in each Polygon or MultiPolygon "properties")
+    """
 
     def read_from_filepath(self, **kwargs) -> dict:
         """

egsim/api/views.py

@@ -124,9 +124,9 @@ def handle_exception(self, exc: Exception, request) -> HttpResponse:  # noqa
         as response body / content
         """
         return error_response(
-            (f'Server error ({exc.__class__.__name__}): {exc}'.strip() +
-             f'. Please contact the server administrator '
-             f'if you think this error is due to a code bug'),
+            f'Server error ({exc.__class__.__name__}): {str(exc).strip()}. '
+            f'. Please contact the server administrator '
+            f'if you think this error is due to a code bug',
             status=500
         )
 
@@ -166,7 +166,7 @@ def error_response(
         **kwargs
 ) -> HttpResponse:
     """
-    Return a HttpResponse with status 400 (client error) as default
+    Return a HttpResponse with default status 400 (client error)
     and custom message in the response body / content. For custom status,
     provide the `status` explicitly as keyword argument
     """

egsim/app/forms.py

@@ -38,7 +38,7 @@ class PredictionsVisualizeForm(PredictionsForm):
             ('d', 'IMT vs. Distance'),
             ('s', 'Magnitude-Distance Spectra')
         ],
-        help_text='the plot type to be displayed: '
+        help_text='the plot type to be displayed'
     )
 
     def clean(self):
@@ -164,7 +164,9 @@ def groupby(dframe: pd.DataFrame):
     def get_plot_traces_and_layout(
             x: dict[str, np.ndarray],
             y: dict[str, tuple[np.ndarray, np.ndarray]],
-            x_label, y_label, colors: dict[str, str]
+            x_label,
+            y_label,
+            colors: dict[str, str]
     ) -> tuple[list[dict], dict]:
         """
         Return the traces and layout of a prediction plot (to be displayed using the
@@ -291,11 +293,17 @@ def output(self) -> dict:
 
         plots = {}  # will be returned as list (taking the dict values)
 
-        total_res, intra_res, inter_res = \
-            (Clabel.total_res, Clabel.intra_ev_res, Clabel.inter_ev_res)
+        total_res, intra_res, inter_res = (
+            Clabel.total_res,
+            Clabel.intra_ev_res,
+            Clabel.inter_ev_res
+        )
         if likelihood:
-            total_res, intra_res, inter_res = \
-                (Clabel.total_lh, Clabel.intra_ev_lh, Clabel.inter_ev_lh)
+            total_res, intra_res, inter_res = (
+                Clabel.total_lh,
+                Clabel.intra_ev_lh,
+                Clabel.inter_ev_lh
+            )
         res_columns = {total_res, intra_res, inter_res}
         residual_label = {
             total_res: 'Total',
@@ -569,7 +577,9 @@ def output(self) -> dict:
         data, layout = self.get_plot_traces_and_layout(
             dataframe[x_label] if x_label else None,
             dataframe[y_label] if y_label else None,
-            x_label, y_label, next(colors_cycle())
+            x_label,
+            y_label,
+            next(colors_cycle())
         )
         plot = {
             'data': data,

egsim/smtk/flatfile.py

@@ -1,4 +1,4 @@
-"""flatfile root module"""
+"""Flatfile root module"""
 
 from __future__ import annotations
 
@@ -170,9 +170,11 @@ def _read_csv_get_header(filepath_or_buffer: IOBase, sep=None, **kwargs) -> list
         _pos = filepath_or_buffer.tell()
     # use only args necessary to parse columns, we might raise unnecessary errors
     # otherwise (these errors might be fixed afterward before reading the whole csv):
-    args = ['header', 'names', 'skip_blank_lines', 'skipinitialspace', 'engine',
-            'lineterminator', 'quotechar', 'quoting', 'doublequote', 'escapechar',
-            'comment', 'dialect', 'delim_whitespace']
+    args = [
+        'header', 'names', 'skip_blank_lines', 'skipinitialspace', 'engine',
+        'lineterminator', 'quotechar', 'quoting', 'doublequote', 'escapechar',
+        'comment', 'dialect', 'delim_whitespace'
+    ]
     _kwargs = {k: kwargs[k] for k in args if k in kwargs}
     _kwargs['nrows'] = 0  # read just header
     _kwargs['sep'] = sep

egsim/smtk/residuals.py

@@ -176,10 +176,8 @@ def get_observed_motions(flatfile: pd.DataFrame, imts: Container[str], log=True)
 
 
 def yield_event_contexts(flatfile: pd.DataFrame) -> Iterable[EventContext]:
-    """
-    Group the flatfile by events, and yield `EventContext`s objects, one for
-    each event
-    """
+    """Group the flatfile by events, and yield `EventContext`s objects, one for each event"""
+
     # check event id column or use the event location to group events:
     # group flatfile by events. Use ev. id (_EVENT_COLUMNS[0]) or, when
     # no ID found, event spatio-temporal coordinates (_EVENT_COLUMNS[1:])
@@ -372,8 +370,7 @@ def get_residuals_likelihood(residuals: pd.DataFrame, inplace=True) -> pd.DataFr
 
 def get_likelihood(values: Union[np.ndarray, pd.Series]) -> Union[np.ndarray, pd.Series]:
     """
-    Return the likelihood of the given values according to Equation 9 of
-    Scherbaum et al. (2004)
+    Return the likelihood of the given values according to Equation 9 of Scherbaum et al. (2004)
     """
     zvals = np.fabs(values)
     return 1.0 - erf(zvals / sqrt(2.))
@@ -384,9 +381,10 @@ def get_likelihood(values: Union[np.ndarray, pd.Series]) -> Union[np.ndarray, pd
 def get_column_name(flatfile: pd.DataFrame, column: str) -> Union[str, None]:
     """
     Return the flatfile column matching `column`. This could be `column`
-     itself, or any of its aliases (see `columns` module and YAML file)
-     Returns None if no column is found, raise `IncompatibleColumnError` if more than
-     a matching column is found"""
+    itself, or any of its aliases (see `columns` module and YAML file)
+    Returns None if no column is found, raise `IncompatibleColumnError` if more than
+    a matching column is found
+    """
     ff_cols = set(flatfile.columns)
     cols = set(column_aliases(column)) & ff_cols
     if len(cols) > 1:

egsim/smtk/scenarios.py

@@ -132,18 +132,15 @@ class RuptureProperties)
     # build our dataframe data (horizontal concat data + meta_data into data):
     data.append(meta_data)
     # build our dataframe columns (append the meta_data columns from meta_columns):
-    meta_columns = [
-        (Clabel.input, str(column_type(m).value), m) for m in meta_fields
-    ]
+    meta_columns = [(Clabel.input, str(column_type(m).value), m) for m in meta_fields]
     columns.extend(meta_columns)
 
     # compute final DataFrame:
     output = pd.DataFrame(columns=columns, data=np.hstack(data))
 
     # sort columns (maybe we could use reindex but let's be more explicit):
     computed_cols = set(output.columns)
-    expected_cols = \
-        list(product(imts, [Clabel.median, Clabel.std], gsims)) + meta_columns
+    expected_cols = list(product(imts, [Clabel.median, Clabel.std], gsims)) + meta_columns
     output = output[[c for c in expected_cols if c in computed_cols]].copy()
     if header_sep:
         output.columns = [header_sep.join(c) for c in output.columns]
@@ -242,8 +239,7 @@ def create_planar_surface(
     :param aspect: Aspect ratio of rupture
     :param ztor: top of rupture depth, in km
 
-    :return: Rupture as an instance of
-        :class:`openquake.hazardlib.geo.surface.planar.PlanarSurface`
+    :return: Rupture as instance of :class:`openquake.hazardlib.geo.surface.planar.PlanarSurface`
     """
     # If the top of rupture depth in the initial
     if fabs(top_centroid.depth - ztor) > 1E-9:
@@ -362,8 +358,7 @@ def get_hypocentre_on_planar_surface(
         a hypocentre located in a position 3/4 along the length, and 1/4 of the
         way down dip of the rupture plane would be entered as (0.75, 0.25)
 
-    :return: Hypocentre location as instance of
-        :class:`openquake.hazardlib.geo.point.Point`
+    :return: Hypocentre location as instance of :class:`openquake.hazardlib.geo.point.Point`
     """
     centroid = plane.get_middle_point()
     if hypo_loc is None:
@@ -412,17 +407,18 @@ def _rup_to_point(
     dist_sin_dip = distance / sin_dip
     iterval = 0
     while (np.fabs(r_diff) >= iter_stop) and (iterval <= maxiter):
-        pt1mesh = Mesh(np.array([pt1.longitude]),
-                       np.array([pt1.latitude]),
-                       None)
+        pt1mesh = Mesh(
+            np.array([pt1.longitude]),
+            np.array([pt1.latitude]),
+            None
+        )
         if distance_type == 'rjb' or np.fabs(dip - 90.0) < 1.0E-3:
             r_diff = (distance - surface.get_joyner_boore_distance(pt1mesh)).flatten()
             pt0 = Point(pt1.longitude, pt1.latitude)
             if r_diff > 0.:
                 pt1 = pt0.point_at(r_diff, 0., azimuth)
             else:
-                pt1 = pt0.point_at(np.fabs(r_diff), 0.,
-                                   (azimuth + 180.) % 360.)
+                pt1 = pt0.point_at(np.fabs(r_diff), 0., (azimuth + 180.) % 360.)
         elif distance_type == 'rrup':
             rrup = surface.get_min_distance(pt1mesh).flatten()
             if 0.0 <= azimuth <= 180.0:
@@ -435,8 +431,7 @@ def _rup_to_point(
             if r_diff > 0.:
                 pt1 = pt0.point_at(r_diff, 0., azimuth)
             else:
-                pt1 = pt0.point_at(np.fabs(r_diff), 0.,
-                                   (azimuth + 180.) % 360.)
+                pt1 = pt0.point_at(np.fabs(r_diff), 0., (azimuth + 180.) % 360.)
         else:
             raise ValueError('Distance type must be rrup or rjb')
         iterval += 1

egsim/smtk/validation.py

@@ -209,7 +209,8 @@ def get_ground_motion_values(
                     m_buf[:, start:end],
                     s_buf[:, start:end],
                     t_buf[:, start:end],
-                    p_buf[:, start:end])
+                    p_buf[:, start:end]
+                )
             except oq_exceptions as exc:
                 raise _format_model_error(model_name or model, exc)
             # set computed values back to our variables:
@@ -240,8 +241,9 @@ def _format_model_error(model: Union[GMPE, str], exception: Exception) -> ModelE
         if '/openquake/' in fname and fname.rfind('/') < len(fname) - 3:
             suffix = f"OpenQuake {suffix} @{fname[fname.rfind('/') + 1:]}:{lineno}"
 
-    return ModelError(f'{model if isinstance(model, str) else gsim_name(model)}: '
-                      f'{str(exception)} ({suffix})')
+    return ModelError(
+        f'{model if isinstance(model, str) else gsim_name(model)}: {str(exception)} ({suffix})'
+    )
 
 
 # Custom Exceptions ===========================================================