refactor: add __str__ and __repr__ to data classes for better representation

Author: mariajgrimaldi

openedx_authz/api/data.py

@@ -172,7 +172,9 @@ def get_subclass_by_external_key(mcs, external_key: str) -> Type["ScopeData"]:
         scope_subclass = mcs.scope_registry.get(namespace)
 
         if not scope_subclass:
-            raise ValueError(f"Unknown scope: {namespace} for external_key: {external_key}")
+            raise ValueError(
+                f"Unknown scope: {namespace} for external_key: {external_key}"
+            )
 
         if not scope_subclass.validate_external_key(external_key):
             raise ValueError(f"Invalid external_key format: {external_key}")
@@ -261,6 +263,14 @@ def validate_external_key(cls, external_key: str) -> bool:
         except InvalidKeyError:
             return False
 
+    def __str__(self):
+        """Human readable string representation of the content library."""
+        return self.library_id
+
+    def __repr__(self):
+        """Developer friendly string representation of the content library."""
+        return self.namespaced_key
+
 
 class SubjectMeta(type):
     """Metaclass for SubjectData to handle dynamic subclass instantiation based on namespace."""
@@ -342,6 +352,14 @@ def username(self) -> str:
         """
         return self.external_key
 
+    def __str__(self):
+        """Human readable string representation of the user."""
+        return self.username
+
+    def __repr__(self):
+        """Developer friendly string representation of the user."""
+        return self.namespaced_key
+
 
 @define
 class ActionData(AuthZData):
@@ -365,9 +383,17 @@ def name(self) -> str:
         """
         return self.external_key.replace("_", " ").title()
 
+    def __str__(self):
+        """Human readable string representation of the action."""
+        return self.name
+
+    def __repr__(self):
+        """Developer friendly string representation of the action."""
+        return self.namespaced_key
+
 
 @define
-class PermissionData(AuthZData):
+class PermissionData:
     """A permission is an action that can be performed under certain conditions.
 
     Attributes:
@@ -377,6 +403,14 @@ class PermissionData(AuthZData):
     action: ActionData = None
     effect: Literal["allow", "deny"] = "allow"
 
+    def __str__(self):
+        """Human readable string representation of the permission and its effect."""
+        return f"{self.action} - {self.effect}"
+
+    def __repr__(self):
+        """Developer friendly string representation of the permission."""
+        return f"{self.action.namespaced_key} => {self.effect}"
+
 
 @define
 class RoleData(AuthZData):
@@ -402,9 +436,17 @@ def name(self) -> str:
         """
         return self.external_key.replace("_", " ").title()
 
+    def __str__(self):
+        """Human readable string representation of the role and its permissions."""
+        return f"{self.name}: {', '.join(str(p) for p in self.permissions)}"
+
+    def __repr__(self):
+        """Developer friendly string representation of the role."""
+        return self.namespaced_key
+
 
 @define
-class RoleAssignmentData(AuthZData):
+class RoleAssignmentData:
     """A role assignment is the assignment of a role to a subject in a specific scope.
 
     Attributes:
@@ -416,3 +458,13 @@ class RoleAssignmentData(AuthZData):
     subject: SubjectData = None  # Needs defaults to avoid value error from attrs
     roles: list[RoleData] = []
     scope: ScopeData = None
+
+    def __str__(self):
+        """Human readable string representation of the role assignment."""
+        role_names = ", ".join(role.name for role in self.roles)
+        return f"{self.subject} => {role_names} @ {self.scope}"
+
+    def __repr__(self):
+        """Developer friendly string representation of the role assignment."""
+        role_keys = ", ".join(role.namespaced_key for role in self.roles)
+        return f"{self.subject.namespaced_key} => [{role_keys}] @ {self.scope.namespaced_key}"

openedx_authz/api/permissions.py

@@ -5,7 +5,13 @@
 are not explicitly defined, but are inferred from the policy rules.
 """
 
-from openedx_authz.api.data import ActionData, PermissionData, PolicyIndex, ScopeData, SubjectData
+from openedx_authz.api.data import (
+    ActionData,
+    PermissionData,
+    PolicyIndex,
+    ScopeData,
+    SubjectData,
+)
 from openedx_authz.engine.enforcer import enforcer
 
 __all__ = [

openedx_authz/api/roles.py

@@ -300,10 +300,12 @@ def get_subject_role_assignments_in_scope(
         role_assignments.append(
             RoleAssignmentData(
                 subject=subject,
-                roles=[RoleData(
-                    namespaced_key=namespaced_key,
-                    permissions=get_permissions_for_single_role(role),
-                )],
+                roles=[
+                    RoleData(
+                        namespaced_key=namespaced_key,
+                        permissions=get_permissions_for_single_role(role),
+                    )
+                ],
                 scope=scope,
             )
         )
@@ -333,18 +335,22 @@ def get_subject_role_assignments_for_role_in_scope(
         role_assignments.append(
             RoleAssignmentData(
                 subject=SubjectData(namespaced_key=subject),
-                roles=[RoleData(
-                    namespaced_key=role.namespaced_key,
-                    permissions=get_permissions_for_single_role(role),
-                )],
+                roles=[
+                    RoleData(
+                        namespaced_key=role.namespaced_key,
+                        permissions=get_permissions_for_single_role(role),
+                    )
+                ],
                 scope=scope,
             )
         )
 
     return role_assignments
 
 
-def get_all_subject_role_assignments_in_scope(scope: ScopeData) -> list[RoleAssignmentData]:
+def get_all_subject_role_assignments_in_scope(
+    scope: ScopeData,
+) -> list[RoleAssignmentData]:
     """Get all the subjects assigned to any role in a specific scope.
 
     Args:

openedx_authz/api/users.py

@@ -9,7 +9,13 @@
 (e.g., 'user@john_doe').
 """
 
-from openedx_authz.api.data import ActionData, RoleAssignmentData, RoleData, ScopeData, UserData
+from openedx_authz.api.data import (
+    ActionData,
+    RoleAssignmentData,
+    RoleData,
+    ScopeData,
+    UserData,
+)
 from openedx_authz.api.permissions import is_subject_allowed
 from openedx_authz.api.roles import (
     assign_role_to_subject_in_scope,
@@ -52,7 +58,9 @@ def assign_role_to_user_in_scope(
     )
 
 
-def batch_assign_role_to_users_in_scope(users: list[str], role_external_key: str, scope_external_key: str):
+def batch_assign_role_to_users_in_scope(
+    users: list[str], role_external_key: str, scope_external_key: str
+):
     """Assign a role to multiple users in a specific scope.
 
     Args:
@@ -68,7 +76,9 @@ def batch_assign_role_to_users_in_scope(users: list[str], role_external_key: str
     )
 
 
-def unassign_role_from_user(user_external_key: str, role_external_key: str, scope_external_key: str):
+def unassign_role_from_user(
+    user_external_key: str, role_external_key: str, scope_external_key: str
+):
     """Unassign a role from a user in a specific scope.
 
     Args:
@@ -83,7 +93,9 @@ def unassign_role_from_user(user_external_key: str, role_external_key: str, scop
     )
 
 
-def batch_unassign_role_from_users(users: list[str], role_external_key: str, scope_external_key: str):
+def batch_unassign_role_from_users(
+    users: list[str], role_external_key: str, scope_external_key: str
+):
     """Unassign a role from multiple users in a specific scope.
 
     Args: