-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Spruce: Asya and Gabe #23
base: main
Are you sure you want to change the base?
Changes from all commits
aa0759e
9e5c8f1
e9ea65a
8878993
bea0aa1
b45e5df
79351b7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,32 @@ | ||
from flask import Flask | ||
from flask_sqlalchemy import SQLAlchemy | ||
from flask_migrate import Migrate, migrate | ||
from dotenv import load_dotenv | ||
import os | ||
|
||
db = SQLAlchemy() | ||
migrate = Migrate() | ||
load_dotenv() | ||
|
||
def create_app(test_config=None): | ||
def create_app(test_config = None): | ||
app = Flask(__name__) | ||
|
||
if not test_config: | ||
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False | ||
app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( | ||
"SQLALCHEMY_DATABASE_URI") | ||
else: | ||
app.config["TESTING"] = True | ||
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False | ||
app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( | ||
"SQLALCHEMY_TEST_DATABASE_URI") | ||
|
||
db.init_app(app) | ||
migrate.init_app(app, db) | ||
|
||
from app.models.planet import Planet | ||
|
||
from .routes import planets_bp | ||
app.register_blueprint(planets_bp) | ||
|
||
return app |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
from app import db | ||
|
||
class Planet(db.Model): | ||
id = db.Column(db.Integer, primary_key=True, autoincrement=True) | ||
name = db.Column(db.String) | ||
description = db.Column(db.String) | ||
circum = db.Column(db.Integer) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Keep in mind that the name we use here is what will literally be used for the db column name. So I'd suggest using the full circumference here.
Comment on lines
+5
to
+7
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider which columns we might want to make "required" (non-nullable). As it is, with this definition, we could make a Planet with a NULL name, description, and circumference. Would we want to allow this to happen? |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,63 @@ | ||
from flask import Blueprint | ||
from app import db | ||
from app.models.planet import Planet | ||
from flask import Blueprint, jsonify, request, make_response | ||
|
||
planets_bp = Blueprint('planets', __name__, url_prefix="/planets") | ||
|
||
@planets_bp.route("", methods=["POST", "GET"]) | ||
def handle_all_planets(): | ||
Comment on lines
+7
to
+8
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider making separate functions for the get and post (the GET method is often called |
||
if request.method == "POST": | ||
request_body = request.get_json() | ||
new_planet = Planet(name=request_body["name"], description = request_body["description"], circum = request_body["circum"]) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When there's a long-ish list of params, consider wrapping the lines to help keep things in a readable chunk. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Be sure to include error handling to check whether the keys we are going to try to access are present. For instance, if we access the "name" key, and it's not in the request body, this will cause a |
||
|
||
db.session.add(new_planet) | ||
db.session.commit() | ||
return make_response(f"Planet {new_planet.name} create", 201) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider returning information about the planet created (its dictionary structure) rather than just a message here. The caller would probably like to at least know the id of the created record. Returning a dictionary with the id and message as two separate parts can make it easy to get the id programmatically, as well as a potentially human friendly message. Also, even for plain messages, be sure to jsonify them so that the type of the response body is set properly. |
||
|
||
elif request.method == "GET": | ||
|
||
planets = Planet.query.all() | ||
planets_response = [] | ||
for planet in planets: | ||
planets_response.append({"id": planet.id, "name": planet.name, "description": planet.description, "circumference in mkm": planet.circum}) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We strongly suggest making a helper method on the Planet class to take care of converting the model instance to a dictionary for the purpose of being returned. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For the keys in our json dictionaries, prefer a name that can be a valid variable name (generally, prefer _ to spaces). While it doesn't impact our python handling that much, it can make the JSON handling for other languages (esp. JavaScript) if the keys can be treated as variables. |
||
return jsonify(planets_response) | ||
|
||
@planets_bp.route("/<planet_name>", methods=["GET", "PUT", "DELETE"]) | ||
def handle_one_planet(planet_name): | ||
Comment on lines
+25
to
+26
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As with the previous endpoint, here too consider splitting the various verbs into separate functions. |
||
planet = Planet.query.get(planet_name) | ||
|
||
if planet is None: | ||
return make_response(f"Error: Planet {planet_name} not found", 404) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Be sure to jsonify any of the responses throughout. |
||
|
||
if request.method == "GET": | ||
return {"id": planet.id, "name": planet.name, "description": planet.description, "circumference": planet.circum} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider moving the code to transform a Planet into a dictionary to a helper function in the Planet class. |
||
|
||
elif request.method == "PUT": | ||
request_body = request.get_json() | ||
|
||
if request_body is None: | ||
return make_response(f"Error: Request requires name, description, and circumference", 400) | ||
|
||
elif "name" not in request_body or "description" not in request_body or "circum" not in request_body: | ||
return make_response(f"Error: Request requires name, description, and circumference", 400) | ||
Comment on lines
+38
to
+42
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Great! These are essentially the same as the checks we'd like to have for the POST method. |
||
|
||
planet.name = request_body['name'] | ||
planet.description = request_body["description"] | ||
planet.circum = request_body["circum"] | ||
|
||
db.session.commit() | ||
|
||
return { | ||
"id": planet.id, | ||
"name": planet.name, | ||
"description": planet.description, | ||
"circum": planet.circum | ||
}, 200 | ||
|
||
elif request.method == "DELETE": | ||
db.session.delete(planet) | ||
db.session.commit() | ||
return f"{planet.name} was successfully deleted", 200 | ||
|
||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Generic single-database configuration. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# A generic, single database configuration. | ||
|
||
[alembic] | ||
# template used to generate migration files | ||
# file_template = %%(rev)s_%%(slug)s | ||
|
||
# set to 'true' to run the environment during | ||
# the 'revision' command, regardless of autogenerate | ||
# revision_environment = false | ||
|
||
|
||
# Logging configuration | ||
[loggers] | ||
keys = root,sqlalchemy,alembic | ||
|
||
[handlers] | ||
keys = console | ||
|
||
[formatters] | ||
keys = generic | ||
|
||
[logger_root] | ||
level = WARN | ||
handlers = console | ||
qualname = | ||
|
||
[logger_sqlalchemy] | ||
level = WARN | ||
handlers = | ||
qualname = sqlalchemy.engine | ||
|
||
[logger_alembic] | ||
level = INFO | ||
handlers = | ||
qualname = alembic | ||
|
||
[handler_console] | ||
class = StreamHandler | ||
args = (sys.stderr,) | ||
level = NOTSET | ||
formatter = generic | ||
|
||
[formatter_generic] | ||
format = %(levelname)-5.5s [%(name)s] %(message)s | ||
datefmt = %H:%M:%S |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
from __future__ import with_statement | ||
|
||
import logging | ||
from logging.config import fileConfig | ||
|
||
from sqlalchemy import engine_from_config | ||
from sqlalchemy import pool | ||
from flask import current_app | ||
|
||
from alembic import context | ||
|
||
# this is the Alembic Config object, which provides | ||
# access to the values within the .ini file in use. | ||
config = context.config | ||
|
||
# Interpret the config file for Python logging. | ||
# This line sets up loggers basically. | ||
fileConfig(config.config_file_name) | ||
logger = logging.getLogger('alembic.env') | ||
|
||
# add your model's MetaData object here | ||
# for 'autogenerate' support | ||
# from myapp import mymodel | ||
# target_metadata = mymodel.Base.metadata | ||
config.set_main_option( | ||
'sqlalchemy.url', | ||
str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) | ||
target_metadata = current_app.extensions['migrate'].db.metadata | ||
|
||
# other values from the config, defined by the needs of env.py, | ||
# can be acquired: | ||
# my_important_option = config.get_main_option("my_important_option") | ||
# ... etc. | ||
|
||
|
||
def run_migrations_offline(): | ||
"""Run migrations in 'offline' mode. | ||
|
||
This configures the context with just a URL | ||
and not an Engine, though an Engine is acceptable | ||
here as well. By skipping the Engine creation | ||
we don't even need a DBAPI to be available. | ||
|
||
Calls to context.execute() here emit the given string to the | ||
script output. | ||
|
||
""" | ||
url = config.get_main_option("sqlalchemy.url") | ||
context.configure( | ||
url=url, target_metadata=target_metadata, literal_binds=True | ||
) | ||
|
||
with context.begin_transaction(): | ||
context.run_migrations() | ||
|
||
|
||
def run_migrations_online(): | ||
"""Run migrations in 'online' mode. | ||
|
||
In this scenario we need to create an Engine | ||
and associate a connection with the context. | ||
|
||
""" | ||
|
||
# this callback is used to prevent an auto-migration from being generated | ||
# when there are no changes to the schema | ||
# reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html | ||
def process_revision_directives(context, revision, directives): | ||
if getattr(config.cmd_opts, 'autogenerate', False): | ||
script = directives[0] | ||
if script.upgrade_ops.is_empty(): | ||
directives[:] = [] | ||
logger.info('No changes in schema detected.') | ||
|
||
connectable = engine_from_config( | ||
config.get_section(config.config_ini_section), | ||
prefix='sqlalchemy.', | ||
poolclass=pool.NullPool, | ||
) | ||
|
||
with connectable.connect() as connection: | ||
context.configure( | ||
connection=connection, | ||
target_metadata=target_metadata, | ||
process_revision_directives=process_revision_directives, | ||
**current_app.extensions['migrate'].configure_args | ||
) | ||
|
||
with context.begin_transaction(): | ||
context.run_migrations() | ||
|
||
|
||
if context.is_offline_mode(): | ||
run_migrations_offline() | ||
else: | ||
run_migrations_online() |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
"""${message} | ||
|
||
Revision ID: ${up_revision} | ||
Revises: ${down_revision | comma,n} | ||
Create Date: ${create_date} | ||
|
||
""" | ||
from alembic import op | ||
import sqlalchemy as sa | ||
${imports if imports else ""} | ||
|
||
# revision identifiers, used by Alembic. | ||
revision = ${repr(up_revision)} | ||
down_revision = ${repr(down_revision)} | ||
branch_labels = ${repr(branch_labels)} | ||
depends_on = ${repr(depends_on)} | ||
|
||
|
||
def upgrade(): | ||
${upgrades if upgrades else "pass"} | ||
|
||
|
||
def downgrade(): | ||
${downgrades if downgrades else "pass"} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
"""adds Planet model | ||
|
||
Revision ID: fd6ab4fe0f5b | ||
Revises: | ||
Create Date: 2021-10-22 11:00:00.758779 | ||
|
||
""" | ||
from alembic import op | ||
import sqlalchemy as sa | ||
|
||
|
||
# revision identifiers, used by Alembic. | ||
revision = 'fd6ab4fe0f5b' | ||
down_revision = None | ||
branch_labels = None | ||
depends_on = None | ||
|
||
|
||
def upgrade(): | ||
# ### commands auto generated by Alembic - please adjust! ### | ||
op.create_table('planet', | ||
sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), | ||
sa.Column('name', sa.String(), nullable=True), | ||
sa.Column('description', sa.String(), nullable=True), | ||
sa.Column('circum', sa.Integer(), nullable=True), | ||
Comment on lines
+23
to
+25
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Notice that since your model definitions didn't say that these fields were required, the migration marks them as being OK to be null. |
||
sa.PrimaryKeyConstraint('id') | ||
) | ||
# ### end Alembic commands ### | ||
|
||
|
||
def downgrade(): | ||
# ### commands auto generated by Alembic - please adjust! ### | ||
op.drop_table('planet') | ||
# ### end Alembic commands ### |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,28 @@ | ||
alembic==1.5.4 | ||
autopep8==1.5.5 | ||
certifi==2020.12.5 | ||
chardet==4.0.0 | ||
click==7.1.2 | ||
Flask==1.1.2 | ||
Flask-Migrate==2.6.0 | ||
Flask-SQLAlchemy==2.4.4 | ||
idna==2.10 | ||
itsdangerous==1.1.0 | ||
Jinja2==2.11.3 | ||
Mako==1.1.4 | ||
MarkupSafe==1.1.1 | ||
psycopg2-binary==2.8.6 | ||
pycodestyle==2.6.0 | ||
python-dateutil==2.8.1 | ||
python-dotenv==0.15.0 | ||
python-editor==1.0.4 | ||
requests==2.25.1 | ||
six==1.15.0 | ||
SQLAlchemy==1.3.23 | ||
alembic==1.7.4 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What prompted you to regenerate your requirements? There's nothing wrong with doing this (and in fact it gets you more up-to-date libraries), but it shouldn't have been strictly necessary. |
||
attrs==20.3.0 | ||
certifi==2021.10.8 | ||
charset-normalizer==2.0.6 | ||
click==8.0.3 | ||
Flask==2.0.2 | ||
Flask-Migrate==3.1.0 | ||
Flask-SQLAlchemy==2.5.1 | ||
greenlet==1.1.2 | ||
idna==3.2 | ||
iniconfig==1.1.1 | ||
itsdangerous==2.0.1 | ||
Jinja2==3.0.2 | ||
Mako==1.1.5 | ||
MarkupSafe==2.0.1 | ||
packaging==20.8 | ||
pluggy==0.13.1 | ||
psycopg2-binary==2.9.1 | ||
py==1.10.0 | ||
pyparsing==2.4.7 | ||
pytest==6.2.1 | ||
python-dotenv==0.19.1 | ||
requests==2.26.0 | ||
SQLAlchemy==1.4.26 | ||
toml==0.10.2 | ||
urllib3==1.26.4 | ||
Werkzeug==1.0.1 | ||
urllib3==1.26.7 | ||
Werkzeug==2.0.2 | ||
wonderwords==2.2.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once we import blueprints (which in turn import the models), we don't need the model import here any more.