Add custom error handling for API errors #205
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds minimal structure within a new client folder
Adds: - A Node dataclass which models an individual node (with dcid, name, etc) - A NodeGroup dataclass which represents a list of Node objects - An Arcs dataclass, which represents arcs (with a label and containing NodeGroups) - A Properties dataclass which represents a list of Properties
Adds: - An Observation dataclass which models an individual observation (date, value) - An OrderedFacets dataclass which models the 'ordered facets' of observations - A Variable dataclass which represents a variable data (grouped by entity) - A Facet class which represents the metadata for a facet
Adds: - A candidate dataclass to model candidates in the response (with dcid and dominanType) - An Entity dataclass to model entities with their resolution candidates
Adds: - A Cell dataclass to model a single cell in a row - A Row modelling a row with cells.
Adds tests for node, observation, resolve and sparql models.
DCResponse just wraps around the api response
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
jm-rivera
changed the title
This was referenced Dec 6, 2024
dwnoble
reviewed
Dec 20, 2024
| @@ -0,0 +1,78 @@ | |||
| from typing import Optional | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note:
First PR in the stack: #202
Second PR in the stack: #203
Previous PR in the stack: #204
Next PR in the stack: #206
Will manually rebase as PRs in the stack are merged to make it easier to review the changes introduced in this PR.
This PR implements custom error handling for API errors. It also includes the related tests.
A bit unrelated but for housekeeping, the imports throughout the module are now passed through
isortwith Google profile for consistent ordering.Error Handling:
datacommons_client/utils/error_hanlding.py: Introduced new error handling classes (DataCommonsError,APIError,DCConnectionError,DCStatusError,DCAuthenticationError,InvalidDCInstanceError).datacommons_client/tests/utils/test_error_handling.py: Added tests for the different error classes.