Skip to content

Add doctests and improve error handling for world_covid19_stats function #11643

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

Add doctests and improve error handling for world_covid19_stats function #11643

wants to merge 4 commits into from

Conversation

whyvineet
Copy link
Contributor

  • Added doctests to validate the output of the world_covid19_stats function.
  • Improved error handling for HTTP request failures and mismatched key-value pairs.
  • Ensured that the function raises exceptions for non-200 status codes and data extraction issues.

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes Improve our test coverage #9943".

@whyvineet
Add doctests and improve error handling for world_covid19_stats function
94348a2 
- Added doctests to validate the output of the world_covid19_stats function.
- Improved error handling for HTTP request failures and mismatched key-value pairs.
- Ensured that the function raises exceptions for non-200 status codes and data extraction issues.
@whyvineet whyvineet requested a review from cclauss as a code owner October 1, 2024 18:33
@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Oct 1, 2024
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 1, 2024
whyvineet and others added 2 commits October 1, 2024 18:48
@whyvineet
Refactor world_covid19_stats function
0b5143b 
- Updated error handling to assign error message to a variable before raising an exception.
- Changed the return statement to use dict() constructor instead of dictionary comprehension for creating the results dictionary.
- Ensured that doctests in the docstring validate function output and behavior.
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
4a89a5d 
for more information, see https://pre-commit.ci
@whyvineet whyvineet closed this by deleting the head repository Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cclauss cclauss Awaiting requested review from cclauss cclauss is a code owner

Assignees

No one assigned

Labels

awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files tests are failing Do not merge until tests pass

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve our test coverage

1 participant

@whyvineet