Improve view functions in facilities blueprint

pycroft/lib/facilities.py

@@ -236,7 +236,9 @@ def make_sort_key(building: Building) -> tuple[str, str | tuple[int, str]]:
     return sorted(buildings, key=make_sort_key)
 
 
-def determine_building(shortname: str | None = None, id: int | None = None) -> Building:
+def determine_building(
+    shortname: str | None = None, id: int | None = None
+) -> Building | None:
     """Determine building from shortname or id in this order.
 
     :param shortname: The short name of the building
@@ -249,4 +251,4 @@ def determine_building(shortname: str | None = None, id: int | None = None) -> B
         return t.cast(Building, session.session.scalars(stmt).one())
     if id:
         return session.session.get(Building, id)
-    raise ValueError("Either shortname or id must be given to identify the building!")
+    return None

pyproject.toml

@@ -18,6 +18,7 @@ files = [
     "pycroft/external_services",
     "ldap_sync",
     "web/blueprints/finance",
+    "web/blueprints/facilities",
     "web/blueprints/__init__.py",
     "web/blueprints/access.py",
     "web/blueprints/navigation.py",
@@ -54,6 +55,7 @@ module = [
     "pycroft.helpers.utc",
     "web.blueprints",
     "web.blueprints.access",
+    "web.blueprints.facilities",
     "web.blueprints.navigation",
 ]
 disallow_untyped_defs = true

requirements.dev.txt

@@ -10,7 +10,7 @@ git+https://github.com/lukasjuhrich/sqlalchemy_schemadisplay.git@master#egg=sqla
 sphinx~=5.1.1
 sphinx-autobuild~=2021.3.14
 git+https://github.com/agdsn/guzzle_sphinx_theme.git@977d49fcbdf2b3df9660d813d4b33369391923e1#egg=guzzle-sphinx-theme
-mypy>=0.961
+mypy~=1.5.0
 celery-types~=0.9.3
 types-jsonschema~=4.3.0
 types-passlib~=1.7.7

tests/frontend/test_facilities.py

@@ -188,8 +188,7 @@ def test_get_no_building(self, ep, client):
             client.assert_ok(ep)
 
     def test_get_wrong_id(self, ep, client, building):
-        with client.flashes_message("Gebäude.*nicht gefunden", "error"):
-            client.assert_url_redirects(url_for(ep, building_id=999))
+        client.assert_url_response_code(url_for(ep, building_id=999), code=404)
 
     def test_get_correct_building_id(self, ep, client, building):
         with client.renders_template("generic_form.html"):
@@ -253,8 +252,8 @@ def used_address(self, class_session, room):
         f.UserFactory(address=room.address, room=room)
 
     def test_get_no_room(self, ep, client):
-        with client.flashes_message("Raum.*nicht gefunden", "error"):
-            client.assert_url_redirects(url_for(ep, room_id=999))
+        with client.flashes_message("Raum.*existiert nicht", "error"):
+            client.assert_url_response_code(url_for(ep, room_id=999), code=404)
 
     def test_get(self, url, client):
         with client.renders_template("generic_form.html"), client.flashes_message(

tools/semgrep.yml

@@ -180,22 +180,6 @@ rules:
     paths:
       include: ["web"]
 
-  - id: explicit-session-begin_nested
-    patterns:
-      - pattern: |
-          with $CM: ...
-      - metavariable-pattern:
-          metavariable: "$CM"
-          pattern: handle_errors($SESS, $...ARGS)
-      - focus-metavariable: "$CM"
-    message: "Use `session.begin` explicitly instead of passing the session to `handle_errors`"
-    fix: |
-      handle_errors($...ARGS), $SESS.begin_nested()
-    languages: [python]
-    severity: ERROR
-    paths:
-      include: ["web"]
-
   - id: commit-in-context-manager
     patterns:
       - pattern: |
@@ -214,3 +198,19 @@ rules:
     severity: ERROR
     paths:
       include: ["web", "pycroft"]
+
+  - id: untyped-flask-endpount
+    patterns:
+      - pattern: |
+          @$APP.route($...ROUTEARGS)
+          def $EP($...ARGS): ...
+      - pattern-not: |
+          @$APP.route($...ROUTEARGS)
+          def $EP($...ARGS) -> $RET: ...
+      - focus-metavariable: "$EP"
+    # no fix, because we would lose the decorator (and I can't make `pattern-inside` work correctly)
+    message:  blueprint functions should be annotated with `ResponseReturnValue`
+    languages: [ python ]
+    severity: ERROR
+    paths:
+      include: ["web"]

web/app.py

@@ -1,4 +1,5 @@
 import os
+import typing as t
 
 import jinja2.ext
 import logging
@@ -8,6 +9,7 @@
     g,
     make_response,
 )
+from flask.typing import ResponseValue
 from flask_babel import Babel
 from flask_login import current_user
 from jinja2 import select_autoescape
@@ -146,11 +148,11 @@ def errorpage(e):
         return render_template('error.html', error=message), code
 
     @app.route('/')
-    def redirect_to_index():
+    def redirect_to_index() -> ResponseValue:
         return redirect(url_for('user.overview'))
 
     @app.route('/debug-sentry')
-    def debug_sentry():
+    def debug_sentry() -> t.NoReturn:
         app.logger.warning("Someone used the debug-sentry endpoint! Also, this is a test warning.")
         app.logger.info("An info log for inbetween")
         app.logger.error("Someone used the debug-sentry endpoint! Also, this is a test error.",