-
Notifications
You must be signed in to change notification settings - Fork 67
Zoisite - Jessica and Whitney #29
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
1fcae49
c3f4be4
ca66818
fb07210
2cd9ff7
8be0028
de7739e
340352c
91d8c5f
73ad927
983fe4b
f9b00d7
be03c4c
a1ad3e0
a5d6b17
ab2196d
b03bd18
fc669b6
bafa620
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,32 @@ | ||
| 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__) | ||
| app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False | ||
|
|
||
| if not test_config: | ||
| app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") | ||
| else: | ||
| app.config['TESTING'] = True | ||
| app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") | ||
|
|
||
| db.init_app(app) | ||
| migrate.init_app(app, db) | ||
|
|
||
| from app.models.planet import Planet | ||
|
|
||
|
|
||
| from app.routes import planets_bp | ||
| app.register_blueprint(planets_bp) | ||
|
|
||
| return app | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| from app import db | ||
|
|
||
| class Planet(db.Model): | ||
| __tablename__ = 'planets' | ||
|
|
||
| id = db.Column(db.Integer, primary_key=True, autoincrement=True) | ||
| name = db.Column(db.String, nullable=False) | ||
|
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. Great job making your planets non-nullable! We would definitely want to make sure we include a name when we create a planet! |
||
| description = db.Column(db.String, nullable=False) | ||
| mass = db.Column(db.Numeric(precision=16, scale=3), nullable=False) | ||
|
|
||
| def to_dict(self): | ||
| return { | ||
| 'id': self.id, | ||
| 'name': self.name, | ||
| 'description': self.description, | ||
| 'mass': self.mass, | ||
| } | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,96 @@ | ||
| from flask import Blueprint | ||
| from flask import Blueprint, jsonify, abort, make_response, request | ||
| from app.models.planet import Planet | ||
| from app import db | ||
|
|
||
| planets_bp = Blueprint('planets', __name__, url_prefix='/planets') | ||
|
|
||
| @planets_bp.route("", methods=['POST']) | ||
| def create_planet(): | ||
| request_body = request.get_json() | ||
| new_planet = Planet( | ||
| name = request_body["name"], | ||
| description = request_body["description"], | ||
| mass = request_body["mass"], | ||
| ) | ||
|
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 might be a good candidate for error handling because it is possible a name, description or mass is not included! |
||
|
|
||
| db.session.add(new_planet) | ||
| db.session.commit() | ||
|
|
||
| message = f"New planet {new_planet.name} successfully created, biatch!" | ||
|
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. I approve of this message! |
||
|
|
||
| return make_response(message, 201) | ||
|
|
||
| @planets_bp.route("", methods=["GET"]) | ||
| def get_planets(): | ||
| mass = request.args.get("mass") | ||
|
|
||
| planets = Planet.query | ||
|
|
||
| if mass: | ||
| planets = planets.filter_by(mass=mass) | ||
|
|
||
| planets = planets.all() | ||
|
|
||
| request_body = [] | ||
| for planet in planets: | ||
| request_body.append( | ||
| dict( | ||
| id=planet.id, | ||
| name=planet.name, | ||
| description=planet.description, | ||
| mass=planet.mass | ||
| ) | ||
| ) | ||
| return jsonify(request_body), 200 | ||
|
|
||
| def validate_planet(planet_id): | ||
| try: | ||
| planet_id = int(planet_id) | ||
| except: | ||
| abort(make_response({"message": f"Planet {planet_id} is invalid, sucker!"}, 400)) | ||
|
|
||
| planet = Planet.query.get(planet_id) | ||
|
|
||
| if not planet: | ||
| abort(make_response({"message": f"Planet {planet_id} was not found, sucker!"}, 404)) | ||
|
|
||
| return planet | ||
|
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 validate_planet is a helper method, it is usually a good idea to move it either before or after the routes, or to its own file! |
||
|
|
||
| @planets_bp.route("/<planet_id>", methods=['GET']) | ||
| def read_one_planet(planet_id): | ||
| planet = validate_planet(planet_id) | ||
| return { | ||
| "id" : planet.id, | ||
| "name": planet.name, | ||
| "description": planet.description, | ||
| "mass": planet.mass | ||
| } | ||
|
|
||
| @planets_bp.route("/<planet_id>", methods=['PUT']) | ||
| 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.mass = request_body["mass"] | ||
|
|
||
| db.session.commit() | ||
|
|
||
| message = f"Planet {planet} succesfully updated, biatch!" | ||
|
|
||
| return make_response({"message": message}, 200) | ||
|
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 would be another good candidate for error handling! How could we handle these situations if there was no information provided in the request body? |
||
|
|
||
| @planets_bp.route("/<planet_id>", methods=['DELETE']) | ||
| def delete_planet(planet_id): | ||
| planet = validate_planet(planet_id) | ||
|
|
||
| db.session.delete(planet) | ||
| db.session.commit() | ||
|
|
||
| message = f"Planet {planet} succesfully deleted, biatch!" | ||
|
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. I also approve of this message! |
||
|
|
||
| return make_response({"message": message}, 200) | ||
|
|
||
|
|
||
|
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. 👍 |
||
|
|
||
| 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,110 @@ | ||
| 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: | ||
| # 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.') | ||
|
|
||
| connectable = get_engine() | ||
|
|
||
| with connectable.connect() as connection: | ||
| context.configure( | ||
| connection=connection, | ||
| target_metadata=get_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() |
| 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.
Great job placing this statement before the conditional so you don't duplicate code!