improved code readability

Author: NagelsThomas

.pylintrc

@@ -0,0 +1,30 @@
+[MASTER]
+max-line-length=120
+[MESSAGES CONTROL]
+disable=bare-except,
+        broad-except,
+        c-extension-no-member,
+        consider-iterating-dictionary,
+        duplicate-code,
+        fixme,
+        invalid-name,
+        import-error,
+        missing-docstring,
+        no-name-in-module,
+        too-few-public-methods,
+        too-many-branches,
+        too-many-boolean-expressions,
+        too-many-instance-attributes,
+        too-many-statements,
+        too-many-arguments,
+        too-many-locals,
+        ungrouped-imports,
+        unused-argument,
+        useless-super-delegation,
+        protected-access,
+        relative-beyond-top-level,
+        simplifiable-if-expression,
+        too-many-lines,
+        raise-missing-from,
+        unnecessary-lambda,
+        trailing-whitespace

app.py

@@ -1,28 +1,34 @@
 import random
-import os
-import pathlib
 from pathlib import Path
 from random import randint
 from tempfile import NamedTemporaryFile
-from typing import List, Any
+from typing import Any, List
 
 import ifcopenshell
-import ifcopenshell.geom as geom
-from shapely import affinity, Point
-from viktor import ViktorController, File, Color, geometry, UserException
-from viktor.geometry import Triangle, TriangleAssembly, Material
-from viktor.parametrization import ViktorParametrization, FileField, MultiSelectField, DownloadButton, \
-    LineBreak, Text, Lookup, IsFalse, BooleanField, ActionButton
-from viktor.views import GeometryView, GeometryResult
+from shapely import Point, affinity
+from viktor import Color, File, UserException, ViktorController, geometry
+from viktor.geometry import Material, Triangle, TriangleAssembly
+from viktor.parametrization import (
+    BooleanField,
+    DownloadButton,
+    FileField,
+    LineBreak,
+    MultiSelectField,
+    Text,
+    ViktorParametrization,
+)
 from viktor.result import DownloadResult
+from viktor.views import GeometryResult, GeometryView
 
 
 def get_element_options(params, **kwargs) -> List[str]:
     """Get all existing geometry element types from ifc file."""
-    if not params.ifc_upload and params.get_sample_ifc_toggle == False:
+    if not params.ifc_upload and not params.get_sample_ifc_toggle:
         return []
-    elif params.get_sample_ifc_toggle == True:  
-        params.sample_ifc = File.from_path(Path(__file__).parent/"AC20-FZK-Haus (Sample IFC).ifc")
+    if params.get_sample_ifc_toggle:
+        params.sample_ifc = File.from_path(
+            Path(__file__).parent / "AC20-FZK-Haus (Sample IFC).ifc"
+        )
         model = load_ifc_file_into_model(params.sample_ifc)
     else:
         model = load_ifc_file_into_model(params.ifc_upload.file)
@@ -36,6 +42,7 @@ def get_element_options(params, **kwargs) -> List[str]:
 
 class Parametrization(ViktorParametrization):
     """Viktor parametrization."""
+
     text1 = Text(
         """
 # Welcome to the ifc-viewer app!
@@ -57,18 +64,17 @@ class Parametrization(ViktorParametrization):
     )
 
     ifc_upload = FileField(
-        "Upload model", 
-        file_types=[".ifc"], 
+        "Upload model",
+        file_types=[".ifc"],
         max_size=20_000_000,
     )
-    
+
     get_sample_ifc_toggle = BooleanField(
-        "Use sample IFC File", 
-        default=False, 
+        "Use sample IFC File",
+        default=False,
         flex=30,
     )
 
-
     lb = LineBreak()
     text2 = Text(
         """
@@ -79,8 +85,8 @@ class Parametrization(ViktorParametrization):
         """
     )
     element_filter = MultiSelectField(
-        "Filter elements", 
-        options=get_element_options,    
+        "Filter elements",
+        options=get_element_options,
     )
 
     lb = LineBreak()
@@ -91,29 +97,29 @@ class Parametrization(ViktorParametrization):
         """
     )
     download = DownloadButton(
-        'Download', 
-        method='download_file',
+        "Download",
+        method="download_file",
     )
 
 
 class Controller(ViktorController):
     """Viktor Controller."""
 
-    label = 'My Entity Type'
+    label = "My Entity Type"
     parametrization = Parametrization
 
     def download_file(self, params, **kwargs):
         model = load_ifc_file_into_model(params.ifc_upload.file)
-        #remove all other parts from the ifc file which are not viewed
+        # remove all other parts from the ifc file which are not viewed
         for element in model.by_type("IfcElement"):
             if element.get_info()["type"] not in params.element_filter:
                 model.remove(element)
-        #part where we save the model as seen in the viewer
+        # part where we save the model as seen in the viewer
         temp_file = NamedTemporaryFile(suffix=".ifc", delete=False, mode="wb")
         model.write(str(Path(temp_file.name)))
         temp_file.close()
         path_out = Path(temp_file.name)
-        return DownloadResult(path_out.read_bytes(), 'filtered_elements.ifc')
+        return DownloadResult(path_out.read_bytes(), "filtered_elements.ifc")
 
     @staticmethod
     @GeometryView("3D model of filtered elements", duration_guess=12)
@@ -124,7 +130,9 @@ def ifc_view(params, **kwargs):
         if not params.element_filter and params.get_sample_ifc_toggle == False:
             raise UserException("Upload ifc file and select elements.")
         if params.get_sample_ifc_toggle == True:
-            params.sample_ifc = File.from_path(Path(__file__).parent/"AC20-FZK-Haus (Sample IFC).ifc")
+            params.sample_ifc = File.from_path(
+                Path(__file__).parent / "AC20-FZK-Haus (Sample IFC).ifc"
+            )
             model = load_ifc_file_into_model(params.sample_ifc)
         else:
             model = load_ifc_file_into_model(params.ifc_upload.file)
@@ -134,17 +142,14 @@ def ifc_view(params, **kwargs):
         geometry_groups = []
         selected_elements = params.element_filter
         for element_type in selected_elements:
-            material = Material(
-                name=element_type,
-                color=get_random_color(element_type)
-            )
+            material = Material(name=element_type, color=get_random_color(element_type))
             elements = model.by_type(element_type)
             for element in elements:
 
                 # Create triangle assembly and assign material
                 triangle_assembly = TriangleAssembly(
                     triangles=get_faces_from_ifc_element(element, settings),
-                    material=material
+                    material=material,
                 )
                 geometry_groups.append(triangle_assembly)
 
@@ -161,10 +166,18 @@ def get_faces_from_ifc_element(element, settings) -> List[Triangle]:
     # Convert IfcOpenShell matrix to Shapely matrix
     matrix = shape.transformation.matrix.data
     shapely_matrix = [
-        matrix[0], matrix[3], matrix[6],
-        matrix[1], matrix[4], matrix[7],
-        matrix[2], matrix[5], matrix[8],
-        matrix[9], matrix[10], matrix[11],
+        matrix[0],
+        matrix[3],
+        matrix[6],
+        matrix[1],
+        matrix[4],
+        matrix[7],
+        matrix[2],
+        matrix[5],
+        matrix[8],
+        matrix[9],
+        matrix[10],
+        matrix[11],
     ]
 
     # Transform all vertices with transformation matrix
@@ -181,7 +194,7 @@ def get_faces_from_ifc_element(element, settings) -> List[Triangle]:
         triangle = Triangle(
             grouped_verts[faces[i]],
             grouped_verts[faces[i + 1]],
-            grouped_verts[faces[i + 2]]
+            grouped_verts[faces[i + 2]],
         )
         grouped_faces.append(triangle)
 
@@ -191,7 +204,7 @@ def get_faces_from_ifc_element(element, settings) -> List[Triangle]:
 def load_ifc_file_into_model(file: File) -> Any:
     """Load ifc file into ifc model object."""
     ifc_upload: File = file
-    temp_file = NamedTemporaryFile(suffix='.sld', delete=False, mode='wb')
+    temp_file = NamedTemporaryFile(suffix=".sld", delete=False, mode="wb")
     temp_file.write(ifc_upload.getvalue_binary())
     temp_file.close()
     path = Path(temp_file.name)