Feature: full API refactoring #2
Merged
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
odesenfans
force-pushed
the
od-user-session-class
branch
3 times, most recently
from
1adf3f3 to
0c14af5
Compare
odesenfans
changed the title
odesenfans
force-pushed
the
od-user-session-class
branch
from
0c14af5 to
e6fcd51
Compare
hoh
previously approved these changes
Jan 25, 2023
Problem: we often pass 2-3 objects to each function that represent information on how to connect to the Aleph network: * the user account * the API server URL * the aiohttp session. This can be simplified to improve the user experience and reduce the complexity of the SDK. Solution: introduce a new state class: `UserSession`. This object is now passed as the first parameter of every public function. It is initialized with the user account and the API server URL. It is in charge of configuring and managing the aiohttp session object. The typical usage of the library now looks like this: ``` account = load_my_account() api_server = "https://aleph.cloud" # example async with UserSession(account=account, api_server=api_server) as session: message, status = await create_post( session=session, ... ) ``` This enables the following improvements: * Less clutter in function signatures: all public SDK functions now have 1 or 2 fewer arguments. * The API server URL is now managed when initializing the aiohttp session inside the user session object. Implementations can simply specify the endpoint URL. Ex: `f"{api_server}/api/v0/messages.json` can now be expressed as `"/api/v0/messages.json"`. Breaking changes: * The signatures of all public functions of the SDK have been modified. The user must now initialize the user session object and pass it as parameter.
hoh
force-pushed
the
od-user-session-class
branch
3 times, most recently
from
3fa7a48 to
1674024
Compare
The session classes now provide all the SDK functionalities.
The `synchronous` and `asynchronous` modules are removed in
favor of the `UserSession` and `AuthenticatedUserSession` classes.
`UserSession` is intended as a read-only session to access public
API endpoints, while `AuthenticatedUserSession` requires a chain
account and allows the user to post messages to the Aleph network.
Example usage:
```
from aleph_client import AuthenticatedUserSession
async def post_message():
async with AuthenticatedUserSession(
account=fixture_account, api_server=emitter_node
) as session:
post_message, message_status = await session.create_post(
post_content={"Hello": "World"},
)
```
Both classes provide a synchronous context manager and an equivalent
sync class for non-async code.
Breaking changes:
- Everything: the SDK API is entirely modified.
hoh
force-pushed
the
od-user-session-class
branch
from
1674024 to
fac3158
Compare
hoh
approved these changes
Jan 25, 2023
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.
The session classes now provide all the SDK functionalities.
The
synchronousandasynchronousmodules are removed infavor of the
UserSessionandAuthenticatedUserSessionclasses.UserSessionis intended as a read-only session to access publicAPI endpoints, while
AuthenticatedUserSessionrequires a chainaccount and allows the user to post messages to the Aleph network.
Example usage:
Both classes provide a synchronous context manager and an equivalent
sync class for non-async code.
Breaking changes: