commit suggestions; add Post type for get_posts() response

Author: MHHukiewitz

src/aleph/sdk/base.py

@@ -32,7 +32,7 @@
 DEFAULT_PAGE_SIZE = 200
 
 
-class AlephClientBase(ABC):
+class BaseAlephClient(ABC):
     @abstractmethod
     async def fetch_aggregate(
         self,
@@ -127,10 +127,9 @@ async def get_posts_iterator(
         :param start_date: Earliest date to fetch messages from
         :param end_date: Latest date to fetch messages from
         """
-        total_items = None
-        per_page = DEFAULT_PAGE_SIZE
         page = 1
-        while total_items is None or page * per_page < total_items:
+        resp = None
+        while resp is None or len(resp.posts) > 0:
             resp = await self.get_posts(
                 page=page,
                 types=types,
@@ -143,7 +142,6 @@ async def get_posts_iterator(
                 start_date=start_date,
                 end_date=end_date,
             )
-            total_items = resp.pagination_total
             page += 1
             for post in resp.posts:
                 yield post
@@ -232,10 +230,9 @@ async def get_messages_iterator(
         :param start_date: Earliest date to fetch messages from
         :param end_date: Latest date to fetch messages from
         """
-        total_items = None
-        per_page = DEFAULT_PAGE_SIZE
         page = 1
-        while total_items is None or page * per_page < total_items:
+        resp = None
+        while resp is None or len(resp.messages) > 0:
             resp = await self.get_messages(
                 page=page,
                 message_type=message_type,
@@ -250,7 +247,6 @@ async def get_messages_iterator(
                 start_date=start_date,
                 end_date=end_date,
             )
-            total_items = resp.pagination_total
             page += 1
             for message in resp.messages:
                 yield message
@@ -304,7 +300,7 @@ def watch_messages(
         pass
 
 
-class AuthenticatedAlephClientBase(AlephClientBase):
+class BaseAuthenticatedAlephClient(BaseAlephClient):
     @abstractmethod
     async def create_post(
         self,

src/aleph/sdk/client.py

@@ -52,7 +52,7 @@
 from aleph.sdk.types import Account, GenericMessage, StorageEnum
 from aleph.sdk.utils import Writable, copy_async_readable_to_buffer
 
-from .base import AlephClientBase, AuthenticatedAlephClientBase
+from .base import BaseAlephClient, BaseAuthenticatedAlephClient
 from .conf import settings
 from .exceptions import (
     BroadcastError,
@@ -61,7 +61,7 @@
     MessageNotFoundError,
     MultipleMessagesError,
 )
-from .models import MessagesResponse, PostsResponse
+from .models import MessagesResponse, PostsResponse, Post
 from .utils import check_unix_socket_valid, get_message_type_value
 
 logger = logging.getLogger(__name__)
@@ -471,7 +471,7 @@ def submit(
         )
 
 
-class AlephClient(AlephClientBase):
+class AlephClient(BaseAlephClient):
     api_server: str
     http_session: aiohttp.ClientSession
 
@@ -620,26 +620,15 @@ async def get_posts(
             response_json = await resp.json()
             posts_raw = response_json["posts"]
 
-            # All posts may not be valid according to the latest specification in
-            # aleph-message. This allows the user to specify how errors should be handled.
-            posts: List[AlephMessage] = []
+            posts: List[Post] = []
             for post_raw in posts_raw:
                 try:
-                    message = parse_message(post_raw)
-                    posts.append(message)
-                except KeyError as e:
-                    if not ignore_invalid_messages:
-                        raise e
-                    logger.log(
-                        level=invalid_messages_log_level,
-                        msg=f"KeyError: Field '{e.args[0]}' not found",
-                    )
+                    posts.append(Post.parse_obj(post_raw))
                 except ValidationError as e:
                     if not ignore_invalid_messages:
                         raise e
                     if invalid_messages_log_level:
                         logger.log(level=invalid_messages_log_level, msg=e)
-
             return PostsResponse(
                 posts=posts,
                 pagination_page=response_json["pagination_page"],
@@ -919,7 +908,7 @@ async def watch_messages(
                     break
 
 
-class AuthenticatedAlephClient(AlephClient, AuthenticatedAlephClientBase):
+class AuthenticatedAlephClient(AlephClient, BaseAuthenticatedAlephClient):
     account: Account
 
     BROADCAST_MESSAGE_FIELDS = {

src/aleph/sdk/models.py

@@ -1,7 +1,7 @@
-from typing import List
+from typing import List, Optional, Any, Dict, Union
 
-from aleph_message.models import AlephMessage, PostMessage
-from pydantic import BaseModel
+from aleph_message.models import AlephMessage, BaseMessage, ItemHash, ChainRef
+from pydantic import BaseModel, Field
 
 
 class PaginationResponse(BaseModel):
@@ -18,8 +18,25 @@ class MessagesResponse(PaginationResponse):
     pagination_item = "messages"
 
 
+class Post(BaseMessage):
+    """
+    A post is a type of message that can be updated. Over the get_posts API
+    we get the latest version of a post.
+    """
+    hash: ItemHash = Field(description="Hash of the content (sha256 by default)")
+    original_item_hash: ItemHash = Field(description="Hash of the original content (sha256 by default)")
+    original_signature: Optional[str] = Field(
+        description="Cryptographic signature of the original message by the sender"
+    )
+    original_type: str = Field(description="The original, user-generated 'content-type' of the POST message")
+    content: Dict[str, Any] = Field(description="The content.content of the POST message")
+    type: str = Field(description="The content.type of the POST message")
+    address: str = Field(description="The address of the sender of the POST message")
+    ref: Optional[Union[str, ChainRef]] = Field(description="Other message referenced by this one")
+
+
 class PostsResponse(PaginationResponse):
     """Response from an Aleph node API on the path /api/v0/posts.json"""
 
-    posts: List[PostMessage]
+    posts: List[Post]
     pagination_item = "posts"

tests/unit/test_asynchronous_get.py

@@ -7,6 +7,7 @@
 
 from aleph.sdk.client import AlephClient
 from aleph.sdk.conf import settings
+from aleph.sdk.models import PostsResponse
 
 
 def make_mock_session(get_return_value: Dict[str, Any]) -> AlephClient:
@@ -66,14 +67,10 @@ async def test_fetch_aggregates():
 @pytest.mark.asyncio
 async def test_get_posts():
     async with AlephClient(api_server=settings.API_HOST) as session:
-        response: MessagesResponse = await session.get_messages(
-            message_type=MessageType.post,
-        )
+        response: PostsResponse = await session.get_posts()
 
-        messages = response.messages
-        assert len(messages) > 1
-        for message in messages:
-            assert message.type == MessageType.post
+        posts = response.posts
+        assert len(posts) > 1
 
 
 @pytest.mark.asyncio

tests/unit/test_synchronous_get.py

@@ -4,7 +4,7 @@
 from aleph.sdk.conf import settings
 
 
-def test_get_posts():
+def test_get_post_messages():
     with AlephClient(api_server=settings.API_HOST) as session:
         response: MessagesResponse = session.get_messages(
             pagination=2,