Updating the code to take care of some recursion problems in Marshmallow, and simplify the database calls (at the expense of getting to much data) to make the article more straightforward.

Author: writeson

flask-connexion-rest-part-3/build_database.py

@@ -1,4 +1,5 @@
 import os
+from datetime import datetime
 from config import db
 from models import Person, Note
 
@@ -8,25 +9,25 @@
         "fname": "Doug",
         "lname": "Farrell",
         "notes": [
-            "Cool, a mini-blogging application!",
-            "This could be useful",
-            "Well, sort of useful"
+            ("Cool, a mini-blogging application!", "2019-01-06 22:17:54"),
+            ("This could be useful", "2019-01-08 22:17:54"),
+            ("Well, sort of useful", "2019-03-06 22:17:54"),
         ]
     },
     {
         "fname": "Kent",
         "lname": "Brockman",
         "notes": [
-            "I'm going to make really profound observations",
-            "Maybe they'll be more obvious than I thought"
+            ("I'm going to make really profound observations", "2019-01-07 22:17:54"),
+            ("Maybe they'll be more obvious than I thought", "2019-02-06 22:17:54"),
         ]
     },
     {
         "fname": "Bunny",
         "lname": "Easter",
         "notes": [
-            "Has anyone seen my Easter eggs?",
-            "I'm really late delivering these!"
+            ("Has anyone seen my Easter eggs?", "2019-01-07 22:47:54"),
+            ("I'm really late delivering these!", "2019-04-06 22:17:54"),
         ]
     },
 ]
@@ -44,7 +45,8 @@
 
     # Add the notes for the person
     for note in person.get("notes"):
-        p.notes.append(Note(content=note))
+        content, timestamp = note
+        p.notes.append(Note(content=content, timestamp=datetime.strptime(timestamp, "%Y-%m-%d %H:%M:%S")))
     db.session.add(p)
 
 db.session.commit()

flask-connexion-rest-part-3/models.py

@@ -13,9 +13,10 @@ class Person(db.Model):
         db.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow
     )
     notes = db.relationship('Note',
-                            backref='person',
-                            cascade='all, delete-orphan',
-                            lazy='noload',
+                            backref=db.backref('person',
+                                               lazy='joined',
+                                               cascade='delete, delete-orphan',
+                                               single_parent=True),
                             order_by='desc(Note.timestamp)')
 
 
@@ -33,10 +34,31 @@ class PersonSchema(ma.ModelSchema):
     class Meta:
         model = Person
         sqla_session = db.session
-    notes = fields.Nested('NoteSchema', default=[], many=True)
+    notes = fields.Nested('PersonNotesSchema', default=[], many=True)
+
+
+class PersonNotesSchema(ma.ModelSchema):
+    """
+    This class exists to get around a recursion issue
+    """
+    note_id = fields.Int()
+    person_id = fields.Int()
+    content = fields.Str()
+    timestamp = fields.Str()
 
 
 class NoteSchema(ma.ModelSchema):
     class Meta:
         model = Note
         sqla_session = db.session
+    person = fields.Nested('NotesPersonSchema', default=None)
+
+
+class NotesPersonSchema(ma.ModelSchema):
+    """
+    This class exists to get around a recursion issue
+    """
+    person_id = fields.Int()
+    lname = fields.Str()
+    fname = fields.Str()
+    timestamp = fields.Str()

flask-connexion-rest-part-3/notes.py

@@ -8,6 +8,22 @@
 from models import Person, Note, NoteSchema
 
 
+def read_all():
+    """
+    This function responds to a request for /api/people/notes
+    with the complete list of notes, sorted by note timestamp
+
+    :return:                json list of all notes for all people
+    """
+    # Query the database for all the notes
+    notes = Note.query.order_by(db.desc(Note.timestamp)).all()
+
+    # Serialize the list of notes from our data
+    note_schema = NoteSchema(many=True, exclude=['person.notes'])
+    data = note_schema.dump(notes).data
+    return data
+
+
 def read_one(person_id, note_id):
     """
     This function responds to a request for /api/people/{person_id}/notes/{note_id}

flask-connexion-rest-part-3/people.py

@@ -6,7 +6,6 @@
 from flask import make_response, abort
 from config import db
 from models import Person, PersonSchema, Note
-from sqlalchemy import desc
 
 
 def read_all():
@@ -25,7 +24,7 @@ def read_all():
     return data
 
 
-def read_one(person_id, get_notes=None):
+def read_one(person_id):
     """
     This function responds to a request for /api/people/{person_id}
     with one matching person from people
@@ -34,16 +33,11 @@ def read_one(person_id, get_notes=None):
     :return:            person matching id
     """
     # Build the initial query
-    query = Person.query.filter(Person.person_id == person_id)
-
-    # Modify the query if we're getting the notes as well
-    if get_notes:
-        query = query \
-            .join(Note) \
-            .options(db.joinedload(Person.notes))
-
-    # Execute the query
-    person = query.one_or_none()
+    person = Person.query \
+        .filter(Person.person_id == person_id) \
+        .join(Note) \
+        .options(db.joinedload(Person.notes)) \
+        .one_or_none()
 
     # Did we find a person?
     if person is not None:

flask-connexion-rest-part-3/requirements.txt

@@ -0,0 +1,24 @@
+certifi==2018.11.29
+chardet==3.0.4
+Click==7.0
+clickclick==1.2.2
+connexion==2.2.0
+Flask==1.0.2
+flask-marshmallow==0.9.0
+Flask-SQLAlchemy==2.3.2
+idna==2.8
+inflection==0.3.1
+itsdangerous==1.1.0
+Jinja2==2.10
+jsonschema==2.6.0
+MarkupSafe==1.1.0
+marshmallow==2.17.0
+marshmallow-sqlalchemy==0.15.0
+openapi-spec-validator==0.2.4
+PyYAML==3.13
+requests==2.21.0
+six==1.12.0
+SQLAlchemy==1.2.16
+swagger-ui-bundle==0.0.2
+urllib3==1.24.1
+Werkzeug==0.14.1

flask-connexion-rest-part-3/server.py

@@ -28,6 +28,18 @@ def home():
     return render_template("home.html")
 
 
+# Create a URL route in our application for "/people"
+@connex_app.route("/people")
+def people():
+    """
+    This function just responds to the browser URL
+    localhost:5000/people
+
+    :return:        the rendered template "people.html"
+    """
+    return render_template("people.html")
+
+
 # Create a URL route to the notes page
 @connex_app.route("/notes/<int:person_id>")
 def notes(person_id):

flask-connexion-rest-part-3/static/css/home.css

@@ -1,90 +0,0 @@
-/*
- * This is the CSS stylesheet for the demo people application
- */
-
-@import url(http://fonts.googleapis.com/css?family=Roboto:400,300,500,700);
-
-body, .ui-btn {
-    font-family: Roboto;
-}
-
-.container {
-    padding: 10px;
-}
-
-.banner {
-    text-align: center;
-}
-
-.editor {
-    width: 50%;
-    margin-left: auto;
-    margin-right: auto;
-    padding: 5px;
-    border: 1px solid lightgrey;
-    border-radius: 3px;
-    margin-bottom: 5px;
-}
-
-label {
-    display: inline-block;
-    margin-bottom: 5px;
-}
-
-button {
-    padding: 5px;
-    margin-right: 5px;
-    border-radius: 3px;
-    background-color: #eee;
-}
-
-.people {
-    width: 50%;
-    margin-left: auto;
-    margin-right: auto;
-    margin-bottom: 5px;
-}
-
-table {
-    width: 100%;
-    border-collapse: collapse;
-}
-
-table, caption, th, td {
-    border: 1px solid lightgrey;
-}
-
-table caption {
-    height: 33px;
-    font-weight: bold;
-    padding-top: 5px;
-    border-bottom: none;
-}
-
-tr {
-    cursor: pointer;
-    height: 33px;
-}
-
-tr:nth-child(even) {
-    background-color: #f0f0f0
-}
-
-td {
-    text-align: center;
-}
-
-tbody tr:hover {
-    background-color: cornsilk;
-}
-
-.error {
-    width: 50%;
-    margin-left: auto;
-    margin-right: auto;
-    padding: 5px;
-    border: 1px solid lightgrey;
-    border-radius: 3px;
-    background-color: #fbb;
-    visibility: hidden;
-}

flask-connexion-rest-part-3/static/css/notes.css

@@ -2,24 +2,6 @@
  * This is the CSS stylesheet for the notes creation/update/delete application
  */
 
-@import url(http://fonts.googleapis.com/css?family=Roboto:400,300,500,700);
-
-body, .ui-btn {
-    font-family: Roboto;
-}
-
-.navigation {
-    border: 2px solid grey;
-    background-color: lightgrey;
-    width: 95%;
-    margin-top: 0px;
-    margin-left: auto;
-    margin-right: auto;
-    margin-bottom: 0px;
-    padding: 10px;
-    text-align: left;
-}
-
 .container {
     padding: 10px;
 }

flask-connexion-rest-part-3/static/css/parent.css

@@ -0,0 +1,43 @@
+/*
+ * This is the parent CSS stylesheet that all pages get basic styling from
+ */
+
+@import url(http://fonts.googleapis.com/css?family=Roboto:400,300,500,700);
+
+body, .ui-btn {
+    font-family: Roboto;
+}
+
+.navigation {
+    display: flex;
+    flex-direction: row;
+    padding: 15px 10px 15px 10px;
+    border-bottom: 2px solid darkgrey;
+    background-color: whitesmoke;
+}
+
+.navigation a {
+    margin-right: 10px;
+    padding: 5px;
+    border: 1px solid darkgrey;
+    border-radius: 4px;
+    text-decoration: none;
+    cursor: pointer;
+    text: black;
+    background-color: lightskyblue;
+}
+
+.navigation .page_name {
+    flex-grow: 2;
+    text-align: center;
+    font-size: 1.5em;
+    font-weight: bold;
+}
+
+.navigation a:hover {
+    background-color: deepskyblue;
+}
+
+.container {
+    padding: 10px;
+}