Comparison of off-/online mentions works

Author: FlorianWilhelm

CHANGELOG.md

@@ -19,6 +19,7 @@
 - Fix: Uploading a file via an import URL was cast to a `None` instead of `FileImportSuccess`.
 - Chg: Return `FileUploadStatus` in `UploadedFile.file_import_result` for easier usage.
 - Fix: All objects are no longer `hash`able as they are mutable and thus the former behaviour was semantically incorrect.
+- Fix: Comparison of off-/online `MentionObject`s works, also when `UserRef` is used.
 
 ## Version 0.9.5, 2025-10-24
 

src/ultimate_notion/markdown.py

@@ -134,17 +134,17 @@ def is_math(rt: RichTextBase) -> TypeGuard[Math]:
             return rt.is_equation
 
         for idx, text in enumerate(rich_texts):
+            plain_text = text.obj_ref.plain_text
             if is_math(text):
-                md_rich_texts[idx] = '$' + text.obj_ref.plain_text.strip() + '$'
+                md_rich_texts[idx] = '$' + plain_text.strip() + '$'
             elif is_mention(text):
-                obj_ref = text.obj_ref
                 match text.type:
                     case 'user' | 'date':
-                        md_rich_texts[idx] = f'[{obj_ref.plain_text}]()'  # @ is already included
+                        md_rich_texts[idx] = f'[{plain_text}]()'  # @ is already included
                     case 'custom_emoji':
-                        md_rich_texts[idx] = f'{obj_ref.plain_text}'  # parentheses are already included
+                        md_rich_texts[idx] = f'{plain_text}'  # parentheses are already included
                     case _:
-                        md_rich_texts[idx] = f'↗[{obj_ref.plain_text}]({obj_ref.href})'
+                        md_rich_texts[idx] = f'↗[{plain_text}]({text.obj_ref.href})'
 
     def find_span(
         rich_texts: list[RichTextBase], style_cond: Callable[[RichTextBase], bool]

src/ultimate_notion/obj_api/core.py

@@ -255,6 +255,10 @@ def _recurse(obj: Any) -> Any:
                     setattr(obj_copy, field_name, Unset)
                 elif field_name == 'color' and is_unset(field_value):
                     setattr(obj_copy, field_name, _normalize_color(field_value))
+                elif isinstance(obj, TypedObject) and obj.type == 'mention' and field_name == 'plain_text':
+                    setattr(
+                        obj_copy, field_name, Unset
+                    )  # allows comparing offline-built mentions with UserRef to online ones
                 else:
                     setattr(obj_copy, field_name, _recurse(field_value))
             return obj_copy

src/ultimate_notion/obj_api/objects.py

@@ -379,13 +379,14 @@ class MentionUser(MentionBase[User | UserRef], type='user'):
     user: SerializeAsAny[User | UserRef]
 
     @classmethod
-    def build_mention_from(cls, user: User, *, style: Annotations | None = None) -> MentionObject:
+    def build_mention_from(cls, user: User | UserRef, *, style: Annotations | None = None) -> MentionObject:
         # When creating a user mention, we need to send only the id, not the full object.
-        user_ref = UserRef.build(user)
+        user_ref = UserRef.build(user) if isinstance(user, User) else user
         mention = cls.model_construct(user=user_ref)
         # note that `href` is always `None` for user mentions, also we prepend the '@' to mimic server side
         return MentionObject.model_construct(
-            plain_text=f'@{user.name}',
+            # Note that in case of UserRef, we set an dummy name that will be replaced by the Notion server later.
+            plain_text=f'@{user.name}' if isinstance(user, User) else f'@{user_ref.id}',
             href=None,
             annotations=Unset if style is None else deepcopy(style),
             mention=mention,

src/ultimate_notion/rich_text.py

@@ -239,7 +239,7 @@ def rich_texts(self) -> tuple[RichTextBase, ...]:
     def wrap_obj_ref(cls, obj_refs: list[objs.RichTextBaseObject] | None) -> Self:
         obj_refs = [] if obj_refs is None else obj_refs
         rich_texts = [RichTextBase.wrap_obj_ref(obj_ref) for obj_ref in obj_refs]
-        plain_text = ''.join(text.obj_ref.plain_text for text in rich_texts if text)
+        plain_text = ''.join(text.obj_ref.plain_text for text in rich_texts if isinstance(text.obj_ref.plain_text, str))
         obj = cls(plain_text)
         obj._rich_texts = cls._compact(rich_texts)
         return obj