Gym module created

[csidarous]

Created Gym module to scrape data of all the gym counts and returns as a dictionary.

[tianyizheng02]

Tests are failing because of formatting issues with black. Please check out the contributing guidelines for installing and running the dev tools we use. Ideally you should be using pre-commit to check for spacing issues, formatting issues, etc. prior to committing your code.

[tianyizheng02]

Please add unit tests for this new module

[Steven-Jarmell]

I have a lot of historical data for this stored, feel free to use this URL to access it: https://pitt-gym-tracker.vercel.app/api/gymdata/Baierl%20Rec%20Center

[Steven-Jarmell]

Let's rename this, it can be misinterpreted as fetching a single gym's information. Let's also call it something like get_all_gyms_info()

[tianyizheng02]

Also on this line, it'd be nice if the type hint specified the dictionary's key and value types, something like

def function_name() -> dict[some_type, some_type]:

If/when we start using mypy in this repo for static type checking, this'll be important

[Steven-Jarmell]

This is not a very scalable way of doing this and produces a lot of unnecessary code. Let's refactor this to have a list of gym names and one method to retrieve one gyms information. Something like this:

GYM_NAMES = ["Baierl Rec Center"... ]

def get_gym_information(gym_name: string) -> Gym:
     # Validate that gym_name is in GYM_NAMES
     # return info[gym_name]

With something like this, if there is ever a new gym location in the future that Pitt starts collecting data for, adding it to this API would be as simple as adding the name to the list, rather than having to create a brand new method for it.

It would also be a good practice to create a Gym data structure (as shown in the method signature) to store the information for each gym to create a formal model of how to access the data rather than having to print out the object and figure it out.

[tianyizheng02]

^ See courses.py for how you could create a data structure (namely a NamedTuple) to store this kind of structured data

[Steven-Jarmell]

No need to declare this again, you can simply access it from the gym module :)

gym.GYM_URL

[tianyizheng02]

Also on this line, it'd be nice if the type hint specified the dictionary's key and value types, something like

def function_name() -> dict[some_type, some_type]:

If/when we start using mypy in this repo for static type checking, this'll be important

[tianyizheng02]

Also, looks like unit tests are failing:

>       self.assertEqual(gym_info["Baierl Rec Center"], "200")
E       AssertionError: '0' != '200'
E       - 0
E       + 200

You can find more details in the test logs

[csidarous]

Thanks both for your feedback and guidance. I made the requested updates and changed to the Gym module. I will try my best to add more tests.

[Steven-Jarmell]

One small change needed to fix the variable for the list of gym names, then this should be good

[Steven-Jarmell]

Hey @csidarous, the commit message that you just sent has a typo at the beginning. Let's be more careful about this and hold a high bar.

[Steven-Jarmell]

Also considering that there are 8 commits, once Tianyi is satisfied, let's rebase and squash them into one commit.

[tianyizheng02]

Name                  Stmts   Miss Branch BrPart  Cover   Missing
-----------------------------------------------------------------
...
pittapi/gym.py           40      0     10      0   100%

Nice, 100% coverage 👍

[tianyizheng02]

Thanks for all your work, @csidarous!