pep8 refactoring (part 2)

Author: rizac

egsim/api/models.py

@@ -27,12 +27,13 @@ class EgsimDbModel(DjangoDbModel):
     _meta: Options  # https://docs.djangoproject.com/en/stable/ref/models/options/
 
     name = TextField(null=False, unique=True, help_text="Unique name")
-    hidden = BooleanField(default=False, null=False,
-                          help_text="Hide this item, i.e. make it publicly "
-                                    "unavailable to the whole API. This field "
-                                    "is intended to hide/show items quickly from "
-                                    "the admin panel without executing management "
-                                    "scrips")
+    hidden = BooleanField(
+        default=False,
+        null=False,
+        help_text="Hide this item, i.e. make it publicly unavailable to the whole API. "
+                  "This field is intended to hide/show items quickly without re-creating "
+                  "the DB data"
+    )
 
     class Meta:
         abstract = True
@@ -70,23 +71,29 @@ class Gsim(EgsimDbModel):
     is populated with valid OpenQuake models only (`passing valid.gsim` or not
     deprecated)
     """
-    imts = TextField(null=False,
-                     help_text='The intensity measure types '
-                               'defined for the model, space separated '
-                               '(e.g.: "PGA SA")')
-    min_sa_period = FloatField(null=True,
-                               help_text='The minimum SA period supported '
-                                         'by the model, or None (no lower limit)')
-    max_sa_period = FloatField(null=True,
-                               help_text='The maximum SA period supported '
-                                         'by the model, or None (no upper limit)')
+    imts = TextField(
+        null=False,
+        help_text='The intensity measure types defined for the model, '
+                  'space separated (e.g.: "PGA SA")'
+    )
+    min_sa_period = FloatField(
+        null=True,
+        help_text='The minimum SA period supported by the model, or None (no lower limit)'
+    )
+    max_sa_period = FloatField(
+        null=True,
+        help_text='The maximum SA period supported by the model, or None (no upper limit)'
+    )
 
     unverified = BooleanField(default=False, help_text="not independently verified")
-    experimental = BooleanField(default=False, help_text="experimental: may "
-                                                         "change in future versions")
-    adapted = BooleanField(default=False, help_text="not intended for general use: "
-                                                    "the behaviour may not be "
-                                                    "as expected")
+    experimental = BooleanField(
+        default=False,
+        help_text="experimental: may change in future versions"
+    )
+    adapted = BooleanField(
+        default=False,
+        help_text="not intended for general use: the behaviour may not be as expected"
+    )
     # Note: `superseded_by` is not used (we do not save deprecated Gsims)
 
 
@@ -98,8 +105,11 @@ class Reference(DjangoDbModel):
     display_name = TextField(default=None, null=True)
     url = URLField(default=None, null=True)
     license = TextField(default=None, null=True)
-    citation = TextField(default=None, null=True,
-                         help_text="Bibliographic citation, as text")
+    citation = TextField(
+        default=None,
+        null=True,
+        help_text="Bibliographic citation, as text"
+    )
     doi = TextField(default=None, null=True)
 
     class Meta:
@@ -109,9 +119,12 @@ class Meta:
 class MediaFile(EgsimDbModel):
     """Abstract class handling any data file in the MEDIA directory of eGSIM"""
     # for safety, do not store full file paths in the db (see `filepath` for details):
-    filepath = TextField(unique=True, null=False,
-                         help_text="the file absolute path (usually within the "
-                                   "MEDIA_ROOT path defined in Django settings)")
+    filepath = TextField(
+        unique=True,
+        null=False,
+        help_text="the file absolute path (usually within the MEDIA_ROOT path "
+                  "defined in Django settings)"
+    )
 
     def read_from_filepath(self, **kwargs) -> Any:
         raise NotImplementedError()

egsim/api/views.py

@@ -9,8 +9,13 @@
 
 import yaml
 import pandas as pd
-from django.http import (JsonResponse, HttpRequest, QueryDict, FileResponse,
-                         HttpResponseBase)
+from django.http import (
+    JsonResponse,
+    HttpRequest,
+    QueryDict,
+    FileResponse,
+    HttpResponseBase
+)
 from django.http.response import HttpResponse
 from django.views.generic.base import View
 
@@ -68,9 +73,11 @@ def post(self, request: HttpRequest) -> HttpResponseBase:
             if request.FILES:
                 # request.content_type='multipart/form-data' (see link below for details)
                 # https://docs.djangoproject.com/en/stable/ref/request-response/#django.http.HttpRequest.FILES  # noqa
-                return self.response(request,
-                                     data=self.parse_query_dict(request.POST),
-                                     files=request.FILES)
+                return self.response(
+                    request,
+                    data=self.parse_query_dict(request.POST),
+                    files=request.FILES
+                )
             else:
                 # request.content_type might be anything (most likely
                 # 'application/json' or 'application/x-www-form-urlencoded')
@@ -83,10 +90,12 @@ def post(self, request: HttpRequest) -> HttpResponseBase:
         except Exception as exc:
             return self.handle_exception(exc, request)
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None) -> HttpResponseBase:
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponseBase:
         """
         Return a Django HttpResponse from the given arguments extracted from a GET
         or POST request. Any Exception raised here will be returned as 500 HttpResponse
@@ -114,15 +123,18 @@ def handle_exception(self, exc: Exception, request) -> HttpResponse:  # noqa
         server error (HttpResponse 500) with the exception string representation
         as response body / content
         """
-        return self.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'
-        ), status=self.SERVER_ERR_CODE)
-
-    def error_response(self,
-                       message: Union[str, Exception, bytes] = '',
-                       **kwargs) -> HttpResponse:
+        return self.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'),
+            status=self.SERVER_ERR_CODE
+        )
+
+    def error_response(
+            self,
+            message: Union[str, Exception, bytes] = '',
+            **kwargs
+    ) -> HttpResponse:
         """
         Return a HttpResponse with default status set to self.CLIENT_ERR_CODE
         and custom message in the response body / content. For custom status,
@@ -166,10 +178,12 @@ def parse_query_dict(  # noqa
 class NotFound(EgsimView):
     """View for the 404 Not Found HttpResponse"""
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None) -> HttpResponse:
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponse:
         return self.error_response(status=404)
 
 
@@ -229,10 +243,12 @@ def response_hdf(form: APIForm) -> HttpResponse:
         'json': lambda form: JsonResponse(form.output(), status=200)
     }
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None):
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponseBase:
         """
         Return a HttpResponse from the given arguments. The Response body / content
         will be populated with the output of this class Form
@@ -269,10 +285,12 @@ class SmtkView(APIFormView):
         'csv': lambda form: SmtkView.response_csv(form)
     }
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None):
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponseBase:
         """
         Call superclass method but catch ModelError(s) returning the appropriate
         HTTPResponse (Client error)

egsim/app/forms.py

@@ -13,8 +13,16 @@
 
 from egsim.smtk.flatfile import ColumnType
 from egsim.smtk.registry import Clabel, sa_period
-from .plotly import (colors_cycle, axis_type, axis_range, scatter_trace,
-                     bar_trace, line_trace, histogram_trace, AxisType)
+from .plotly import (
+    colors_cycle,
+    axis_type,
+    axis_range,
+    scatter_trace,
+    bar_trace,
+    line_trace,
+    histogram_trace,
+    AxisType
+)
 from ..smtk.converters import datetime2float
 
 

egsim/app/urls.py

@@ -23,16 +23,22 @@
 
 
 urlpatterns = [
-    re_path(r'^$', RedirectView.as_view(pattern_name='main', url='home',
-                                        permanent=False)),
-    re_path((r'^(?P<page>' +
-             '|'.join([URLS.WEBPAGE_HOME, URLS.WEBPAGE_PREDICTIONS,
-                       URLS.WEBPAGE_RESIDUALS,
-                       URLS.WEBPAGE_FLATFILE_INSPECTION_PLOT,
-                       URLS.WEBPAGE_FLATFILE_COMPILATION_INFO,
-                       URLS.WEBPAGE_API_DOC,
-                       URLS.WEBPAGE_IMPRINT, URLS.WEBPAGE_CITATIONS_AND_LICENSE]) +
-             ')/?$'), main),
+    re_path(
+        r'^$',
+        RedirectView.as_view(pattern_name='main', url='home', permanent=False)
+    ),
+    re_path(
+        (r'^(?P<page>' +
+         '|'.join([
+             URLS.WEBPAGE_HOME, URLS.WEBPAGE_PREDICTIONS,
+             URLS.WEBPAGE_RESIDUALS,
+             URLS.WEBPAGE_FLATFILE_INSPECTION_PLOT,
+             URLS.WEBPAGE_FLATFILE_COMPILATION_INFO,
+             URLS.WEBPAGE_API_DOC,
+             URLS.WEBPAGE_IMPRINT, URLS.WEBPAGE_CITATIONS_AND_LICENSE
+         ]) + ')/?$'),
+        main
+    ),
 
     re_path(
         fr'^{URLS.DOWNLOAD_PREDICTIONS_DATA}.(?:{"|".join(data_ext)})$',

egsim/app/views.py

@@ -14,8 +14,9 @@
 from django.conf import settings
 
 from ..api import models
-from ..api.forms.flatfile import (FlatfileMetadataInfoForm,
-                                  FlatfileValidationForm)
+from ..api.forms.flatfile import (
+    FlatfileMetadataInfoForm, FlatfileValidationForm
+)
 from ..api.forms import APIForm, EgsimBaseForm, GsimForm
 from ..api.forms.residuals import ResidualsForm
 from ..api.forms.scenarios import PredictionsForm
@@ -72,8 +73,10 @@ class URLS:  # noqa
         "/" in getattr(URLS, _) and not getattr(URLS, _).startswith('https://')
         for _ in dir(URLS) if 'WEBPAGE' in _
 ):
-    raise SystemError("Remove '/' in URL WEBPAGES: '/' create nested paths which might "
-                      "mess up requests performed on the page (error 404)")
+    raise SystemError(
+        "Remove '/' in URL WEBPAGES: '/' create nested paths which might "
+        "mess up requests performed on the page (error 404)"
+    )
 
 
 ############################################
@@ -109,10 +112,12 @@ def main(request, page=''):
 class GsimFromRegion(EgsimView):
     """View handling clicks on the GUI map and returning region-selected model(s)"""
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None) -> HttpResponseBase:
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponseBase:
         form = GsimForm(data)
         if form.is_valid():
             gm_models = form.cleaned_data['regionalization']
@@ -124,10 +129,12 @@ def response(self,
 class PlotsImgDownloader(EgsimView):
     """View returning the browser displayed plots in image format"""
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None) -> HttpResponseBase:
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponseBase:
         """
         Process the response from a given request and the data / files
         extracted from it
@@ -157,10 +164,12 @@ def response(self,
 class PredictionsHtmlTutorial(EgsimView):
     """View returning the HTML page(s) explaining predictions table structure"""
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None) -> HttpResponseBase:
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponseBase:
         """Process the response from a given request and the data / files extracted from it"""
         from egsim.api.client.snippets.get_egsim_predictions import \
             get_egsim_predictions
@@ -182,10 +191,12 @@ def response(self,
 class ResidualsHtmlTutorial(EgsimView):
     """View returning the HTML page(s) explaining residuals table structure"""
 
-    def response(self,
-                 request: HttpRequest,
-                 data: dict,
-                 files: Optional[dict] = None) -> HttpResponseBase:
+    def response(
+            self,
+            request: HttpRequest,
+            data: dict,
+            files: Optional[dict] = None
+    ) -> HttpResponseBase:
         """Process the response from a given request and the data / files
         extracted from it"""
         from egsim.api.client.snippets.get_egsim_residuals import \
@@ -240,8 +251,9 @@ def get_init_data_json(
             model_warnings.append(models.Gsim.adapted.field.help_text)
         if model_warnings:
             warning_text = "; ".join(model_warnings)
-            warning_group_index = warning_groups.setdefault(warning_text,
-                                                            len(warning_groups))
+            warning_group_index = warning_groups.setdefault(
+                warning_text, len(warning_groups)
+            )
             gsims.append([gsim.name, imt_group_index, sa_limits, warning_group_index])
         else:
             gsims.append([gsim.name, imt_group_index, sa_limits])