Changes

`src/api.py`

Mostly organizing code. forecast() now returns a dictionary, not several nested lists, for reusability

`src/helper.py`

This file has too many if statements. These were replaced by dictionary mappings, which makes the code look cleaner.
forecast_to_json was altered to take a dictionary as input, from the forecast() function in src/api.py

`src/test_api.py`

test_forecast() was failing because of the dictionary now being returned from the forecast. Fixed this

`src/test_helper.py`

A new unit test was added to test the json argument. Prior to this, the json argument was causing an error and we were non-the-wiser because our tests didn't catch this!

Summary by Sourcery

Refactor helper functions to use mappings for setting and printing argument values, update forecast data handling to use dictionaries, and enhance test coverage to validate these changes.

Enhancements:

Refactor set_output_values to use a mapping dictionary for setting argument values.
Refactor print_ocean_data and print_forecast to use mapping lists for printing data.
Update forecast_to_json to handle forecast data as a dictionary instead of a list.
Improve print_outputs function to handle ocean data dictionary more effectively.

Tests:

Add test_json_output to verify JSON output structure and data types.
Update test_forecast to validate the new dictionary-based forecast data structure.

github-actions[bot] commented 3 months ago

Coverage Report

File	Stmts	Miss	Cover	Missing
src
__init__.py	0	0	100%
api.py	119	7	94%	32–36, 54, 76–77, 109–110
art.py	9	3	67%	24–25, 28
cli.py	25	0	100%
dev_streamlit.py	37	37	0%	1–86
gpt.py	10	6	40%	16–21, 32–45
helper.py	124	38	69%	110, 121–125, 201–209, 221, 234–235, 266, 268–269, 292–293, 356–366, 373–381
send_email.py	24	24	0%	5–48
server.py	47	10	79%	55, 68–71, 87–91, 103–105
settings.py	22	0	100%
streamlit_helper.py	33	33	0%	5–90
TOTAL	450	158	65%

Tests	Skipped	Failures	Errors	Time
11	0 :zzz:	0 :x:	0 :fire:	21.077s :stopwatch:

sourcery-ai[bot] commented 3 months ago

Reviewer's Guide by Sourcery

This pull request focuses on refactoring the code for better readability, maintainability, and consistency. Key changes include updating docstrings, using dictionaries and lists for argument mappings, and modifying return types. Additionally, tests have been added and updated to validate the new implementations.

File-Level Changes

Files	Changes
`src/helper.py` `src/api.py`	Refactored functions to improve readability and maintainability by using dictionaries and lists for mappings, and updated return types for consistency.
`tests/test_helper.py` `tests/test_api.py`	Added and updated tests to validate the new implementations and ensure correctness of JSON output and forecast data.

Tips

- Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.

K-dash commented 3 months ago

@ryansurf I'll be reviewing it tonight, so hold on a bit!

ryansurf commented 3 months ago