Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
ad158b5
aggrement
hintow Oct 18, 2024
597d34c
"added signature to coworking_agreement"
beenishali693 Oct 18, 2024
cb8eb34
Merge branch 'main' of https://github.com/beenishali693/solar-system-api
beenishali693 Oct 18, 2024
f1433e4
draft wave 1&2
hintow Oct 18, 2024
9856a3f
Merge branch 'main' of https://github.com/beenishali693/solar-system-api
hintow Oct 18, 2024
c02f9bf
draft 2
hintow Oct 18, 2024
dc1f1fa
"End of Wave 1"
beenishali693 Oct 18, 2024
968179e
End of wave 1
beenishali693 Oct 18, 2024
c9c7631
rename planets to planet
hintow Oct 21, 2024
93abc66
Merge branch 'main' of https://github.com/beenishali693/solar-system-api
hintow Oct 21, 2024
9e3d33e
Wave 2 completed
beenishali693 Oct 21, 2024
65111b2
moved to_dict to planets file
beenishali693 Oct 21, 2024
2c4dedc
merge wave2
hintow Oct 24, 2024
5310ed1
Merge branch 'main' of https://github.com/beenishali693/solar-system-api
hintow Oct 24, 2024
a8a5c53
solve to_dict problem
hintow Oct 24, 2024
b11ec73
200 response code
hintow Oct 24, 2024
0fdc1a2
finished with wave 3
beenishali693 Oct 28, 2024
5dee1a8
get one planet
hintow Oct 29, 2024
e949917
added get_one_planet, update and delete routes
beenishali693 Oct 29, 2024
69d4628
wave4
hintow Oct 29, 2024
49c96a6
Merge branch 'main' of https://github.com/beenishali693/solar-system-api
hintow Oct 29, 2024
fc70d52
wave 5
hintow Oct 30, 2024
410610c
added seed.py
beenishali693 Oct 31, 2024
d49aaed
added a count parameter
beenishali693 Oct 31, 2024
85cd85d
wave 6
hintow Oct 31, 2024
5f2e3af
end of wave 6
beenishali693 Oct 31, 2024
5d3a50a
Merge branch 'main' of https://github.com/beenishali693/solar-system-api
hintow Oct 31, 2024
c63548a
Merge branch 'main' of https://github.com/beenishali693/solar-system-api
beenishali693 Oct 31, 2024
411075f
minor changes
beenishali693 Oct 31, 2024
d0c56c7
fixed delete test to also check the count
beenishali693 Oct 31, 2024
e611944
added test on learn
beenishali693 Oct 31, 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
16 changes: 15 additions & 1 deletion app/__init__.py
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

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 planet module here. If you find the fact that VS Code shows this as not being used, it would now be safe to remove.

from .routes.planet_routes import planets_bp
import os


def create_app(test_config=None):
def create_app(config=None):

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

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(planets_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
16 changes: 16 additions & 0 deletions app/models/planet.py
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):

Choose a reason for hiding this comment

The 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):

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 {
"id": self.id,
"name": self.name,
"description": self.description,
"galaxy": self.galaxy
}
Comment on lines +11 to +16

Choose a reason for hiding this comment

The 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
        }

2 changes: 0 additions & 2 deletions app/routes.py

This file was deleted.

1 change: 1 addition & 0 deletions app/routes/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

88 changes: 88 additions & 0 deletions app/routes/planet_routes.py
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")

Choose a reason for hiding this comment

The 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

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, 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")

Choose a reason for hiding this comment

The 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

Choose a reason for hiding this comment

The 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

Choose a reason for hiding this comment

The 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():

Choose a reason for hiding this comment

The 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 /planets/count could end up matching /planets/<planet_id>, with count becoming the planet_id value. Some times this is order dependent, and sometimes the framework will treat a literal value like this as "higher priority." So be sure to understand why this could cause issues, and then double check in your framework what the actual behavior is (espcially nice if you can find documentation about the scenario).

query = db.session.query(Planet.name).count()

Choose a reason for hiding this comment

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

This session.query() syntax is considered legacy in the current SqlAlchemy, and shouldn't be used any longer. When researching how to do operations, always be suer that any resources apply to the version of the library (SqlAlchemy) in use. The current SqlAlchemy approach would be as follows

    # 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 result

It'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}

Choose a reason for hiding this comment

The 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

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

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.


@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
13 changes: 12 additions & 1 deletion coworking_agreement.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,32 @@ Talk through each section with your partner. Add notes on what you discussed and
## Accessibility Needs
*What does each team member need access to in order to succeed and show up the best they can?*


Flexibility and schedule.

## Collaboration vs. individual work expectations
*Clarify your collaboration expectations- does your group want to write code together all of the time? Or divide work to do independently, then come together to share accomplishments? What tools and technologies can help your collaboration?*
Group work & indepent work for best practice.

## Learning Style
*How does each team member learn best in project settings?*

Practicing

## Preferred Feedback Style
*How does each team member best receive feedback?*

Open to feedback. Meetings/slack

## One Team Communication Skill to Improve
*What is a teamwork-related skill you want to work on?*
Communication skill

## Optional: Other agreements
*Other co-working agreements that were not captured in the above sections.*

## Signatures
______________ _______________
______________ _____Wei Qiang__________
Date: ___2024/10/18______
_Beenish Ali____________ _______________
Date: _________
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