Make API typesafe #7
Open
Conversation
This file contains hidden or 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
Makes the pycolonies API statically typed. All functions now return statically typed Python objects instead of JSON objects. This makes it easier for the user to know what type of data the API functions return. This PR adds classes to model.py, according to the colonies RPC schema, that are then used in pycolonies.py. Also, this PR fixes all pyright errors.
segeljakt
force-pushed
the
klas/typesafe-api
branch
from
5faf551 to
8534722
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
With this change, API functions are now statically typed. This should make it easier for the user to see what types of data the API functions take as input and produce as output. Note that this is a breaking change, since it requires changing the functions so that they return Python objects (e.g.,
Process,Colony,Executor), instead of JSON.Also, this PR fixes all pyright errors and some inconsistencies I found in the API versus what the latest version of Colonies expects.