__repr__ method (#147)

* `__repr__` method added for most objects(previously it was only
present for `FsNode`).
* `notifications.Notification` class has been rewritten in the same
format as all the others.

---------

Signed-off-by: Alexander Piskun <[email protected]>

Author: bigcat88

CHANGELOG.md

@@ -5,13 +5,18 @@ All notable changes to this project will be documented in this file.
 ## [0.4.0 - 2023-10-2x]
 
 As the project moves closer to `beta`, final unification changes are being made.
-This release contains some breaking changes in `users` API.
+This release contains some breaking changes in `users`, `notifications` API.
+
+### Added
+
+- `__repr__` method added for most objects(previously it was only present for `FsNode`).
 
 ### Changed
 
 - `users.get_details` renamed to `get_user` and returns a class instead of a dictionary. #145
 - Optional argument `displayname` in `users.create` renamed to `display_name`.
-- The `apps.ExAppInfo` class has been rewritten in the same format as all the others.
+- The `apps.ExAppInfo` class has been rewritten in the same format as all the others. #146
+- `notifications.Notification` class has been rewritten in the same format as all the others.
 
 ### Fixed
 

docs/reference/Users/Notifications.rst

@@ -6,6 +6,3 @@ Notifications
 
 .. autoclass:: nc_py_api.notifications.Notification
     :members:
-
-.. autoclass:: nc_py_api.notifications.NotificationInfo
-    :members:

nc_py_api/activity.py

@@ -36,6 +36,9 @@ def priority(self) -> int:
         """Arrangement priority in ascending order. Values from 0 to 99."""
         return self._raw_data["priority"]
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} id={self.filter_id}, name={self.name}, priority={self.priority}>"
+
 
 @dataclasses.dataclass
 class Activity:
@@ -122,10 +125,16 @@ def icon(self) -> str:
         return self._raw_data["icon"]
 
     @property
-    def activity_time(self) -> datetime.datetime:
+    def time(self) -> datetime.datetime:
         """Time when the activity occurred."""
         return nc_iso_time_to_datetime(self._raw_data["datetime"])
 
+    def __repr__(self):
+        return (
+            f"<{self.__class__.__name__} id={self.activity_id}, app={self.app}, type={self.activity_type},"
+            f" time={self.time}>"
+        )
+
 
 class _ActivityAPI:
     """The class provides the Activity Application API."""

nc_py_api/apps.py

@@ -47,6 +47,9 @@ def system(self) -> bool:
         """Flag indicating if the application is a system application."""
         return bool(self._raw_data["system"])
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} id={self.app_id}, ver={self.version}>"
+
 
 class _AppsAPI:
     """The class provides the application management API on the Nextcloud server."""

nc_py_api/files/__init__.py

@@ -265,6 +265,9 @@ def user_assignable(self) -> bool:
         """Flag indicating if User can assign this Tag."""
         return bool(self._raw_data.get("oc:user-assignable", "false").lower() == "true")
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} id={self.tag_id}, name={self.display_name}>"
+
 
 class ShareType(enum.IntEnum):
     """Type of the object that will receive share."""

nc_py_api/notes.py

@@ -73,6 +73,9 @@ def last_modified(self) -> datetime.datetime:
         modified = self._raw_data.get("modified", 0)
         return datetime.datetime.utcfromtimestamp(modified).replace(tzinfo=datetime.timezone.utc)
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} id={self.note_id}, title={self.title}, last_modified={self.last_modified}>"
+
 
 class NotesSettings(typing.TypedDict):
     """Settings of Notes App."""

nc_py_api/notifications.py

@@ -13,53 +13,68 @@
 from ._session import NcSessionApp, NcSessionBasic
 
 
-@dataclasses.dataclass
-class NotificationInfo:
-    """Extra Notification attributes from Nextcloud."""
-
-    app_name: str
-    """Application name that generated notification."""
-    user_id: str
-    """User name for which this notification is."""
-    time: datetime.datetime
-    """Time when the notification was created."""
-    subject: str
-    """Subject of the notification."""
-    message: str
-    """Message of the notification."""
-    link: str
-    """Link which will be opened when user clicks on notification."""
-    icon: str
-    """Relative to instance url of the icon image."""
-
-    def __init__(self, raw_info: dict):
-        self.app_name = raw_info["app"]
-        self.user_id = raw_info["user"]
-        self.time = nc_iso_time_to_datetime(raw_info["datetime"])
-        self.subject = raw_info["subject"]
-        self.message = raw_info["message"]
-        self.link = raw_info.get("link", "")
-        self.icon = raw_info.get("icon", "")
-
-
 @dataclasses.dataclass
 class Notification:
     """Class representing information about Nextcloud notification."""
 
-    notification_id: int
-    """ID of the notification."""
-    object_id: str
-    """Randomly generated unique object ID"""
-    object_type: str
-    """Currently not used."""
-    info: NotificationInfo
-    """Additional extra information for the object"""
-
-    def __init__(self, raw_info: dict):
-        self.notification_id = raw_info["notification_id"]
-        self.object_id = raw_info["object_id"]
-        self.object_type = raw_info["object_type"]
-        self.info = NotificationInfo(raw_info)
+    def __init__(self, raw_data: dict):
+        self._raw_data = raw_data
+
+    @property
+    def notification_id(self) -> int:
+        """ID of the notification."""
+        return self._raw_data["notification_id"]
+
+    @property
+    def object_id(self) -> str:
+        """Randomly generated unique object ID."""
+        return self._raw_data["object_id"]
+
+    @property
+    def object_type(self) -> str:
+        """Currently not used."""
+        return self._raw_data["object_type"]
+
+    @property
+    def app_name(self) -> str:
+        """Application name that generated notification."""
+        return self._raw_data["app"]
+
+    @property
+    def user_id(self) -> str:
+        """User ID of user for which this notification is."""
+        return self._raw_data["user"]
+
+    @property
+    def subject(self) -> str:
+        """Subject of the notification."""
+        return self._raw_data["subject"]
+
+    @property
+    def message(self) -> str:
+        """Message of the notification."""
+        return self._raw_data["message"]
+
+    @property
+    def time(self) -> datetime.datetime:
+        """Time when the notification was created."""
+        return nc_iso_time_to_datetime(self._raw_data["datetime"])
+
+    @property
+    def link(self) -> str:
+        """Link, which will be opened when user clicks on notification."""
+        return self._raw_data.get("link", "")
+
+    @property
+    def icon(self) -> str:
+        """Relative to instance url of the icon image."""
+        return self._raw_data.get("icon", "")
+
+    def __repr__(self):
+        return (
+            f"<{self.__class__.__name__} id={self.notification_id}, app_name={self.app_name}, user_id={self.user_id},"
+            f" time={self.time}>"
+        )
 
 
 class _NotificationsAPI:

nc_py_api/talk.py

@@ -1,6 +1,7 @@
 """Nextcloud Talk API definitions."""
 
 import dataclasses
+import datetime
 import enum
 import os
 import typing
@@ -280,6 +281,12 @@ def markdown(self) -> bool:
         """Whether the message should be rendered as markdown or shown as plain text."""
         return self._raw_data.get("markdown", False)
 
+    def __repr__(self):
+        return (
+            f"<{self.__class__.__name__} id={self.message_id}, author={self.actor_display_name},"
+            f" time={datetime.datetime.utcfromtimestamp(self.timestamp).replace(tzinfo=datetime.timezone.utc)}>"
+        )
+
 
 class TalkFileMessage(TalkMessage):
     """Subclass of Talk Message representing message-containing file."""
@@ -625,6 +632,12 @@ def status_clear_at(self) -> typing.Optional[int]:
         """
         return self._raw_data.get("statusClearAt", None)
 
+    def __repr__(self):
+        return (
+            f"<{self.__class__.__name__} id={self.conversation_id}, name={self.display_name},"
+            f" type={self.conversation_type.name}>"
+        )
+
 
 @dataclasses.dataclass(init=False)
 class Participant(_TalkUserStatus):
@@ -657,7 +670,7 @@ def participant_type(self) -> ParticipantType:
 
     @property
     def last_ping(self) -> int:
-        """Timestamp of the last ping. Should  be used for sorting."""
+        """Timestamp of the last ping. Should be used for sorting."""
         return self._raw_data["lastPing"]
 
     @property
@@ -685,6 +698,11 @@ def breakout_token(self) -> str:
         """Only available with breakout-rooms-v1 capability."""
         return self._raw_data.get("roomToken", "")
 
+    def __repr__(self):
+        return (
+            f"<{self.__class__.__name__} id={self.attendee_id}, name={self.display_name}, last_ping={self.last_ping}>"
+        )
+
 
 @dataclasses.dataclass
 class BotInfoBasic:
@@ -713,6 +731,9 @@ def state(self) -> int:
         """One of the Bot states: ``0`` - Disabled, ``1`` - enabled, ``2`` - **No setup**."""
         return self._raw_data["state"]
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} id={self.bot_id}, name={self.bot_name}>"
+
 
 @dataclasses.dataclass(init=False)
 class BotInfo(BotInfoBasic):
@@ -771,6 +792,9 @@ def option(self) -> int:
         """The option that was voted for."""
         return self._raw_data["optionId"]
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} actor={self.actor_display_name}, voted_for={self.option}>"
+
 
 @dataclasses.dataclass
 class Poll:
@@ -856,3 +880,6 @@ def num_voters(self) -> int:
     def details(self) -> list[PollDetail]:
         """Detailed list who voted for which option (only available for public closed polls)."""
         return [PollDetail(i) for i in self._raw_data.get("details", [])]
+
+    def __repr__(self):
+        return f"<{self.__class__.__name__} id={self.poll_id}, author={self.actor_display_name}>"

nc_py_api/talk_bot.py

@@ -77,6 +77,9 @@ def conversation_name(self) -> str:
         """The name of the conversation in which the message was posted."""
         return self._raw_data["target"]["name"]
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} conversation={self.conversation_name}, actor={self.actor_display_name}>"
+
 
 class TalkBot:
     """A class that implements the TalkBot functionality."""

nc_py_api/user_status.py

@@ -77,6 +77,9 @@ def status_type(self) -> str:
         """Status type, on of the: online, away, dnd, invisible, offline."""
         return self._raw_data.get("status", "")
 
+    def __repr__(self):
+        return f"<{self.__class__.__name__} user_id={self.user_id}, status_type={self.status_type}>"
+
 
 @dataclasses.dataclass(init=False)
 class CurrentUserStatus(UserStatus):
@@ -97,6 +100,12 @@ def status_type_defined(self) -> bool:
         """*True* if :py:attr:`UserStatus.status_type` is set by user, *False* otherwise."""
         return self._raw_data["statusIsUserDefined"]
 
+    def __repr__(self):
+        return (
+            f"<{self.__class__.__name__} user_id={self.user_id}, status_type={self.status_type},"
+            f" status_id={self.status_id}>"
+        )
+
 
 class _UserStatusAPI:
     """Class providing the user status management API on the Nextcloud server."""