Overwrite Flask app with final state of tutorials series part 3

Author: acsany

build-a-rest-api-frontend/source_code_final/app.py

@@ -1,11 +1,10 @@
 from flask import render_template
+
 import config
 from models import Person
 
-import sys
-
 app = config.connex_app
-app.add_api("swagger.yml")
+app.add_api(config.basedir / "swagger.yml")
 
 
 @app.route("/")
@@ -14,15 +13,5 @@ def home():
     return render_template("home.html", people=people)
 
 
-@app.route("/<person_name>")
-def person(person_name):
-    print(person_name, file=sys.stderr)
-    person_object = Person.query.order_by(
-        Person.fname.ilike("person_name")
-    ).first()
-    print(person_object.fname, file=sys.stderr)
-    return render_template("person.html", person=person_object)
-
-
 if __name__ == "__main__":
     app.run(host="0.0.0.0", port=8000, debug=True)

build-a-rest-api-frontend/source_code_final/config.py

@@ -1,15 +1,14 @@
-import os
+import pathlib
+
 import connexion
-from flask_sqlalchemy import SQLAlchemy
 from flask_marshmallow import Marshmallow
+from flask_sqlalchemy import SQLAlchemy
 
-basedir = os.path.abspath(os.path.dirname(__file__))
+basedir = pathlib.Path(__file__).parent.resolve()
 connex_app = connexion.App(__name__, specification_dir=basedir)
 
 app = connex_app.app
-app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///" + os.path.join(
-    basedir, "people.db"
-)
+app.config["SQLALCHEMY_DATABASE_URI"] = f"sqlite:///{basedir / 'people.db'}"
 app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
 
 db = SQLAlchemy(app)

build-a-rest-api-frontend/source_code_final/models.py

@@ -1,5 +1,7 @@
 from datetime import datetime
+
 from marshmallow_sqlalchemy import fields
+
 from config import db, ma
 
 
@@ -29,8 +31,9 @@ class Person(db.Model):
     timestamp = db.Column(
         db.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow
     )
+
     notes = db.relationship(
-        "Note",
+        Note,
         backref="person",
         cascade="all, delete, delete-orphan",
         single_parent=True,
@@ -46,3 +49,8 @@ class Meta:
         include_relationships = True
 
     notes = fields.Nested(NoteSchema, many=True)
+
+
+note_schema = NoteSchema()
+person_schema = PersonSchema()
+people_schema = PersonSchema(many=True)

build-a-rest-api-frontend/source_code_final/notes.py

@@ -1,18 +1,13 @@
-from flask import make_response, abort
+from flask import abort, make_response
 
 from config import db
-from models import (
-    Note,
-    NoteSchema,
-    Person,
-)
+from models import Note, Person, note_schema
 
 
 def read_one(note_id):
     note = Note.query.get(note_id)
 
     if note is not None:
-        note_schema = NoteSchema()
         return note_schema.dump(note)
     else:
         abort(404, f"Note with ID {note_id} not found")
@@ -22,12 +17,11 @@ def update(note_id, note):
     existing_note = Note.query.get(note_id)
 
     if existing_note:
-        schema = NoteSchema()
-        update_note = schema.load(note, session=db.session)
+        update_note = note_schema.load(note, session=db.session)
         existing_note.content = update_note.content
         db.session.merge(existing_note)
         db.session.commit()
-        return schema.dump(existing_note), 201
+        return note_schema.dump(existing_note), 201
     else:
         abort(404, f"Note with ID {note_id} not found")
 
@@ -38,7 +32,7 @@ def delete(note_id):
     if existing_note:
         db.session.delete(existing_note)
         db.session.commit()
-        return make_response(f"{note_id} successfully deleted", 200)
+        return make_response(f"{note_id} successfully deleted", 204)
     else:
         abort(404, f"Note with ID {note_id} not found")
 
@@ -48,10 +42,9 @@ def create(note):
     person = Person.query.get(person_id)
 
     if person:
-        schema = NoteSchema()
-        new_note = schema.load(note, session=db.session)
+        new_note = note_schema.load(note, session=db.session)
         person.notes.append(new_note)
         db.session.commit()
-        return schema.dump(new_note), 201
+        return note_schema.dump(new_note), 201
     else:
         abort(404, f"Person not found for ID: {person_id}")

build-a-rest-api-frontend/source_code_final/people.py

@@ -1,56 +1,55 @@
-from flask import make_response, abort
+from flask import abort, make_response
 
 from config import db
-from models import (
-    Person,
-    PersonSchema,
-)
+from models import Person, people_schema, person_schema
 
 
 def read_all():
     people = Person.query.all()
-    person_schema = PersonSchema(many=True)
-    return person_schema.dump(people)
+    return people_schema.dump(people)
 
 
 def create(person):
-    schema = PersonSchema()
-    new_person = schema.load(person, session=db.session)
-    db.session.add(new_person)
-    db.session.commit()
-    return schema.dump(new_person), 201
+    lname = person.get("lname")
+    existing_person = Person.query.filter(Person.lname == lname).one_or_none()
+
+    if existing_person is None:
+        new_person = person_schema.load(person, session=db.session)
+        db.session.add(new_person)
+        db.session.commit()
+        return person_schema.dump(new_person), 201
+    else:
+        abort(406, f"Person with last name {lname} already exists")
 
 
-def read_one(person_id):
-    person = Person.query.get(person_id)
+def read_one(lname):
+    person = Person.query.filter(Person.lname == lname).one_or_none()
 
     if person is not None:
-        person_schema = PersonSchema()
         return person_schema.dump(person)
     else:
-        abort(404, f"Person with ID {person_id} not found")
+        abort(404, f"Person with last name {lname} not found")
 
 
-def update(person_id, person):
-    existing_person = Person.query.get(person_id)
+def update(lname, person):
+    existing_person = Person.query.filter(Person.lname == lname).one_or_none()
 
     if existing_person:
-        schema = PersonSchema()
-        update_person = schema.load(person, session=db.session)
+        update_person = person_schema.load(person, session=db.session)
         existing_person.fname = update_person.fname
         db.session.merge(existing_person)
         db.session.commit()
-        return schema.dump(existing_person), 201
+        return person_schema.dump(existing_person), 201
     else:
-        abort(404, f"Person with ID {person_id} not found")
+        abort(404, f"Person with last name {lname} not found")
 
 
-def delete(person_id):
-    existing_person = Person.query.get(person_id)
+def delete(lname):
+    existing_person = Person.query.filter(Person.lname == lname).one_or_none()
 
     if existing_person:
         db.session.delete(existing_person)
         db.session.commit()
-        return make_response(f"{person_id} successfully deleted", 200)
+        return make_response(f"{lname} successfully deleted", 200)
     else:
-        abort(404, f"Person with ID {person_id} not found")
+        abort(404, f"Person with last name {lname} not found")

build-a-rest-api-frontend/source_code_final/swagger.yml

@@ -13,17 +13,15 @@ components:
       type: "object"
       required:
         - lname
-        - fname
       properties:
         fname:
           type: "string"
         lname:
           type: "string"
-
   parameters:
-    person_id:
-      name: "person_id"
-      description: "ID of the person"
+    lname:
+      name: "lname"
+      description: "Last name of the person to get"
       in: path
       required: True
       schema:
@@ -32,9 +30,9 @@ components:
       name: "note_id"
       description: "ID of the note"
       in: path
-      required: True
+      required: true
       schema:
-        type: "string"
+        type: "integer"
 
 paths:
   /people:
@@ -62,15 +60,14 @@ paths:
       responses:
         "201":
           description: "Successfully created person"
-
-  /people/{person_id}:
+  /people/{lname}:
     get:
       operationId: "people.read_one"
       tags:
         - People
       summary: "Read one person"
       parameters:
-        - $ref: "#/components/parameters/person_id"
+        - $ref: "#/components/parameters/lname"
       responses:
         "200":
           description: "Successfully read person"
@@ -80,7 +77,7 @@ paths:
       operationId: "people.update"
       summary: "Update a person"
       parameters:
-        - $ref: "#/components/parameters/person_id"
+        - $ref: "#/components/parameters/lname"
       responses:
         "200":
           description: "Successfully updated person"
@@ -96,11 +93,10 @@ paths:
       operationId: "people.delete"
       summary: "Delete a person"
       parameters:
-        - $ref: "#/components/parameters/person_id"
+        - $ref: "#/components/parameters/lname"
       responses:
         "204":
           description: "Successfully deleted person"
-    
   /notes:
     post:
       operationId: "notes.create"
@@ -117,13 +113,12 @@ paths:
                 type: "object"
                 properties:
                   person_id:
-                    type: "string"
+                    type: "integer"
                   content:
                     type: "string"
       responses:
         "201":
           description: "Successfully created a note"
-
   /notes/{note_id}:
     get:
       operationId: "notes.read_one"