feat: studio dataclass

For #413 and #408

Author: faretek1

scratchattach/site/studio.py

@@ -9,7 +9,7 @@
 from typing_extensions import Optional
 
 from . import user, comment, project, activity, session
-from scratchattach.site.typed_dicts import StudioDict
+from scratchattach.site.typed_dicts import StudioDict, StudioRoleDict
 from ._base import BaseSiteComponent
 from scratchattach.utils import exceptions, commons
 from scratchattach.utils.commons import api_iterative, headers
@@ -615,7 +615,7 @@ def accept_invite(self):
             timeout=10,
         ).json()
 
-    def your_role(self):
+    def your_role(self) -> StudioRoleDict:
         """
         Returns a dict with information about your role in the studio (whether you're following, curating, managing it or are invited)
         """

scratchattach/site/typed_dicts.py

@@ -118,3 +118,9 @@ class StudioDict(TypedDict):
     image: str
     history: StudioHistoryDict
     stats: NotRequired[StudioStatsDict]
+
+class StudioRoleDict(TypedDict):
+    manager: bool
+    curator: bool
+    invited: bool
+    following: bool

tests/test_studio.py

@@ -39,6 +39,10 @@ def test_studio():
     assert projs[0].title == "Sample remix"
     assert projs[1].title == "Sample project #1"
 
+    role = studio.your_role()
+    assert role["manager"]
+    assert role["following"]
+
     curator_names = [curator.name for curator in studio.managers()]
     assert "ScratchAttachV2" in curator_names
 
@@ -57,5 +61,6 @@ def test_studio():
     assert sa.search_studios(query="add everything!")
     assert sa.explore_studios(query="*")
 
+
 if __name__ == '__main__':
     test_studio()