From 7e11ddbbdd6ddfa28367c02d0a3a7f3932c369ae Mon Sep 17 00:00:00 2001
From: Munyoki Kilyungi
Date: Mon, 11 Mar 2024 23:58:35 +0300
Subject: Define Group using a frozen dataclass.

* gn_auth/auth/authorisation/data/genotypes.py: Import
dataclasses.asdict.
(link_genotype_data): Replace dictify with asdict.
* gn_auth/auth/authorisation/data/mrna.py: Import dataclasses.asdict.
(link_mrna_data): Replace dictify with asdict.
* gn_auth/auth/authorisation/data/phenotypes.py: Import
dataclasses.asdict.
(link_phenotype_data): Replace dictify with asdict.
* gn_auth/auth/authorisation/resources/groups/models.py: Import
dataclass.
(Group): Use frozen dataclass.
(Group.dictify): Delete.
(GroupRole.dictify): Replace dictify with asdict.
* gn_auth/auth/authorisation/resources/groups/views.py: Import
dataclasses.asdict.  Remove dictify import.
(list_groups): Replace dictify with asdict.
(create_group): Ditto.
* gn_auth/auth/authorisation/resources/views.py:
(resource_users): Replace dictify with asdict.
* gn_auth/auth/authorisation/users/views.py: Import
dataclasses.asdict.  Remove dictify import.
(user_details): Replace dictify with asdict.
(user_group): Ditto.

Signed-off-by: Munyoki Kilyungi <me@bonfacemunyoki.com>
---
 gn_auth/auth/authorisation/resources/groups/models.py | 13 +++++--------
 gn_auth/auth/authorisation/resources/groups/views.py  |  6 +++---
 2 files changed, 8 insertions(+), 11 deletions(-)

(limited to 'gn_auth/auth/authorisation/resources/groups')

diff --git a/gn_auth/auth/authorisation/resources/groups/models.py b/gn_auth/auth/authorisation/resources/groups/models.py
index 959389c..9a60df9 100644
--- a/gn_auth/auth/authorisation/resources/groups/models.py
+++ b/gn_auth/auth/authorisation/resources/groups/models.py
@@ -2,6 +2,7 @@
 import json
 from uuid import UUID, uuid4
 from functools import reduce
+from dataclasses import dataclass
 from typing import Any, Sequence, Iterable, Optional, NamedTuple
 
 from flask import g
@@ -21,18 +22,14 @@ from gn_auth.auth.authorisation.roles.models import (
     Role, create_role, check_user_editable, revoke_user_role_by_name,
     assign_user_role_by_name)
 
-class Group(NamedTuple):
+
+@dataclass(frozen=True)
+class Group:
     """Class representing a group."""
     group_id: UUID
     group_name: str
     group_metadata: dict[str, Any]
 
-    def dictify(self):
-        """Return a dict representation of `Group` objects."""
-        return {
-            "group_id": self.group_id, "group_name": self.group_name,
-            "group_metadata": self.group_metadata
-        }
 
 DUMMY_GROUP = Group(
     group_id=UUID("77cee65b-fe29-4383-ae41-3cb3b480cc70"),
@@ -50,8 +47,8 @@ class GroupRole(NamedTuple):
     def dictify(self) -> dict[str, Any]:
         """Return a dict representation of `GroupRole` objects."""
         return {
-            "group_role_id": self.group_role_id, "group": dictify(self.group),
             "role": dictify(self.role)
+            "group_role_id": self.group_role_id, "group": asdict(self.group),
         }
 
 class GroupCreationError(AuthorisationError):
diff --git a/gn_auth/auth/authorisation/resources/groups/views.py b/gn_auth/auth/authorisation/resources/groups/views.py
index 26534fc..b655a0f 100644
--- a/gn_auth/auth/authorisation/resources/groups/views.py
+++ b/gn_auth/auth/authorisation/resources/groups/views.py
@@ -6,13 +6,13 @@ import datetime
 from typing import Iterable
 from functools import partial
 
+from dataclasses import asdict
 from MySQLdb.cursors import DictCursor
 from flask import request, jsonify, Response, Blueprint, current_app
 
 from gn_auth.auth.db import sqlite3 as db
 from gn_auth.auth.db import mariadb as gn3db
 from gn_auth.auth.db.sqlite3 import with_db_connection
-from gn_auth.auth.dictify import dictify
 
 from gn_auth.auth.authorisation.roles.models import Role
 from gn_auth.auth.authorisation.roles.models import user_roles
@@ -42,7 +42,7 @@ def list_groups():
         the_groups = all_groups(conn)
 
     return jsonify(the_groups.maybe(
-        [], lambda grps: [dictify(grp) for grp in grps]))
+        [], lambda grps: [asdict(grp) for grp in grps]))
 
 @groups.route("/create", methods=["POST"])
 @require_oauth("profile group")
@@ -59,7 +59,7 @@ def create_group():
             new_group = _create_group(
                 conn, group_name, user, request.form.get("group_description"))
             return jsonify({
-                **dictify(new_group), "group_leader": asdict(user)
+                **asdict(new_group), "group_leader": asdict(user)
             })
 
 @groups.route("/members/<uuid:group_id>", methods=["GET"])
-- 
cgit v1.2.3