Skip to content

Cheetahs - Ev #129

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,7 @@ def create_app(test_config=None):
migrate.init_app(app, db)

# Register Blueprints here

from .routes import tasks_bp
app.register_blueprint(tasks_bp)

return app
27 changes: 26 additions & 1 deletion app/models/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,29 @@


class Task(db.Model):

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!

task_id = db.Column(db.Integer, primary_key=True)
task_id = db.Column(db.Integer, primary_key=True, autoincrement=True)
title = db.Column(db.String)
description = db.Column(db.String)
completed_at = db.Column(db.DateTime)

def to_dict(self):
task_dict = {
"id": self.task_id,
"title": self.title,
"description": self.description,
}

if self.completed_at == None:
task_dict["is_complete"] = False
else:
task_dict["is_complete"] = True

return task_dict

@classmethod
def from_dict(cls, task_dict):
return cls(
title = task_dict["title"],
description = task_dict["description"]
)

102 changes: 101 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1 +1,101 @@
from flask import Blueprint
from flask import Blueprint, jsonify, make_response, request, abort
from app import db
from app.models.task import Task
from sqlalchemy import desc
import datetime

tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks")

@tasks_bp.route("", methods=["POST", "GET"])

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be a good idea to separate "POST" and "GET". Putting them together makes the function really long and harder to read since everything is indented an extra level because of the if statement to distinguish between POST and GET.

def handle_tasks():
if request.method == "POST":
request_body = request.get_json()

try:
task = Task(title = request_body['title'], description = request_body['description'])
except KeyError:
invalid_dict = {"details": "Invalid data"}
return make_response(jsonify(invalid_dict),400)

db.session.add(task)
db.session.commit()

response_body = {"task": task.to_dict()}

return make_response(jsonify(response_body), 201)
Comment on lines +12 to +25

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!


elif request.method == "GET":
sort_by_query = request.args.get('sort')

tasks = Task.query.all()

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be a good idea to have this as the else that comes at the end of the if statement that starts on line 33. The way it's done now, all of the tasks are pulled twice if there's a sort to do.

response_body = []

if sort_by_query == 'asc':
tasks = Task.query.order_by(Task.title)
elif sort_by_query == 'desc':
tasks = Task.query.order_by(desc(Task.title))

for task in tasks:
response_body.append(task.to_dict())

return make_response(jsonify(response_body), 200)

@tasks_bp.route("/<task_id>", methods=["GET", "PUT", "DELETE"])

def handle_task(task_id):
task = validate_model_id(Task, task_id)

if request.method == "GET":
return make_response(jsonify({"task": task.to_dict()}), 200)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent! So concise!


elif request.method == "PUT":
request_body = request.get_json()

task.title = request_body["title"]
task.description = request_body["description"]

db.session.commit()

return make_response(jsonify({"task": task.to_dict()}), 200)
Comment on lines +52 to +59

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!


elif request.method == "DELETE":

db.session.delete(task)
db.session.commit()

return make_response({"details": f'Task {task.task_id} ' f'"{task.title}"' ' successfully deleted'}, 200)
Comment on lines +63 to +66

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!


def validate_model_id(cls,task_id):

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay, helper function!

try:
task_id = int(task_id)
except ValueError:
return abort(make_response({"message":f"{cls.__name__} id {task_id} is invalid"},400))

chosen_object = cls.query.get(task_id)

if chosen_object is None:
return abort(make_response({"message":f"{cls.__name__} {task_id} not found"}, 404))

return chosen_object

@tasks_bp.route("/<task_id>/mark_complete", methods = ["PATCH"])
def mark_complete(task_id):
task = validate_model_id(Task, task_id)

task.completed_at = datetime.date.today()
task.is_complete = True

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Task model does not have a is_complete column. I'm not sure if this data is actually saved anywhere in the database.


db.session.commit()

return make_response(jsonify({"task": task.to_dict()}), 200)

@tasks_bp.route("/<task_id>/mark_incomplete", methods=["PATCH"])
def mark_incomplete(task_id):

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job!

task = validate_model_id(Task, task_id)

task.completed_at = None
task.is_complete = False

db.session.commit()

return make_response(jsonify({"task": task.to_dict()}), 200)
1 change: 1 addition & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration.
45 changes: 45 additions & 0 deletions migrations/alembic.ini
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
96 changes: 96 additions & 0 deletions migrations/env.py
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()
24 changes: 24 additions & 0 deletions migrations/script.py.mako
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"}
39 changes: 39 additions & 0 deletions migrations/versions/1f9c65321a1c_adds_task_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""adds Task model

Revision ID: 1f9c65321a1c
Revises:
Create Date: 2022-11-05 11:02:52.252878

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '1f9c65321a1c'
down_revision = None
branch_labels = None
depends_on = None


def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('goal',
sa.Column('goal_id', sa.Integer(), nullable=False),
sa.PrimaryKeyConstraint('goal_id')
)
op.create_table('task',
sa.Column('task_id', sa.Integer(), autoincrement=True, nullable=False),
sa.Column('title', sa.String(), nullable=True),
sa.Column('description', sa.String(), nullable=True),
sa.Column('completed_at', sa.DateTime(), nullable=True),
sa.PrimaryKeyConstraint('task_id')
)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('task')
op.drop_table('goal')
# ### end Alembic commands ###
Loading