add docstrings

Author: wescpy

step0-webapp2-gaendb-py2/main.py

@@ -25,10 +25,12 @@ def store_visit(remote_addr, user_agent):
     Visit(visitor='{}: {}'.format(remote_addr, user_agent)).put()
 
 def fetch_visits(limit):
+    'get most recent visits'
     return (v.to_dict() for v in Visit.query().order(
             -Visit.timestamp).fetch(limit))
 
 class MainHandler(webapp2.RequestHandler):
+    'main application (GET) handler'
     def get(self):
         store_visit(self.request.remote_addr, self.request.user_agent)
         visits = fetch_visits(10)

step1-flask-gaendb-py2/main.py

@@ -22,14 +22,17 @@ class Visit(ndb.Model):
     timestamp = ndb.DateTimeProperty(auto_now_add=True)
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     Visit(visitor='{}: {}'.format(remote_addr, user_agent)).put()
 
 def fetch_visits(limit):
+    'get most recent visits'
     return (v.to_dict() for v in Visit.query().order(
             -Visit.timestamp).fetch(limit))
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step2-flask-cloudndb-py2/main.py

@@ -23,16 +23,19 @@ class Visit(ndb.Model):
     timestamp = ndb.DateTimeProperty(auto_now_add=True)
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     with ds_client.context():
         Visit(visitor='{}: {}'.format(remote_addr, user_agent)).put()
 
 def fetch_visits(limit):
+    'get most recent visits'
     with ds_client.context():
         return (v.to_dict() for v in Visit.query().order(
                 -Visit.timestamp).fetch(limit))
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step2-flask-cloudndb-py3/main.py

@@ -23,16 +23,19 @@ class Visit(ndb.Model):
     timestamp = ndb.DateTimeProperty(auto_now_add=True)
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     with ds_client.context():
         Visit(visitor='{}: {}'.format(remote_addr, user_agent)).put()
 
 def fetch_visits(limit):
+    'get most recent visits'
     with ds_client.context():
         return (v.to_dict() for v in Visit.query().order(
                 -Visit.timestamp).fetch(limit))
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step3-flask-datastore-py2/main.py

@@ -20,6 +20,7 @@
 ds_client = datastore.Client()
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     entity = datastore.Entity(key=ds_client.key('Visit'))
     entity.update({
         'timestamp': datetime.now(),
@@ -28,12 +29,14 @@ def store_visit(remote_addr, user_agent):
     ds_client.put(entity)
 
 def fetch_visits(limit):
+    'get most recent visits'
     query = ds_client.query(kind='Visit')
     query.order = ['-timestamp']
     return query.fetch(limit=limit)
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step3-flask-datastore-py3/main.py

@@ -20,6 +20,7 @@
 ds_client = datastore.Client()
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     entity = datastore.Entity(key=ds_client.key('Visit'))
     entity.update({
         'timestamp': datetime.now(),
@@ -28,12 +29,14 @@ def store_visit(remote_addr, user_agent):
     ds_client.put(entity)
 
 def fetch_visits(limit):
+    'get most recent visits'
     query = ds_client.query(kind='Visit')
     query.order = ['-timestamp']
     return query.fetch(limit=limit)
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step3a-flask-firestore-py3/main.py

@@ -20,20 +20,23 @@
 fs_client = firestore.Client()
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Firestore'
     doc_ref = fs_client.collection('Visit')
     doc_ref.add({
         'timestamp': datetime.now(),
         'visitor': '{}: {}'.format(remote_addr, user_agent),
     })
 
 def fetch_visits(limit):
+    'get most recent visits'
     visits_ref = fs_client.collection('Visit')
     visits = (v.to_dict() for v in visits_ref.order_by('timestamp',
             direction=firestore.Query.DESCENDING).limit(limit).stream())
     return visits
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step4-cloudds-cloudrun-py3/main.py

@@ -20,6 +20,7 @@
 ds_client = datastore.Client()
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     entity = datastore.Entity(key=ds_client.key('Visit'))
     entity.update({
         'timestamp': datetime.now(),
@@ -28,12 +29,14 @@ def store_visit(remote_addr, user_agent):
     ds_client.put(entity)
 
 def fetch_visits(limit):
+    'get most recent visits'
     query = ds_client.query(kind='Visit')
     query.order = ['-timestamp']
     return query.fetch(limit=limit)
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step4-cloudndb-cloudrun-py2/main.py

@@ -23,16 +23,19 @@ class Visit(ndb.Model):
     timestamp = ndb.DateTimeProperty(auto_now_add=True)
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     with ds_client.context():
         Visit(visitor='{}: {}'.format(remote_addr, user_agent)).put()
 
 def fetch_visits(limit):
+    'get most recent visits'
     with ds_client.context():
         return (v.to_dict() for v in Visit.query().order(
                 -Visit.timestamp).fetch_page(limit)[0])
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)

step4a-cloudrun-bldpks-py3/main.py

@@ -20,6 +20,7 @@
 ds_client = datastore.Client()
 
 def store_visit(remote_addr, user_agent):
+    'create new Visit entity in Datastore'
     entity = datastore.Entity(key=ds_client.key('Visit'))
     entity.update({
         'timestamp': datetime.now(),
@@ -28,12 +29,14 @@ def store_visit(remote_addr, user_agent):
     ds_client.put(entity)
 
 def fetch_visits(limit):
+    'get most recent visits'
     query = ds_client.query(kind='Visit')
     query.order = ['-timestamp']
     return query.fetch(limit=limit)
 
 @app.route('/')
 def root():
+    'main application (GET) handler'
     store_visit(request.remote_addr, request.user_agent)
     visits = fetch_visits(10)
     return render_template('index.html', visits=visits)