Ocelots - Lisa Utsett, Xuan Hien Pham #20

lisabethu88 · 2023-01-09T20:31:53Z

No description provided.

…on that handles 400/404 errors

Planets models setup

…r by name and sort in either ascending or descending order.

… file from routes.py. Deleted routes.py. Added functionality that allows the user to sort by any column.

'to_dict_refactor' of https://github.com/lisabethu88/solar-system-api into to_dict_refactor

…s method for the Planet class

…olar-system-api into from_dict_refactor

…tem-api into moon_model

…system-api into nested_routes

kelsey-steven-ada

Great work Lisa & Chelsea! I've left a few comments & questions, feel free to reply here or message me on Slack if you have questions on the feedback 🙂

kelsey-steven-ada · 2023-01-10T23:41:30Z

app/models/moon.py

+    description = db.Column(db.String)
+    name = db.Column(db.String)
+    planet_id = db.Column(db.Integer, db.ForeignKey('planet.id'))
+    planets = db.relationship("Planet", back_populates = "moons")


Does this attribute hold a single planet, or many planets? If it is only ever connected to 1 planet, I would suggest using a singular variable name to better describe the contents.

kelsey-steven-ada · 2023-01-10T23:47:53Z

app/models/planet.py

+        moon_names = []
+        for moon in self.moons:
+            moon_names.append(moon.name)
+        planet_dict["moons"] = moon_names


I know this is the way I grabbed cat names during the class livecode, but this is a great place for a list comprehension!

planet_dict["moons"] = [moon.name for moon in self.moons]

kelsey-steven-ada · 2023-01-10T23:57:49Z

app/moons_routes.py

@@ -0,0 +1,32 @@
+from app import db


It looks like the route files are loose in the app folder. To keep a project organized as it grows, I recommend creating a routes folder inside of app to place these in.

kelsey-steven-ada · 2023-01-10T23:58:48Z

app/moons_routes.py

+    moons_response = []
+    for moon in moons:
+        moons_response.append(moon.to_dict())


This would be another great place for a list comprehension - what could that look like?

moons_response = [moon.to_dict() for moon in moons]

kelsey-steven-ada · 2023-01-11T02:03:35Z

app/planets_routes.py

+from sqlalchemy import desc, asc
+
+
+# ---------helper functions--------


Specific teams might have their own style guides, but it is a common practice to place helper functions at the end of a file rather than the beginning. An often-used analogy is to lay out code like a newspaper article. Headlines and the most important information comes first - Functions that use other functions in the file go at the top. That gets followed by the details and extra information in an article, or in our code, all the helper functions that support the higher up functions.

kelsey-steven-ada · 2023-01-11T02:07:10Z

app/planets_routes.py

+
+
+


Tiny best practices feedback - we typically only want a single blank line to separate functions in a file. If we have blocks of functions that do different things, then we might consider using 2 blank lines. A solid example of this are lines 37 and 38 where we have 2 blank lines separating the block of helper functions from the route functions that follow.

kelsey-steven-ada · 2023-01-11T02:08:16Z

app/planets_routes.py

+
+
+
+def validate_model(cls, model_id):


Since this function is shared and not specific to the planet routes, I would suggest moving it out of the planet_routes.py file.

kelsey-steven-ada · 2023-01-11T02:10:15Z

app/planets_routes.py

+    # if "name" not in request_body or "description" not in request_body or 'diameter_in_km' not in request_body:
+        # return make_response("Invalid Request", 400)


Gentle reminder that we want to remove commented code as part of our review and clean up steps before opening PRs.

kelsey-steven-ada · 2023-01-11T02:12:29Z

app/planets_routes.py

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


Around best practices, there are many lines across the files that break the PEP 8 guide of 79 characters max per line. I would keep an eye out for this in the future, especially on lines where there are nested function calls.

kelsey-steven-ada · 2023-01-11T02:16:24Z

tests/conftest.py

+    return app.test_client()
+
+@pytest.fixture
+def one_planet(app):


I suggest updating this name to reflect that the function also creates a moon.

lisabethu88 and others added 30 commits December 14, 2022 13:56

added planets.py

d0c1880

Created Planet class in planets.py

4dcfc9b

created planets blueprint

f7c2f4a

created to_dict method in Planet class

7e71408

Added get_planet_by_id function and 400/404 error handling to planets.py

c4ff040

updated get_planet_by_id function, created new validate_planet functi…

0d44f67

…on that handles 400/404 errors

set up Planet modeland database

823a64a

Merge pull request #1 from lisabethu88/planets_models_setup

842c63a

Planets models setup

add planets.py changes

f6d81a1

created a route that creates model records

a1ba03e

defined route that reads model records

e7051b2

created a GET endpoint for getting one planet

99d983e

define update route

715df1c

defined route that deletes a planet

cc0275a

Added functionality to allow the user to make a request to both filte…

6a8add5

…r by name and sort in either ascending or descending order.

renamed planets.py to planets_routes.py and put routes back into this…

55d4435

… file from routes.py. Deleted routes.py. Added functionality that allows the user to sort by any column.

commit before making a pull request

7eb943a

commit planets_routes.py

633fed3

created test database and .env and refactor create_app

0f090cc

added branch test_Setup

9c42bf6

create test fixture for unit tests for get,post,update and delete

f067be1

refactored to_dict and added more tests

6bf4e81

refactored tests

442ab49

from_dict classmethod

d328a24

merge

ec72cce

'to_dict_refactor' of https://github.com/lisabethu88/solar-system-api into to_dict_refactor

added to_dict and from_dict test to tests_models.py and create a clas…

4c114f0

…s method for the Planet class

Merge branch 'from_dict_refactor' of https://github.com/lisabethu88/s…

75eb5a4

…olar-system-api into from_dict_refactor

refactored validate_planet to validate_model

0642a6a

Merge branch 'from_dict_refactor' of https://github.com/lisabethu88/s…

fda0886

…olar-system-api into from_dict_refactor

Created Moon model

3f46339

HienXuanPham and others added 8 commits January 5, 2023 14:43

Merge branch 'moon_model' of https://github.com/lisabethu88/solar-sys…

cd5dd84

…tem-api into moon_model

added nested routes

801b7ab

fixed issue with route that creates a new moon with a planet

a9f0bc9

Merge branch 'nested_routes' of https://github.com/lisabethu88/solar-…

4e7921c

…system-api into nested_routes

added read one moon

af46358

added gunicorn to requirements.txt

0dba82d

added Procfile

9a49851

added tests for nested routes

8641101

kelsey-steven-ada reviewed Jan 11, 2023

View reviewed changes

		from sqlalchemy import desc, asc


		# ---------helper functions--------

		# if "name" not in request_body or "description" not in request_body or 'diameter_in_km' not in request_body:
		# return make_response("Invalid Request", 400)

Ocelots - Lisa Utsett, Xuan Hien Pham #20

Are you sure you want to change the base?

Ocelots - Lisa Utsett, Xuan Hien Pham #20

Uh oh!

Conversation

lisabethu88 commented Jan 9, 2023

Uh oh!

kelsey-steven-ada left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants