Skip to content
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

Phoenix-Liubov_Davidova-Anh_Tran #63

Open
wants to merge 36 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
fe0c62a
Finish wave 1 together
momofAnAl Oct 18, 2024
67a0ce7
cann't resolve conflict
LiubovDav Oct 18, 2024
1322e3f
Working on resolve conflict
LiubovDav Oct 18, 2024
fa4fef4
Conflict resolved
momofAnAl Oct 18, 2024
9e89a7c
Merge branch 'main' of https://github.com/momofAnAl/solar-system-api
momofAnAl Oct 18, 2024
3165fdf
Resolved conflict
momofAnAl Oct 18, 2024
763417e
Resolved conflicts
momofAnAl Oct 18, 2024
2eb21ed
Working on resolve conflict
LiubovDav Oct 18, 2024
1f9484f
Working on resolve conflict
LiubovDav Oct 18, 2024
6945df6
Update get one planet and handeling errors
momofAnAl Oct 21, 2024
240d490
Created do_dict function and return in planet_id
momofAnAl Oct 21, 2024
ce5ab0d
adding code 200 in line 23 of routes
momofAnAl Oct 21, 2024
c42ffb3
Fix the typo on validate and add diameter and number_of_moons to attr…
momofAnAl Oct 25, 2024
40d6289
Adding Pluto
momofAnAl Oct 25, 2024
32cb34a
using to_dict() in get_all_planets and update list comprehension
momofAnAl Oct 25, 2024
7a86581
create base and db. Update migration and connect db Planet model gene…
momofAnAl Oct 25, 2024
52c0b7d
create POST request for Planet table and add 3 planets
momofAnAl Oct 25, 2024
af930b6
Create get method for all planets
momofAnAl Oct 25, 2024
13ff70f
Nothing changed
LiubovDav Oct 25, 2024
bfd35df
resolvled conflict
LiubovDav Oct 25, 2024
1a2fd50
remove id in POST method
momofAnAl Oct 29, 2024
ab90026
create get single planet, update and deleted
LiubovDav Oct 29, 2024
91a07db
there were nothing change
momofAnAl Oct 29, 2024
c2c89a6
Merge branch 'main' of https://github.com/momofAnAl/solar-system-api
momofAnAl Oct 29, 2024
c28922e
Update get all planets with add query params for description and numb…
momofAnAl Oct 30, 2024
461683d
change the .get[] to .get()
momofAnAl Oct 30, 2024
6516233
Update the query for number_of_moons_param that take record set for n…
momofAnAl Oct 30, 2024
7bccff0
Create tests environment and update all unit tests and conftest.py
momofAnAl Oct 31, 2024
026ee76
changing the name for test in database variable name in .env and conf…
momofAnAl Oct 31, 2024
ae2d925
change the name of model file to macth the name of class. Remove the …
momofAnAl Nov 4, 2024
c9a39df
change name of column to diameter_in-km
momofAnAl Nov 4, 2024
50f3748
return 2 planets in two_saved_planets
momofAnAl Nov 4, 2024
3020969
update tests id after return the values of two planets
momofAnAl Nov 4, 2024
343eb55
change the name of clumn diameter
momofAnAl Nov 4, 2024
062e52e
delete migration folder
momofAnAl Nov 6, 2024
6bfb32b
install gunicorn and add to requirements.txt
momofAnAl Nov 6, 2024
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
17 changes: 16 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
from flask import Flask
from app.db import db, migrate
from app.models import planets
Copy link
Contributor

Choose a reason for hiding this comment

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

Note that once we have the Planet model imported in the routes, and the routes are imported here, we don't technically need to import the planets module here. If you find the fact that VS Code shows this as not being used, it would now be safe to remove.

from app.routes.planets_routes import planet_bp
import os


def create_app(test_config=None):
def create_app(config=None):
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Thanks for renaming this. This param could be used for scenarios other than testing (the name was left over from the previous curriculum).

app = Flask(__name__)
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI')
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Loads the connection string from the environment (provided with our .env during development).


if config:
app.config.update(config)


db.init_app(app)
migrate.init_app(app, db)

app.register_blueprint(planet_bp)

return app
6 changes: 6 additions & 0 deletions app/db.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
from .models.base import Base

db = SQLAlchemy(model_class=Base)
migrate = Migrate()
Empty file added app/models/__init__.py
Empty file.
4 changes: 4 additions & 0 deletions app/models/base.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from sqlalchemy.orm import DeclarativeBase

class Base(DeclarativeBase):
pass
56 changes: 56 additions & 0 deletions app/models/planets.py
Copy link
Contributor

Choose a reason for hiding this comment

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

👀 I hadn't noted this before, but prefer to have the name of the model file match the name of the class. So here, since the model is Planet, the file should be planet.py rather than planets.py.

Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
from sqlalchemy.orm import Mapped, mapped_column
from app.db import db

class Planet(db.Model):
id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
name: Mapped[str]
description: Mapped[str]
diameter: Mapped[int]
number_of_moons: Mapped[int]
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Nice additional data columns.

For numerical values that require a unit (like diameter), it can be useful to note the units somewhere. For example, we could call this diameter_in_km/diameter_in_mi so that it's explicitly a part of the name. If we feel that's too intrusive, a comment about the expected units can still be helpful. We could even add additional methods for retreiving the diameter in certain units to allow the name to remain simple, but have explicit logic that effectively documents the units.


def to_dict(self):
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Nice job incorporating this refactor from the live code.

return dict(
id=self.id,
name=self.name,
description=self.description,
diameter=self.diameter,
number_of_moons=self.number_of_moons
)










# class Planet:
Copy link
Contributor

@anselrognlie anselrognlie Nov 3, 2024

Choose a reason for hiding this comment

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

It can be tempting to keep old code around for reference, but keep in mind that with git, we can always get back to previous versions if necessary. So in general, prefer to remove old code, or at least put very clear comments around why this code is here and commented out.

Even with git, it can be inconvenient to find a previous version that had our original approach. To help with that, we can create a side branch on a commit that still has the old code, so that we can find it more easily, then remove the code from the main branch.

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

# def to_dict(self):
# return dict(
# id=self.id,
# name=self.name,
# description=self.description,
# diameter=self.diameter,
# number_of_moons=self.number_of_moons
# )

# planets = [
# Planet(1, "Mercury", "Smallest planet and closest to the Sun.", 4879, 0),
# Planet(2, "Venus", "Similar to Earth but with a thick, toxic atmosphere.", 12104, 0),
# Planet(3, "Earth", "The only planet known to support life.", 12742, 1),
# Planet(4, "Mars", "The Red Planet, known for its volcanoes.", 6779, 2),
# Planet(5, "Jupiter", "The largest planet, famous for its Great Red Spot.", 139820, 79),
# Planet(6, "Saturn", "Known for its stunning rings.", 116460, 83),
# Planet(7, "Uranus", "An ice giant that rotates on its side.", 50724, 27),
# Planet(8, "Neptune", "The farthest planet, known for strong winds.", 49244, 14),
# Planet(9, "Pluto", "Dwarf planet known for its complex orbit and atmosphere.", 2376, 5)
# ]
2 changes: 0 additions & 2 deletions app/routes.py

This file was deleted.

Empty file added app/routes/__init__.py
Empty file.
93 changes: 93 additions & 0 deletions app/routes/planets_routes.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
from flask import Blueprint, abort, make_response, request, Response
from app.models.planets import Planet
from ..db import db

planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets")

@planet_bp.post("")
def create_planet():
request_body = request.get_json()

name = request_body["name"]
description = request_body["description"]
diameter = request_body["diameter"]
number_of_moons = request_body["number_of_moons"]
Comment on lines +11 to +14
Copy link
Contributor

Choose a reason for hiding this comment

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

We didn't explicitly look at invalid/missing data scenarios for creating a record, but think about what would happen here, and what response we might want to reply with.


new_planet = Planet(name=name, description=description, diameter=diameter, number_of_moons=number_of_moons)
db.session.add(new_planet)
db.session.commit()

response = new_planet.to_dict()
return response, 201

@planet_bp.get("")
def get_all_planets():
query = db.select(Planet)
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Nice filter parameter behavior.

For numeric values, it can often be useful to allow filtering for less than or greater than a value. How might we allow a client to specify such behavior?


description_param = request.args.get("description")
if description_param:
query = query.where(Planet.description.ilike(f"%{description_param}%"))

number_of_moons_param = request.args.get("number_of_moons")
if number_of_moons_param:
query = query.where(Planet.number_of_moons == number_of_moons_param)

query = query.order_by(Planet.id)

planets = db.session.scalars(query)

response_body = [planet.to_dict() for planet in planets]

return response_body

@planet_bp.get("/<planet_id>")
def get_single_planet(planet_id):
planet = validate_planet(planet_id)

return planet.to_dict()

@planet_bp.put("/<planet_id>")
def update_single_planet(planet_id):
planet = validate_planet(planet_id)
request_body = request.get_json()

planet.name = request_body["name"]
planet.description = request_body["description"]
planet.diameter = request_body["diameter"]
planet.number_of_moons = request_body["number_of_moons"]
Comment on lines +54 to +57
Copy link
Contributor

Choose a reason for hiding this comment

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

Similar problems as for creating a record could happen here as well. What might we want to check for, and how might we respond?


db.session.commit()

return Response(status=204, mimetype='application/json')
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 This is how we say there's no content in the response, but even still, we should keep our type consistently as json for all our endpoints.


@planet_bp.delete("/<planet_id>")
def delete_single_planet(planet_id):
planet = validate_planet(planet_id)

db.session.delete(planet)
db.session.commit()

return Response(status=204, mimetype='application/json')


def validate_planet(planet_id):
try:
planet_id = int(planet_id)
except:
response = {
"message": f"Planet {planet_id} invalid"
}
abort(make_response(response, 400))

query = db.select(Planet).where(Planet.id == planet_id)
planet = db.session.scalar(query)

if not planet:
response = {
"message": f"Planet {planet_id} not found"
}
abort(make_response(response, 404))

return planet


1 change: 1 addition & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Single-database configuration for Flask.
50 changes: 50 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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,flask_migrate

[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

[logger_flask_migrate]
level = INFO
handlers =
qualname = flask_migrate

[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
113 changes: 113 additions & 0 deletions migrations/env.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
import logging
from logging.config import fileConfig

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')


def get_engine():
try:
# this works with Flask-SQLAlchemy<3 and Alchemical
return current_app.extensions['migrate'].db.get_engine()
except (TypeError, AttributeError):
# this works with Flask-SQLAlchemy>=3
return current_app.extensions['migrate'].db.engine


def get_engine_url():
try:
return get_engine().url.render_as_string(hide_password=False).replace(
'%', '%%')
except AttributeError:
return str(get_engine().url).replace('%', '%%')


# 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', get_engine_url())
target_db = current_app.extensions['migrate'].db

# 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 get_metadata():
if hasattr(target_db, 'metadatas'):
return target_db.metadatas[None]
return target_db.metadata


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=get_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.')

conf_args = current_app.extensions['migrate'].configure_args
if conf_args.get("process_revision_directives") is None:
conf_args["process_revision_directives"] = process_revision_directives

connectable = get_engine()

with connectable.connect() as connection:
context.configure(
connection=connection,
target_metadata=get_metadata(),
**conf_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"}
Loading