Refactor: Rename UserSession -> AlephClient

Author: hoh

examples/httpgateway.py

@@ -7,7 +7,7 @@
 
 from aleph.sdk.chains.common import get_fallback_private_key
 from aleph.sdk.chains.ethereum import ETHAccount
-from aleph.sdk.user_session import AuthenticatedUserSession
+from aleph.sdk.client import AuthenticatedAlephClient
 
 app = web.Application()
 routes = web.RouteTableDef()
@@ -32,7 +32,7 @@ async def source_post(request):
             return web.json_response(
                 {"status": "error", "message": "unauthorized secret"}
             )
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=app["account"], api_server="https://api2.aleph.im"
     ) as session:
         message, _status = await session.create_post(

examples/metrics.py

@@ -11,12 +11,9 @@
 from aleph_message.models import AlephMessage
 
 from aleph.sdk.chains.ethereum import get_fallback_account
+from aleph.sdk.client import AuthenticatedAlephClient, AuthenticatedUserSessionSync
 from aleph.sdk.conf import settings
 from aleph.sdk.types import MessageStatus
-from aleph.sdk.user_session import (
-    AuthenticatedUserSession,
-    AuthenticatedUserSessionSync,
-)
 
 
 def get_sysinfo():
@@ -73,7 +70,7 @@ def collect_metrics():
 
 def main():
     account = get_fallback_account()
-    with AuthenticatedUserSession(
+    with AuthenticatedAlephClient(
         account=account, api_server=settings.API_HOST
     ) as session:
         while True:

examples/mqtt.py

@@ -10,8 +10,8 @@
 
 from aleph.sdk.chains.common import get_fallback_private_key
 from aleph.sdk.chains.ethereum import ETHAccount
+from aleph.sdk.client import AuthenticatedAlephClient
 from aleph.sdk.conf import settings
-from aleph.sdk.user_session import AuthenticatedUserSession
 
 
 def get_input_data(value):
@@ -27,7 +27,7 @@ def get_input_data(value):
 
 
 def send_metrics(account, metrics):
-    with AuthenticatedUserSession(
+    with AuthenticatedAlephClient(
         account=account, api_server=settings.API_HOST
     ) as session:
         return session.create_aggregate(
@@ -100,7 +100,7 @@ async def gateway(
         if not userdata["received"]:
             await client.reconnect()
 
-        async with AuthenticatedUserSession(
+        async with AuthenticatedAlephClient(
             account=account, api_server=settings.API_HOST
         ) as session:
             for key, value in state.items():

examples/store.py

@@ -5,9 +5,9 @@
 
 from aleph.sdk.chains.common import get_fallback_private_key
 from aleph.sdk.chains.ethereum import ETHAccount
+from aleph.sdk.client import AuthenticatedAlephClient
 from aleph.sdk.conf import settings
 from aleph.sdk.types import MessageStatus
-from aleph.sdk.user_session import AuthenticatedUserSession
 
 DEFAULT_SERVER = "https://api2.aleph.im"
 
@@ -23,7 +23,7 @@ async def print_output_hash(message: StoreMessage, status: MessageStatus):
 
 
 async def do_upload(account, engine, channel, filename=None, file_hash=None):
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=account, api_server=settings.API_HOST
     ) as session:
         print(filename, account.get_address())

src/aleph/sdk/__init__.py

@@ -1,6 +1,6 @@
 from pkg_resources import DistributionNotFound, get_distribution
 
-from aleph.sdk.user_session import AuthenticatedUserSession, UserSession
+from aleph.sdk.client import AlephClient, AuthenticatedAlephClient
 
 try:
     # Change here if project is renamed and does not equal the package name
@@ -11,4 +11,4 @@
 finally:
     del get_distribution, DistributionNotFound
 
-__all__ = ["AuthenticatedUserSession", "UserSession"]
+__all__ = ["AlephClient", "AuthenticatedAlephClient"]

src/aleph/sdk/user_session.py renamed to src/aleph/sdk/client.py

@@ -71,7 +71,7 @@ def async_wrapper(f):
     Copies the docstring of wrapped functions.
     """
 
-    wrapped = getattr(AuthenticatedUserSession, f.__name__)
+    wrapped = getattr(AuthenticatedAlephClient, f.__name__)
     f.__doc__ = wrapped.__doc__
 
 
@@ -95,7 +95,7 @@ def func_caller(*args, **kwargs):
 async def run_async_watcher(
     *args, output_queue: queue.Queue, api_server: str, **kwargs
 ):
-    async with UserSession(api_server=api_server) as session:
+    async with AlephClient(api_server=api_server) as session:
         async for message in session.watch_messages(*args, **kwargs):
             output_queue.put(message)
 
@@ -122,7 +122,7 @@ class UserSessionSync:
     >>>     return self._wrap(self.async_session.func)(*args, **kwargs)
     """
 
-    def __init__(self, async_session: "UserSession"):
+    def __init__(self, async_session: "AlephClient"):
         self.async_session = async_session
 
     def _wrap(self, method: Callable[..., Awaitable[T]], *args, **kwargs):
@@ -272,9 +272,9 @@ def watch_messages(
 
 
 class AuthenticatedUserSessionSync(UserSessionSync):
-    async_session: "AuthenticatedUserSession"
+    async_session: "AuthenticatedAlephClient"
 
-    def __init__(self, async_session: "AuthenticatedUserSession"):
+    def __init__(self, async_session: "AuthenticatedAlephClient"):
         super().__init__(async_session=async_session)
 
     def ipfs_push(self, content: Mapping) -> str:
@@ -436,7 +436,7 @@ def submit(
         )
 
 
-class UserSession:
+class AlephClient:
     api_server: str
     http_session: aiohttp.ClientSession
 
@@ -455,7 +455,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         except RuntimeError:
             asyncio.run(close_fut)
 
-    async def __aenter__(self) -> "UserSession":
+    async def __aenter__(self) -> "AlephClient":
         return self
 
     async def __aexit__(self, exc_type, exc_val, exc_tb):
@@ -807,7 +807,7 @@ async def watch_messages(
                     break
 
 
-class AuthenticatedUserSession(UserSession):
+class AuthenticatedAlephClient(AlephClient):
     account: Account
 
     BROADCAST_MESSAGE_FIELDS = {
@@ -829,7 +829,7 @@ def __init__(self, account: Account, api_server: str):
     def __enter__(self) -> "AuthenticatedUserSessionSync":
         return AuthenticatedUserSessionSync(async_session=self)
 
-    async def __aenter__(self) -> "AuthenticatedUserSession":
+    async def __aenter__(self) -> "AuthenticatedAlephClient":
         return self
 
     async def ipfs_push(self, content: Mapping) -> str:

tests/integration/itest_aggregates.py

@@ -3,8 +3,8 @@
 
 import pytest
 
+from aleph.sdk.client import AuthenticatedAlephClient
 from aleph.sdk.types import Account
-from aleph.sdk.user_session import AuthenticatedUserSession
 from tests.integration.toolkit import try_until
 
 from .config import REFERENCE_NODE, TARGET_NODE
@@ -18,7 +18,7 @@ async def create_aggregate_on_target(
     receiver_node: str,
     channel="INTEGRATION_TESTS",
 ):
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=account, api_server=emitter_node
     ) as tx_session:
         aggregate_message, message_status = await tx_session.create_aggregate(
@@ -38,7 +38,7 @@ async def create_aggregate_on_target(
     assert aggregate_message.content.address == account.get_address()
     assert aggregate_message.content.content == content
 
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=account, api_server=receiver_node
     ) as rx_session:
         aggregate_from_receiver = await try_until(

tests/integration/itest_forget.py

@@ -2,8 +2,8 @@
 
 import pytest
 
+from aleph.sdk.client import AuthenticatedAlephClient
 from aleph.sdk.types import Account
-from aleph.sdk.user_session import AuthenticatedUserSession
 
 from .config import REFERENCE_NODE, TARGET_NODE, TEST_CHANNEL
 from .toolkit import try_until
@@ -17,7 +17,7 @@ async def wait_matching_posts(
         condition: Callable[[Dict], bool],
         timeout: int = 5,
     ):
-        async with AuthenticatedUserSession(
+        async with AuthenticatedAlephClient(
             account=account, api_server=receiver_node
         ) as rx_session:
             return await try_until(
@@ -27,7 +27,7 @@ async def wait_matching_posts(
                 hashes=[item_hash],
             )
 
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=account, api_server=emitter_node
     ) as tx_session:
         post_message, message_status = await tx_session.create_post(
@@ -46,7 +46,7 @@ async def wait_matching_posts(
 
     post_hash = post_message.item_hash
     reason = "This well thought-out content offends me!"
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=account, api_server=emitter_node
     ) as tx_session:
         forget_message, forget_status = await tx_session.forget(
@@ -103,7 +103,7 @@ async def test_forget_a_forget_message(fixture_account):
 
     # TODO: this test should be moved to the PyAleph API tests, once a framework is in place.
     post_hash = await create_and_forget_post(fixture_account, TARGET_NODE, TARGET_NODE)
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=fixture_account, api_server=TARGET_NODE
     ) as session:
         get_post_response = await session.get_posts(hashes=[post_hash])

tests/integration/itest_posts.py

@@ -1,7 +1,7 @@
 import pytest
 from aleph_message.models import MessagesResponse
 
-from aleph.sdk.user_session import AuthenticatedUserSession
+from aleph.sdk.client import AuthenticatedAlephClient
 from tests.integration.toolkit import try_until
 
 from .config import REFERENCE_NODE, TARGET_NODE
@@ -13,7 +13,7 @@ async def create_message_on_target(
     """
     Create a POST message on the target node, then fetch it from the reference node.
     """
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=fixture_account, api_server=emitter_node
     ) as tx_session:
         post_message, message_status = await tx_session.create_post(
@@ -25,7 +25,7 @@ async def create_message_on_target(
     def response_contains_messages(response: MessagesResponse) -> bool:
         return len(response.messages) > 0
 
-    async with AuthenticatedUserSession(
+    async with AuthenticatedAlephClient(
         account=fixture_account, api_server=receiver_node
     ) as rx_session:
         responses = await try_until(

tests/unit/test_asynchronous.py

@@ -10,14 +10,14 @@
     StoreMessage,
 )
 
+from aleph.sdk.client import AuthenticatedAlephClient
 from aleph.sdk.types import Account, MessageStatus, StorageEnum
-from aleph.sdk.user_session import AuthenticatedUserSession
 
 
 @pytest.fixture
 def mock_session_with_post_success(
     ethereum_account: Account,
-) -> AuthenticatedUserSession:
+) -> AuthenticatedAlephClient:
     class MockResponse:
         def __init__(self, sync: bool):
             self.sync = sync
@@ -48,12 +48,12 @@ async def text(self):
         sync=kwargs.get("sync", False)
     )
 
-    user_session = AuthenticatedUserSession(
+    client = AuthenticatedAlephClient(
         account=ethereum_account, api_server="http://localhost"
     )
-    user_session.http_session = http_session
+    client.http_session = http_session
 
-    return user_session
+    return client
 
 
 @pytest.mark.asyncio