Skip to content
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
20 changes: 20 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
from dotenv import load_dotenv
import os

db = SQLAlchemy()
migrate = Migrate()
load_dotenv()

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Notice that line 14 and 18 are the same. Since this line of code needs to execute for both conditions, you can bring it outside the if/else block.

app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI")

from app.models.planet import Planet
db.init_app(app)
migrate.init_app(app, db)
from .routes import planets_bp
app.register_blueprint(planets_bp)

return app
Empty file added app/models/__init__.py
Empty file.
22 changes: 22 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
from app import db

class Planet(db.Model):
id = db.Column(db.Integer,primary_key = True, autoincrement = True)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick: the spacing here is inconsistent. we need a space after the comma after db.Integer and there should be no spaces before and after equal sign for the last 2 arguments. That would look like:

id = db.Column(db.Integer, primary_key=True, autoincrement=True)

name = db.Column(db.String)
description = db.Column(db.Text)
form = db.Column(db.String)

def to_dict(self):
planet_dict = {}
planet_dict["id"] = self.id
planet_dict["name"] = self.name
planet_dict["description"] = self.description
planet_dict["form"] = self.form

return planet_dict
Comment on lines +10 to +16

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Since you don't have any conditional logic when you create a dictionary and add key value pairs to it, you can directly return a dictionary literal like:

        return {
            "id": self.id,
            "name": self.name,
            "description": self.description,
            "form": self.form
        }

@classmethod
def from_dict(cls, planet_data):
new_planet = Planet(name=planet_data["name"],
description=planet_data["description"],
form=planet_data["form"])
return new_planet
Comment on lines +18 to +22

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Instead of hardcoding Planet on line 19, we should use the cls variable that a class method can access.

Since you don't have any conditional logic when you create an instance of the object, you can directly return the object like this without needing to create the variable new_planet:

return cls(
            name = data_dict["name"],
            description = data_dict["description"],
            radius = data_dict["form"]
        )

80 changes: 79 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,80 @@
from flask import Blueprint
from flask import Blueprint, jsonify, abort, make_response, request
from app.models.planet import Planet
from app import db

# class Planet:
# def __init__(self, id, name, description, diameter):
# self.id = id
# self.name = name
# self.description = description
# self.diameter = diameter

# planets = [Planet(1, 'Venus', 'The hottest planet',12104 ),
# Planet(2,'Mercury', 'Has no natural satellite', 4879),
# Planet(3,'Earth', 'The only planet where life is found', 12742 )

# ]
Comment on lines +5 to +16

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Now that you've refactored Planet into it's own file, you can delete these comments to keep your project concise


planets_bp= Blueprint('planets', __name__,url_prefix='/planets')

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick: white spacing around the equal sign should be the same on both sides:
planets_bp = Blueprint('planets', __name__,url_prefix='/planets')

# Helper function
def validate_model(cls,model_id):

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick: there should be a space after the comma (cls, model_id)

try:
model_id = int(model_id)
except:
abort(make_response({"message": f" {cls.__name__} {model_id} invalid"}, 400))

model = cls.query.get(model_id)
if not model:
abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404))
return model



# Routes
@planets_bp.route("", methods=['POST'])
def create_planet():
request_body = request.get_json()
new_planet = Planet.from_dict(request_body)
db.session.add(new_planet)
db.session.commit()
Comment on lines +37 to +39

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We need to add some error handling when we're dealing with a request that has a client provided request body. We should anticipate that the data sent in the request by the client has bad or missing data.

We can use try/except to handle bad or missing data when creating a planet like:

    request_body = request.get_json()
    try:
        new_planet = Planet.from_dict(request_body)

        db.session.add(new_planet)
        db.session.commit()

        message = f"Planet {new_planet.name} successfully created."

        return make_response(jsonify(message), 201)
    except KeyError as e:
        abort(make_response({"message": f"Missing required value {e}"}, 400))

Without this error handling, if the request_body is missing data, then line 37 will throw an exception that isn't handled and your server will return a generic 500 error instead of an informative response telling the client what's wrong with their request body

return make_response(jsonify(f"Planet {new_planet.name} was created successfully"), 201)

@planets_bp.route("", methods=['GET'])

def read_all_planets():
name_query = request.args.get("name")
if name_query:
planets = Planet.query.filter_by(name=name_query)
else:
planets = Planet.query.all()
planet_records= []
for planet in planets:
planet_records.append(
planet.to_dict())
Comment on lines +50 to +53

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This would be a great opportunity to use list comprehension!

return jsonify(planet_records)


@planets_bp.route("/<planet_id>", methods= ['GET'])
def get_one_planet(planet_id):
planet = validate_model(Planet, planet_id)

return planet.to_dict()
Comment on lines +59 to +61

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

👍 looks good!



@planets_bp.route("/<planet_id>", methods= ['PUT'])
def update_planet(planet_id):
planet = validate_model(Planet, planet_id)
request_body = request.get_json()
planet.name = request_body["name"]
planet.description = request_body["description"]
planet.form = request_body["form"]

db.session.commit()
return make_response(jsonify(f"Planet {planet_id} updated succesffuly"), 200)
Comment on lines +68 to +73

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Just like you had error handling in your POST request, you want to add try/except to handle missing data when updating a Planet. Right now, if the request body sent with this PUT request didn't have a key "description", then line 65 would throw an exception that doesn't get handled. We should anticipate that a request body might have missing or bad data and try to handle it our route.


@planets_bp.route("/<planet_id>", methods= ['DELETE'])
def delete_planet(planet_id):
planet = validate_model(Planet, planet_id)
db.session.delete(planet)
db.session.commit()
return make_response(jsonify(f"Planet {planet_id} deleted successfully"))

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

👍

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"}
42 changes: 42 additions & 0 deletions migrations/versions/ba182818ae97_changed_name_to_solar.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
"""changed name to solar

Revision ID: ba182818ae97
Revises: e9b8e201f964
Create Date: 2023-04-26 16:13:55.883068

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'ba182818ae97'
down_revision = 'e9b8e201f964'
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.Text(), nullable=True),
sa.Column('form', sa.String(), nullable=True),
sa.PrimaryKeyConstraint('id')
)
op.drop_table('solar')
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('solar',
sa.Column('id', sa.INTEGER(), autoincrement=True, nullable=False),
sa.Column('name', sa.VARCHAR(), autoincrement=False, nullable=True),
sa.Column('description', sa.TEXT(), autoincrement=False, nullable=True),
sa.Column('form', sa.VARCHAR(), autoincrement=False, nullable=True),
sa.PrimaryKeyConstraint('id', name='solar_pkey')
)
op.drop_table('planet')
# ### end Alembic commands ###
34 changes: 34 additions & 0 deletions migrations/versions/e9b8e201f964_created_solar_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""created Solar model

Revision ID: e9b8e201f964
Revises:
Create Date: 2023-04-26 15:23:17.593584

"""
from alembic import op
import sqlalchemy as sa


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


def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('solar',
sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
sa.Column('name', sa.String(), nullable=True),
sa.Column('description', sa.Text(), nullable=True),
sa.Column('form', sa.String(), nullable=True),
sa.PrimaryKeyConstraint('id')
)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('solar')
# ### end Alembic commands ###
Empty file added tests/__init__.py
Empty file.
Loading