-
Notifications
You must be signed in to change notification settings - Fork 20
C22 Wei and Beenish #10
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
base: main
Are you sure you want to change the base?
Changes from all commits
ad158b5
597d34c
cb8eb34
f1433e4
9856a3f
c02f9bf
dc1f1fa
968179e
c9c7631
93abc66
9e3d33e
65111b2
2c4dedc
5310ed1
a8a5c53
b11ec73
0fdc1a2
5dee1a8
e949917
69d4628
49c96a6
fc70d52
410610c
d49aaed
85cd85d
5f2e3af
5d3a50a
c63548a
411075f
d0c56c7
e611944
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,21 @@ | ||
| from flask import Flask | ||
| from .db import db, migrate | ||
| from .models import planet | ||
| from .routes.planet_routes import planets_bp | ||
| import os | ||
|
|
||
|
|
||
| def create_app(test_config=None): | ||
| def create_app(config=None): | ||
|
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. 👍 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') | ||
|
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. 👍 Loads the connection string from the environment (provided with our |
||
|
|
||
| if config: | ||
| app.config.update(config) | ||
|
|
||
| db.init_app(app) | ||
| migrate.init_app(app, db) | ||
|
|
||
| app.register_blueprint(planets_bp) | ||
| return app | ||
| 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() |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| from sqlalchemy.orm import DeclarativeBase | ||
|
|
||
| class Base(DeclarativeBase): | ||
| pass |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| from sqlalchemy.orm import Mapped, mapped_column | ||
| from ..db import db | ||
|
|
||
| class Planet(db.Model): | ||
|
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. 👍 Nice modifications to associate this model type with our database. |
||
| id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) | ||
| name: Mapped[str] | ||
| description: Mapped[str] | ||
| galaxy: Mapped[str] | ||
|
|
||
| def to_dict(self): | ||
|
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. 👍 Nice job incorporating this refactor from the live code. |
||
| return { | ||
| "id": self.id, | ||
| "name": self.name, | ||
| "description": self.description, | ||
| "galaxy": self.galaxy | ||
| } | ||
|
Comment on lines
+11
to
+16
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. Personally, I prefer to stick with uniform 4-space indented wrapping rather than trying to align to the enclosing character. Generally the closing brace should align with either the first line (pre-indent), or the content lines (1-level indent). As written, it's a bit floaty. return {
"id": self.id,
"name": self.name,
"description": self.description,
"galaxy": self.galaxy
} |
||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| from flask import Blueprint, make_response, abort, request, Response | ||
| from app.models.planet import Planet | ||
| from ..db import db | ||
|
|
||
| planets_bp = Blueprint("planets_bp",__name__,url_prefix="/planets") | ||
|
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. 👀 Spaces after argument commas. planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") |
||
|
|
||
| @planets_bp.post("") | ||
| def create_planet(): | ||
| request_body = request.get_json() | ||
| name = request_body["name"] | ||
| description = request_body["description"] | ||
| galaxy = request_body["galaxy"] | ||
|
Comment on lines
+10
to
+12
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 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, galaxy=galaxy) | ||
| db.session.add(new_planet) | ||
| db.session.commit() | ||
|
|
||
| response = new_planet.to_dict() | ||
|
|
||
| return response, 201 | ||
|
|
||
|
|
||
| @planets_bp.get("") | ||
| def get_all_planets(): | ||
|
|
||
| query = db.select(Planet) | ||
| description_param = request.args.get("description") | ||
|
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. 👍 Nice filter parameter behavior. |
||
| if description_param: | ||
| query = query.where(Planet.description.ilike(f"%{description_param}%")) | ||
|
|
||
| galaxy_param = request.args.get("galaxy") | ||
| if galaxy_param: | ||
| query = query.where(Planet.galaxy.ilike(f"%{galaxy_param}%")) | ||
|
|
||
| #query = query.order_by(Planet.id) | ||
| planets = db.session.scalars(query.order_by(Planet.id)) | ||
|
Comment on lines
+35
to
+36
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. Since we decomposed the query into separate steps, I'd probably lean towards the following for consistency query = query.order_by(Planet.id)
planets = db.session.scalars(query) |
||
|
|
||
| planets_response = [] | ||
| for planet in planets: | ||
| planets_response.append(planet.to_dict()) | ||
|
Comment on lines
+38
to
+40
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. There's a great opportunity to try to use a list comprehension here. planets_response = [planet.to_dict() for planet in planets] |
||
| return planets_response | ||
|
|
||
| @planets_bp.get("/<planet_id>") | ||
| def get_one_planet(planet_id): | ||
| planet = validate_planet(planet_id) | ||
| return planet.to_dict() | ||
|
|
||
| @planets_bp.get("/count") | ||
| def get_count(): | ||
|
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. 👍 Nice custom end point to retrieve the number of planets. We need to be a little careful when our endpoint matches the same pattern as a placeholder route to make sure this is detected properly. In some frameworks (and even in some versions of flask), trying to map |
||
| query = db.session.query(Planet.name).count() | ||
|
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. This # need to import the func module from sqlalchemy before this
query = db.select(func.count(Planet.id))
result = db.session.scalar(query) # the count is in resultIt's longer (though it could still be done in one line), but it more cleanly separates the construction of the query from running the query. |
||
| return {"count" : query} | ||
|
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. Nit: No space before key-value ':' return {"count": query} |
||
|
|
||
| @planets_bp.put("/<planet_id>") | ||
| def update_planet(planet_id): | ||
| planet = validate_planet(planet_id) | ||
| request_body = request.get_json() | ||
|
|
||
| planet.name = request_body["name"] | ||
| planet.description = request_body["description"] | ||
| planet.galaxy = request_body["galaxy"] | ||
|
Comment on lines
+58
to
+60
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. 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") | ||
|
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. 👍 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. |
||
|
|
||
| @planets_bp.delete("/<planet_id>") | ||
| def delete_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_id} is not valid"} | ||
| 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_id} is not found"} | ||
| abort(make_response(response, 404)) | ||
|
|
||
| return planet | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Single-database configuration for Flask. |
| 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 |
| 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() |
| 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"} |
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.
Note that once we have the
Planetmodel imported in the routes, and the routes are imported here, we don't technically need to import theplanetmodule here. If you find the fact that VS Code shows this as not being used, it would now be safe to remove.