Fix code style issues

Author: simonhammes

scheduler/app/faas_scheduler/models.py

@@ -67,10 +67,12 @@ def to_dict(self, include_context_data=True, include_output=True):
         }
 
         if include_context_data:
-            entry['context_data'] = json.loads(self.context_data) if self.context_data else None
+            entry["context_data"] = (
+                json.loads(self.context_data) if self.context_data else None
+            )
 
         if include_output:
-            entry['output'] = self.output
+            entry["output"] = self.output
 
         return entry
 

scheduler/app/faas_scheduler/utils.py

@@ -498,8 +498,21 @@ def get_run_script_statistics_by_month(
     return month.strftime("%Y-%m"), total_count, results
 
 
-def get_script_runs(db_session, org_id, base_uuid, start, end, page, per_page) -> Tuple[List[ScriptLog], int]:
-    fields = [ScriptLog.id, ScriptLog.dtable_uuid, ScriptLog.owner, ScriptLog.org_id, ScriptLog.script_name, ScriptLog.started_at, ScriptLog.finished_at, ScriptLog.success, ScriptLog.return_code, ScriptLog.operate_from]
+def get_script_runs(
+    db_session, org_id, base_uuid, start, end, page, per_page
+) -> Tuple[List[ScriptLog], int]:
+    fields = [
+        ScriptLog.id,
+        ScriptLog.dtable_uuid,
+        ScriptLog.owner,
+        ScriptLog.org_id,
+        ScriptLog.script_name,
+        ScriptLog.started_at,
+        ScriptLog.finished_at,
+        ScriptLog.success,
+        ScriptLog.return_code,
+        ScriptLog.operate_from,
+    ]
     query = db_session.query(ScriptLog).options(load_only(*fields))
 
     if org_id:
@@ -515,28 +528,46 @@ def get_script_runs(db_session, org_id, base_uuid, start, end, page, per_page) -
         query = query.filter(ScriptLog.started_at <= end)
 
     total_count = query.count()
-    runs = query.limit(per_page).offset((page-1) * per_page).all()
+    runs = query.limit(per_page).offset((page - 1) * per_page).all()
 
     return runs, total_count
 
 
-def get_statistics_grouped_by_base(db_session, org_id: int, start: Optional[datetime], end: Optional[datetime], page: int, per_page: int) -> Tuple[List[dict], int]:
+def get_statistics_grouped_by_base(
+    db_session,
+    org_id: int,
+    start: Optional[datetime],
+    end: Optional[datetime],
+    page: int,
+    per_page: int,
+) -> Tuple[List[dict], int]:
     fields = [
         ScriptLog.dtable_uuid,
-        func.count(ScriptLog.id).label('number_of_runs'),
+        func.count(ScriptLog.id).label("number_of_runs"),
         # This calls MariaDB's TIMESTAMPDIFF() function with microsecond precision to prevent rounding errors
         # Note: Scripts that haven't finished yet are simply ignored
-        func.sum(func.timestampdiff(text('MICROSECOND'), ScriptLog.started_at, ScriptLog.finished_at) / 1_000_000).label('total_run_time'),
+        func.sum(
+            func.timestampdiff(
+                text("MICROSECOND"), ScriptLog.started_at, ScriptLog.finished_at
+            )
+            / 1_000_000
+        ).label("total_run_time"),
         # FIXME: manualy -> manually
-        func.count(case((ScriptLog.operate_from == 'manualy', 1))).label('triggered_manually'),
-        func.count(case((ScriptLog.operate_from == 'automation-rule', 1))).label('triggered_by_automation_rule'),
-        func.count(case((ScriptLog.success == True, 1))).label('successful_runs'),
-        func.count(case((ScriptLog.success == False, 1))).label('unsuccessful_runs'),
+        func.count(case((ScriptLog.operate_from == "manualy", 1))).label(
+            "triggered_manually"
+        ),
+        func.count(case((ScriptLog.operate_from == "automation-rule", 1))).label(
+            "triggered_by_automation_rule"
+        ),
+        func.count(case((ScriptLog.success == True, 1))).label("successful_runs"),
+        func.count(case((ScriptLog.success == False, 1))).label("unsuccessful_runs"),
     ]
 
-    query = db_session.query(*fields) \
-        .filter_by(org_id=org_id) \
+    query = (
+        db_session.query(*fields)
+        .filter_by(org_id=org_id)
         .group_by(ScriptLog.dtable_uuid)
+    )
 
     if start:
         query = query.filter(ScriptLog.started_at >= start)
@@ -545,24 +576,27 @@ def get_statistics_grouped_by_base(db_session, org_id: int, start: Optional[date
         query = query.filter(ScriptLog.started_at <= end)
 
     total_count = query.count()
-    rows = query.limit(per_page).offset((page-1) * per_page).all()
+    rows = query.limit(per_page).offset((page - 1) * per_page).all()
 
     results = []
 
     for row in rows:
-        results.append({''
-            'base_uuid': row.dtable_uuid,
-            'number_of_runs': row.number_of_runs,
-            # int() is required since MariaDB returns total_run_time as a string
-            'total_run_time': int(row.total_run_time),
-            'triggered_manually': row.triggered_manually,
-            'triggered_by_automation_rule': row.triggered_by_automation_rule,
-            'successful_runs': row.successful_runs,
-            'unsuccessful_runs': row.unsuccessful_runs,
-        })
+        results.append(
+            {
+                "base_uuid": row.dtable_uuid,
+                "number_of_runs": row.number_of_runs,
+                # int() is required since MariaDB returns total_run_time as a string
+                "total_run_time": int(row.total_run_time),
+                "triggered_manually": row.triggered_manually,
+                "triggered_by_automation_rule": row.triggered_by_automation_rule,
+                "successful_runs": row.successful_runs,
+                "unsuccessful_runs": row.unsuccessful_runs,
+            }
+        )
 
     return results, total_count
 
+
 def datetime_to_isoformat_timestr(datetime_obj):
     if not datetime_obj:
         return ""

scheduler/app/flask_server.py

@@ -388,50 +388,52 @@ def base_run_python_statistics():
 
 
 # List all runs
-@app.route('/admin/runs/', methods=['GET'])
+@app.route("/admin/runs/", methods=["GET"])
 def list_runs():
     if not check_auth_token(request):
         return make_response(("Forbidden: the auth token is not correct.", 403))
 
     # org_id and base_uuid are optional
     org_id = request.args.get("org_id")
-    base_uuid = request.args.get('base_uuid')
+    base_uuid = request.args.get("base_uuid")
 
-    if request.args.get('start'):
+    if request.args.get("start"):
         try:
             start = datetime.strptime(request.args.get("start"), "%Y-%m-%d")
-        except:
-            return {'error': 'Invalid value for start parameter'}, 400
+        except ValueError:
+            return {"error": "Invalid value for start parameter"}, 400
     else:
         start = None
 
-    if request.args.get('end'):
+    if request.args.get("end"):
         try:
             end = datetime.strptime(request.args.get("end"), "%Y-%m-%d")
             # Add one day since a date parsed by strptime defaults to midnight
             end = end + timedelta(days=1)
-        except:
-            return {'error': 'Invalid value for end parameter'}, 400
+        except ValueError:
+            return {"error": "Invalid value for end parameter"}, 400
     else:
         end = None
 
     try:
         page = int(request.args.get("page", "1"))
     except ValueError:
-        return {'error': 'page must be an integer'}, 400
+        return {"error": "page must be an integer"}, 400
 
     try:
         per_page = int(request.args.get("per_page", "100"))
     except ValueError:
-        return {'error': 'per_page must be an integer'}, 400
+        return {"error": "per_page must be an integer"}, 400
 
     if per_page > 1000:
-        return {'error': 'per_page cannot be greater than 1000'}, 400
+        return {"error": "per_page cannot be greater than 1000"}, 400
 
     db_session = DBSession()
 
     try:
-        runs, total_count = get_script_runs(db_session, org_id, base_uuid, start, end, page, per_page)
+        runs, total_count = get_script_runs(
+            db_session, org_id, base_uuid, start, end, page, per_page
+        )
     except Exception as e:
         logger.exception(e)
         return make_response(("Internal server error", 500))
@@ -444,50 +446,52 @@ def list_runs():
 
 
 # Get run statistics grouped by base UUID
-@app.route('/admin/statistics/by-base/', methods=['GET'])
+@app.route("/admin/statistics/by-base/", methods=["GET"])
 def get_run_statistics_grouped_by_base():
     if not check_auth_token(request):
         return make_response(("Forbidden: the auth token is not correct.", 403))
 
     org_id = request.args.get("org_id")
     if not org_id:
-        return {'error': 'org_id is required'}, 400
+        return {"error": "org_id is required"}, 400
 
-    if request.args.get('start'):
+    if request.args.get("start"):
         try:
             start = datetime.strptime(request.args.get("start"), "%Y-%m-%d")
-        except:
-            return {'error': 'Invalid value for start parameter'}, 400
+        except ValueError:
+            return {"error": "Invalid value for start parameter"}, 400
     else:
         start = None
 
-    if request.args.get('end'):
+    if request.args.get("end"):
         try:
             end = datetime.strptime(request.args.get("end"), "%Y-%m-%d")
             # Add one day since a date parsed by strptime defaults to midnight
             end = end + timedelta(days=1)
-        except:
-            return {'error': 'Invalid value for end parameter'}, 400
+        except ValueError:
+            return {"error": "Invalid value for end parameter"}, 400
     else:
         end = None
 
     try:
         page = int(request.args.get("page", "1"))
     except ValueError:
-        return {'error': 'page must be an integer'}, 400
+        return {"error": "page must be an integer"}, 400
 
     try:
         per_page = int(request.args.get("per_page", "100"))
     except ValueError:
-        return {'error': 'per_page must be an integer'}, 400
+        return {"error": "per_page must be an integer"}, 400
 
     if per_page > 1000:
-        return {'error': 'per_page cannot be greater than 1000'}, 400
+        return {"error": "per_page cannot be greater than 1000"}, 400
 
     db_session = DBSession()
 
     try:
-        results, total_count = get_statistics_grouped_by_base(db_session, org_id, start, end, page, per_page)
+        results, total_count = get_statistics_grouped_by_base(
+            db_session, org_id, start, end, page, per_page
+        )
     except Exception as e:
         logger.exception(e)
         return make_response(("Internal server error", 500))
@@ -496,6 +500,7 @@ def get_run_statistics_grouped_by_base():
 
     return {"results": results, "total_count": total_count}
 
+
 if __name__ == "__main__":
     http_server = WSGIServer(("127.0.0.1", 5055), app)
     http_server.serve_forever()