pylint comments, module doc string, splitting ag_api and utils

app/__init__.py

@@ -1,20 +1,35 @@
+'''
+main app module
+'''
+
 import os
 from flask import Flask, render_template, request, g
 from flask_marshmallow import Marshmallow
 from werkzeug.exceptions import NotFound
 
+#declares the Flask app
 app = Flask(__name__)
 
+#imports all models used in this file
+
+#load the config file set by the environment variable 'LAB_CONFIG'.
+# If it isn't set 'config/dev.cfg' is used as default
 config = os.environ.get('LAB_CONFIG', default='config/dev.cfg')
+#imports the settings from the vonfig file
 app.config.from_pyfile(os.path.abspath(config))
+#set the secret key of the app used for ???
 app.secret_key = app.secret_key.encode()
+#initiates the marhmallow instance for this app
 ma = Marshmallow(app)
 
 from app.models.user import Session, User
 from app.models.ag import AG, AGSchema
 from app.models.associations import UserAG
+#imports all utilities used in this file
 from app.utils import after_this_request, requires_auth
 
+
+#import all blueprints of this app
 from app.blueprints.api import v1
 from app.blueprints.api.v1 import user
 from app.blueprints.api.v1 import ag as ag_api
@@ -25,16 +40,23 @@
 from app.blueprints import cal
 from app.blueprints import pizza
 
+#import the database instance from __init__.py in app/
 from app.models import db
+
+#import the mail instance
 from app.mail import mail
 
+#initiate the database and create all database if not already happened at an earlier execution
 db.init_app(app)
 db.create_all(app=app)
 
+#initiate the mail instance
 mail.init_app(app)
 
+#declares the errorhandler, if the route has not been found in the blueprints
 @app.errorhandler(404)
 def not_found(error):
+    print(error)
     return NotFound()
 
 
@@ -45,38 +67,55 @@ def call_after_request_callbacks(response):
     return response
 
 
+#let this function get executed before every request
 @app.before_request
 def auth_middleware():
+    #loads the sessionid from the cookie. If it isn't set is got the default value ''
     sid = request.cookies.get('sid', default='')
+    #checks if the sessionid-cookie was set
     if sid:
+        #if the sessionid-cookie was set: call a function to see whether the session is valid
         session_result = Session.verify(sid)
         if session_result:
+            #if so, set the session as global flask variable for this request
             g.session = session_result
         else:
+            #if not, generate a new session and set it as global flask variable for this request
             _session = Session()
             db.session.add(_session)
             db.session.commit()
             g.session = _session
     else:
+        #if there was no sessionid-cookie,
+        # generate a new session and set is as global flask variable for this request
         _session = Session()
         db.session.add(_session)
         db.session.commit()
         g.session = _session
 
+    #if the session is a valid session for a real user,
+    # get the user and set it as global flask variable for this request
     if g.session.authenticated:
         g.user = User.query.get(g.session.user_id)
 
+    #execute this function after the request
     @after_this_request
     def set_cookie(response):
         if g.session.session_only:
+            #if the user choose not to remember him,
+            # set a sessionid-cookie, that will expire if the brwoser got closed
             response.set_cookie('sid', g.session.get_string_cookie(),
                                 httponly=True)
         else:
+            #if the user choose to remember him,
+            # set a sessionid-cookie, that will expire 60 days after creating the cookie
             response.set_cookie('sid', g.session.get_string_cookie(),
                                 httponly=True, expires=g.session.expires)
 
 
 
+#register all imported blueprints with a unique url_prefix
+
 app.register_blueprint(v1.bp, url_prefix='/api/v1')
 app.register_blueprint(user.bp, url_prefix='/api/v1/user')
 app.register_blueprint(ag_api.bp, url_prefix='/api/v1/ag')
@@ -88,9 +127,14 @@ def set_cookie(response):
 app.register_blueprint(pizza.bp, url_prefix='/pizza')
 
 
+#declare a root route
 @app.route('/')
+#check if the user is authenticated/logined before handling the request
 @requires_auth()
 def index():
+    #load all ags the User is in
     ags = db.session.query(AG).join(UserAG).filter(UserAG.user_id == g.session.user_id)
+    #declare the marshmallow schema for ags
     ags_schema = AGSchema(many=True)
+    #send the template top the user
     return render_template('index.html', title='Dashboard', ags=ags_schema.dump(ags))

app/blueprints/ag.py

@@ -1,10 +1,12 @@
-from flask import Blueprint, g, redirect, render_template, url_for, flash
-from sqlalchemy.sql import exists
-from werkzeug.exceptions import NotFound, Unauthorized
-from app.models.associations import UserAG, UserAGMessage
-from app.models.ag import AG, AGSchema, AGSchemaIntern, AGMessage, AGMessageSchema
+'''
+All Blueprint routes regarding rendering ag templates
+'''
+
+from flask import Blueprint, render_template
+from app.models.ag import AG, AGSchema, AGSchemaIntern, AGMessageSchema
 from app.models import db
-from app.utils import requires_auth, requires_mentor, requires_membership, requires_ag_message_rights
+from app.utils import requires_auth
+from app.utils.assocations import requires_mentor, requires_membership, requires_ag_message_rights
 
 from config.regex import AGRegex, MessageRegex
 
@@ -28,15 +30,16 @@ def create_ag():
 def ag_dashboard(ag_name, ag, user_ag):
     schema = AGSchemaIntern()
     schema.context = {'ag_id': ag.id}
-    return render_template('ag/dashboard.html', my_role=user_ag.role, ag=schema.dump(ag),
+    return render_template('ag/dashboard.html', my_role=user_ag.role, ag=schema.dump(ag),\
                             title=ag.display_name)
 
 
 @bp.route('/<ag_name>/invite', methods=['GET'])
 @requires_auth()
 @requires_mentor()
 def invite_ag(ag_name, ag, user_ag):
-    return render_template('ag/invite.html', ag=ag_schema_intern.dump(ag), title=f'Invite {ag.display_name}')
+    return render_template('ag/invite.html', ag=ag_schema_intern.dump(ag),\
+                            title=f'Invite {ag.display_name}')
 
 
 # Events
@@ -45,7 +48,8 @@ def invite_ag(ag_name, ag, user_ag):
 @requires_auth()
 @requires_mentor()
 def create_event(ag_name, ag, user_ag):
-    return render_template('ag/event/add.html', ag=ag_schema_intern.dump(ag), title=f'New Event {ag.display_name}')
+    return render_template('ag/event/add.html', ag=ag_schema_intern.dump(ag),\
+                            title=f'New Event {ag.display_name}')
 
 @bp.route('/<ag_name>/settings', methods=['GET'])
 @requires_auth()
@@ -71,7 +75,8 @@ def edit_event():
 @requires_auth()
 @requires_mentor()
 def write_message(ag_name, ag, user_ag):
-    return render_template('ag/write_message.html', title=f'Write Message for {ag.display_name}', message_regex=MessageRegex, ag_name=ag_name)
+    return render_template('ag/write_message.html', title=f'Write Message for {ag.display_name}',\
+                            message_regex=MessageRegex, ag_name=ag_name)
 
 @bp.route('<ag_name>/messages/view/<message_id>')
 @requires_auth()
@@ -81,4 +86,5 @@ def view_message(ag_name, message_id, ag, user_ag, ag_message, user_ag_message):
     user_ag_message.read = True
     db.session.add(user_ag_message)
     db.session.commit()
-    return render_template('ag/view_message.html', title='View Message', message=message_schema.dump(ag_message), my_role=user_ag.role)
+    return render_template('ag/view_message.html', title='View Message',\
+                            message=message_schema.dump(ag_message), my_role=user_ag.role)

app/blueprints/api/v1/__init__.py

@@ -1,3 +1,7 @@
+'''
+basic blueprint route for the api v1
+'''
+
 from flask import Blueprint, request, jsonify, render_template
 from app.models.user import User, UserSchema