refactoring/cleaning

daniel-sanche · daniel-sanche · commit 44d7b7a53695 · 2019-04-01T01:37:27.000-07:00
diff --git a/python/python-guestbook/pylintrc b/python/python-guestbook/pylintrc
@@ -135,7 +135,7 @@ disable=print-statement,
         exception-escape,
         comprehension-escape,
         invalid-name,
-        redefined-builtin
+        superfluous-parens
         
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
diff --git a/python/python-guestbook/src/backend/back.py b/python/python-guestbook/src/backend/back.py
@@ -2,11 +2,10 @@
 A sample backend server. Saves and retrieves entries using mongodb
 """
 import os
+import time
 from flask import Flask, jsonify, request
 from flask_pymongo import PyMongo
-from functools import reduce
 import bleach
-import time
 
 app = Flask(__name__)
 app.config["MONGO_URI"] = 'mongodb://{}/guestbook'.format(os.environ.get('GUESTBOOK_DB_ADDR'))
@@ -15,7 +14,8 @@
 @app.route('/messages', methods=['GET'])
 def get_messages():
     """ retrieve and return the list of messages on GET request """
-    msg_list = list(mongo.db.messages.find({}, {'author':1, 'message':1, 'date':1, '_id':0}).sort("_id", -1))
+    field_mask = {'author':1, 'message':1, 'date':1, '_id':0}
+    msg_list = list(mongo.db.messages.find({}, field_mask).sort("_id", -1))
     return jsonify(msg_list), 201
 
 @app.route('/messages', methods=['POST'])
@@ -33,4 +33,7 @@ def add_message():
         if os.environ.get(v) is None:
             print("error: {} environment variable not set".format(v))
             exit(1)
+
+    # start Flask server
+    # Flask's debug mode is unrelated to ptvsd debugger used by Cloud Code
     app.run(debug=False, port=os.environ.get('PORT'), host='0.0.0.0')
diff --git a/python/python-guestbook/src/frontend/front.py b/python/python-guestbook/src/frontend/front.py
@@ -3,12 +3,11 @@
 """
 import json
 import os
+import datetime
+import time
 from flask import Flask, render_template, redirect, url_for, request, jsonify
 import requests
-import bleach
-import datetime
 import dateutil.relativedelta
-import time
 
 app = Flask(__name__)
 app.config["BACKEND_URI"] = 'http://{}/messages'.format(os.environ.get('GUESTBOOK_API_ADDR'))
@@ -31,12 +30,14 @@ def post():
                   timeout=3)
     return redirect(url_for('main'))
 
-def format_duration(prev_timestamp):
+def format_duration(timestamp):
+    """ Format the time since the input timestamp in a human readable way """
     now = datetime.datetime.fromtimestamp(time.time())
-    prev = datetime.datetime.fromtimestamp(prev_timestamp)
+    prev = datetime.datetime.fromtimestamp(timestamp)
     rd = dateutil.relativedelta.relativedelta(now, prev)
 
-    for n, unit in [(rd.years, "year"), (rd.days, "day"), (rd.hours, "hour"), (rd.minutes, "minute")]:
+    for n, unit in [(rd.years, "year"), (rd.days, "day"), (rd.hours, "hour"),
+                    (rd.minutes, "minute")]:
         if n == 1:
             return "{} {} ago".format(n, unit)
         elif n > 1:
@@ -50,5 +51,9 @@ def format_duration(prev_timestamp):
             print("error: {} environment variable not set".format(v))
             exit(1)
 
+    # register format_duration for use in html template
     app.jinja_env.globals.update(format_duration=format_duration)
+
+    # start Flask server
+    # Flask's debug mode is unrelated to ptvsd debugger used by Cloud Code
     app.run(debug=False, port=os.environ.get('PORT'), host='0.0.0.0')
diff --git a/python/python-guestbook/src/frontend/requirements.txt b/python/python-guestbook/src/frontend/requirements.txt
@@ -1,4 +1,3 @@
 Flask==1.0.2
 requests==2.21.0
-bleach==3.1.0
 python-dateutil==2.8.0
