Skip to content

Cheetahs - Alexis Miller #125

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 2 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
2 changes: 2 additions & 0 deletions 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
19 changes: 18 additions & 1 deletion app/models/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,21 @@


class Task(db.Model):
task_id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
title = db.Column(db.String(80))
description = db.Column(db.String(2600))
completed_at = db.Column(db.DateTime, nullable=True)

def to_dict(self):

Choose a reason for hiding this comment

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

👍

if self.completed_at:
complete = True
else:
complete = False

task_as_dict = {}
task_as_dict["id"] = self.id
task_as_dict["title"] = self.title
task_as_dict["description"] = self.description
task_as_dict["is_complete"] = complete

return task_as_dict
116 changes: 115 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1 +1,115 @@
from flask import Blueprint
from os import abort
from app import db
from app.models.task import Task
from flask import Blueprint, jsonify, make_response, request, abort
from datetime import date

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


#Validate
def validate_task(task_id):

Choose a reason for hiding this comment

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

Great helper!

try:
task_id = int(task_id)
except:
abort(make_response({"message" : f"Task ID '{task_id}' invalid"}, 400))

task = Task.query.get(task_id)

if not task:
abort(make_response({"message" : f"Task ID '{task_id}' not found"}, 404))

return task

#CREATE a task
@tasks_bp.route("", methods=['POST'])
def create_task():
request_body = request.get_json()

if "title" not in request_body or "description" not in request_body:
return jsonify({"details": "Invalid data"}), 400

Choose a reason for hiding this comment

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

👍


new_task = Task(title=request_body["title"],
description=request_body["description"])

db.session.add(new_task)
db.session.commit()

return jsonify({"task": new_task.to_dict()}), 201

#READ all tasks
@tasks_bp.route("", methods=['GET'])
def get_all_tasks():

sort_query = request.args.get("sort")

if sort_query == "asc":
tasks = Task.query.order_by(Task.title.asc())
elif sort_query == "desc":
tasks = Task.query.order_by(Task.title.desc())
else:
tasks = Task.query.all()

task_response = []
for task in tasks:
task_response.append(task.to_dict())

return jsonify(task_response)

Choose a reason for hiding this comment

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

Even though Flask will add the 200 for you, I recommend being explicit about the code everywhere, and not just in non 200 returns. Consistent formats make code easier to read.

Suggested change
return jsonify(task_response)
return jsonify(task_response), 200



#READ one task
@tasks_bp.route("/<task_id>", methods=['GET'])
def get_one_task(task_id):

task = validate_task(task_id)

return make_response({"task": task.to_dict()})

Choose a reason for hiding this comment

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

The function make_response isn't incorrect here, but I notice that some functions return jsonify and others return make_response. I recommend picking one format and using it throughout your code - having different formats that do the same thing can make it harder for someone reading your code to realize that the behavior is the same.


#UPDATE one task
@tasks_bp.route("/<task_id>", methods=['PUT'])
def update_task(task_id):
task = validate_task(task_id)
request_body = request.get_json()

if "title" not in request_body or "description" not in request_body:
return jsonify({"details": "Invalid data"}), 400

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

db.session.commit()

return make_response({"task": task.to_dict()})


#UPDATE mark task complete
@tasks_bp.route("/<task_id>/mark_complete", methods=["PATCH"])
def mark_complete(task_id):
task = validate_task(task_id)

task.completed_at = date.today()

Choose a reason for hiding this comment

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

💯


db.session.commit()

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

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

task.completed_at = None

db.session.commit()

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


#DELETE one task
@tasks_bp.route("/<task_id>", methods=['DELETE'])
def delete_task(task_id):
task = validate_task(task_id)

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

return jsonify({"details": f'Task {task_id} "{task.title}" successfully deleted'}), 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"}
30 changes: 30 additions & 0 deletions migrations/versions/6e5738d80435_.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""empty message

Revision ID: 6e5738d80435
Revises: 83475dc44270
Create Date: 2022-11-10 09:38:22.992482

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '6e5738d80435'
down_revision = '83475dc44270'
branch_labels = None
depends_on = None


def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.add_column('task', sa.Column('completed_at', sa.DateTime(), nullable=True))
op.drop_column('task', 'is_complete')
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.add_column('task', sa.Column('is_complete', sa.BOOLEAN(), autoincrement=False, nullable=True))
op.drop_column('task', 'completed_at')
# ### end Alembic commands ###
30 changes: 30 additions & 0 deletions migrations/versions/83475dc44270_.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""empty message

Revision ID: 83475dc44270
Revises: c43a1e0904c1
Create Date: 2022-11-10 02:23:04.287845

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '83475dc44270'
down_revision = 'c43a1e0904c1'
branch_labels = None
depends_on = None


def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.add_column('task', sa.Column('is_complete', sa.Boolean(), nullable=True))
op.drop_column('task', 'is_completed')
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.add_column('task', sa.Column('is_completed', sa.BOOLEAN(), autoincrement=False, nullable=True))
op.drop_column('task', 'is_complete')
# ### end Alembic commands ###
Loading