refactor(console): remove excessive comments

kouprlabs · Nov 14, 2024 · a838821 · a838821
1 parent 6470fb0
commit a838821
Show file tree

Hide file tree

Showing 28 changed files with 0 additions and 168 deletions.
diff --git a/console/api/database/group.py b/console/api/database/group.py
@@ -17,7 +17,6 @@
 from .generic import exists
 
 
-# --- FETCH --- #
 def fetch_group(_id: str) -> Dict:
     try:
         with conn.cursor() as curs:
@@ -102,8 +101,3 @@ def fetch_groups(page=1, size=10) -> Tuple[Iterable[Dict], int]:
 
     except DatabaseError as error:
         raise error
-
-
-# --- CREATE --- #
-
-# --- DELETE --- #
diff --git a/console/api/database/invitation.py b/console/api/database/invitation.py
@@ -17,7 +17,6 @@
 from ..errors import EmptyDataException, NotFoundException
 
 
-# --- FETCH --- #
 def fetch_invitation(_id: str) -> Dict | None:
     try:
         with conn.cursor() as curs:
@@ -84,7 +83,6 @@ def fetch_invitations(page=1, size=10) -> Tuple[Iterable[Dict], int]:
         raise error
 
 
-# --- UPDATE --- #
 def update_invitation(data: dict) -> None:
     try:
         data = {
@@ -95,33 +93,3 @@ def update_invitation(data: dict) -> None:
             curs.execute(parse_sql_update_query("invitation", data))
     except DatabaseError as error:
         raise error
-
-
-# def accept_invitation(data: dict):
-#     try:
-#         with conn.cursor() as curs:
-#             user = curs.execute(f'SELECT id FROM "user" WHERE email = \'{data.get('email')}\'').fetchone()
-#             if len(user) != 1:
-#                 ...
-#
-#             inv = fetch_invitation(_id=data.get('id'))
-#             if inv is None:
-#                 ...
-#
-#             if inv.get('status') != 'pending':
-#                 ...
-#
-#             update_invitation(data=data)
-#             curs.execute(f'INSERT INTO "organization_user" (organization_id, user_id) '
-#                          f'VALUES {inv.get("organization_id")}, {user.get("id")}')
-#
-#             curs.execute(f'INSERT INTO "userpermission" (id, user_id, resource_id, permission) '
-#                          f'VALUES ({}) ON CONFLICT (user_id, resource_id) '
-#                          f'DO UPDATE SET permission = ?')
-#
-#     except DatabaseError as error:
-#         raise error
-
-# --- CREATE --- #
-
-# --- DELETE --- #
diff --git a/console/api/database/organization.py b/console/api/database/organization.py
@@ -17,7 +17,6 @@
 from ..errors import EmptyDataException, NotFoundException
 
 
-# --- FETCH --- #
 def fetch_organization(organization_id: str) -> Dict:
     try:
         with conn.cursor() as curs:
@@ -171,8 +170,3 @@ def fetch_organization_groups(
             return data, count["count"]
     except DatabaseError as error:
         raise error
-
-
-# --- CREATE --- #
-
-# --- DELETE --- #
diff --git a/console/api/database/snapshot.py b/console/api/database/snapshot.py
@@ -17,7 +17,6 @@
 from ..errors import EmptyDataException, NotFoundException
 
 
-# --- FETCH --- #
 def fetch_snapshot(_id: str) -> Dict:
     try:
         with conn.cursor() as curs:
@@ -60,10 +59,3 @@ def fetch_snapshots(page=1, size=10) -> Tuple[Iterable[Dict], int]:
             return data, count["count"]
     except DatabaseError as error:
         raise error
-
-
-# --- UPDATE --- #
-
-# --- CREATE --- #
-
-# --- DELETE --- #
diff --git a/console/api/database/task.py b/console/api/database/task.py
@@ -17,7 +17,6 @@
 from ..errors import EmptyDataException, NotFoundException
 
 
-# --- FETCH --- #
 def fetch_task(_id: str) -> Dict:
     try:
         with conn.cursor() as curs:
@@ -58,10 +57,3 @@ def fetch_tasks(page=1, size=10) -> Tuple[Iterable[Dict], int]:
             return data, count["count"]
     except DatabaseError as error:
         raise error
-
-
-# --- UPDATE --- #
-
-# --- CREATE --- #
-
-# --- DELETE --- #
diff --git a/console/api/database/user.py b/console/api/database/user.py
@@ -17,9 +17,6 @@
 from ..errors import EmptyDataException, NotFoundException
 
 
-# --- FETCH --- #
-
-
 def fetch_user_organizations(
     user_id: str, page=1, size=10
 ) -> Tuple[Iterable[Dict], int]:
@@ -141,10 +138,3 @@ def fetch_user_groups(user_id: str, page=1, size=10) -> Tuple[Iterable[Dict], in
             return data, count["count"]
     except DatabaseError as error:
         raise error
-
-
-# --- UPDATE --- #
-
-# --- CREATE --- #
-
-# --- DELETE --- #
diff --git a/console/api/database/workspace.py b/console/api/database/workspace.py
@@ -17,7 +17,6 @@
 from ..errors import EmptyDataException, NotFoundException
 
 
-# --- FETCH --- #
 def fetch_workspace(_id: str) -> Dict:
     try:
         with conn.cursor() as curs:
@@ -107,8 +106,3 @@ def fetch_workspaces(page=1, size=10) -> Tuple[Iterable[Dict], int]:
 
     except DatabaseError as error:
         raise error
-
-
-# --- CREATE --- #
-
-# --- DELETE --- #
diff --git a/console/api/errors/api_errors.py b/console/api/errors/api_errors.py
@@ -13,17 +13,13 @@
 from .error_codes import errors
 
 
-# --- REQUIRED FOR AUTHORIZATION --- #
 class GenericForbiddenException(HTTPException):
     def __init__(
         self, status_code: int = status.HTTP_403_FORBIDDEN, detail="Forbidden"
     ):
         super().__init__(status_code=status_code, detail=detail)
 
 
-# /--- REQUIRED FOR AUTHORIZATION ---/ #
-
-
 class GenericError(JSONResponse):
     def __init__(
         self,

diff --git a/console/api/models/generic.py b/console/api/models/generic.py
@@ -15,17 +15,9 @@
 from pydantic import BaseModel, Field
 
 
-# --- REQUEST MODELS --- #
 class GenericRequest(BaseModel):
     id: str = Field(...)
 
-    # @model_validator(mode='after')
-    # def not_null(self) -> Self:
-    #     if not any(self.model_dump(exclude={'id'}).values()):
-    #         raise ValueError('At lease one value must be set!')
-    #
-    #     return self
-
 
 class GenericPaginationRequest(BaseModel):
     page: int | None = Field(default=1)
@@ -36,7 +28,6 @@ class GenericSearchRequest(GenericPaginationRequest):
     query: str | None = Field("")
 
 
-# --- RESPONSE MODELS --- #
 class GenericResponse(BaseModel):
     id: str
 
@@ -85,7 +76,6 @@ class GenericAcceptedResponse(BaseModel):
     pass
 
 
-# --- TOKEN SPECIFIC --- #
 class GenericTokenPayload(BaseModel):
     sub: str
     iat: datetime.datetime

diff --git a/console/api/models/group.py b/console/api/models/group.py
@@ -23,7 +23,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class GroupRequest(GenericRequest):
     pass
 
@@ -36,7 +35,6 @@ class GroupSearchRequest(GenericSearchRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class GroupResponse(GenericResponse):
     name: str
     organization: OrganizationResponse

diff --git a/console/api/models/grouppermission.py b/console/api/models/grouppermission.py
@@ -19,7 +19,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class GroupPermissionRequest(GenericRequest):
     pass
 
@@ -28,7 +27,6 @@ class GroupPermissionListRequest(GenericPaginationRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class GroupPermissionResponse(GenericResponse):
     group_id: str
     user_id: str

diff --git a/console/api/models/groupuser.py b/console/api/models/groupuser.py
@@ -19,7 +19,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class UserGroupRequest(GenericRequest):
     pass
 
@@ -28,7 +27,6 @@ class UserGroupListRequest(GenericPaginationRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class UserGroupResponse(GenericResponse):
     group_id: str
     user_id: str

diff --git a/console/api/models/invitation.py b/console/api/models/invitation.py
@@ -22,7 +22,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class InvitationRequest(GenericRequest):
     pass
 
@@ -36,7 +35,6 @@ class ConfirmInvitationRequest(GenericRequest):
     updateTime: datetime.datetime | None = Field(default_factory=datetime.datetime.now)
 
 
-# --- RESPONSE MODELS --- #
 class InvitationResponse(GenericResponse):
     organization: OrganizationResponse
     ownerId: str

diff --git a/console/api/models/organization.py b/console/api/models/organization.py
@@ -22,7 +22,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class OrganizationRequest(GenericRequest):
     pass
 
@@ -47,7 +46,6 @@ class OrganizationGroupListRequest(GenericRequest, GenericPaginationRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class OrganizationResponse(GenericResponse):
     name: str
     createTime: datetime.datetime = Field(None)

diff --git a/console/api/models/overview.py b/console/api/models/overview.py
@@ -15,12 +15,10 @@
 from . import GenericListResponse, GenericRequest
 
 
-# --- REQUEST MODELS --- #
 class VersionRequest(GenericRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class VersionResponse(BaseModel):
     name: str
     currentVersion: str

diff --git a/console/api/models/snapshot.py b/console/api/models/snapshot.py
@@ -19,7 +19,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class SnapshotRequest(GenericRequest):
     pass
 
@@ -28,7 +27,6 @@ class SnapshotListRequest(GenericPaginationRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class SnapshotResponse(GenericResponse):
     version: str
     original: dict

diff --git a/console/api/models/snapshotfile.py b/console/api/models/snapshotfile.py
@@ -19,7 +19,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class SnapshotFileRequest(GenericRequest):
     pass
 
@@ -28,7 +27,6 @@ class SnapshotFileListRequest(GenericPaginationRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class SnapshotFileResponse(GenericResponse):
     snapshot_id: str
     file_id: str

diff --git a/console/api/models/task.py b/console/api/models/task.py
@@ -19,7 +19,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class TaskRequest(GenericRequest):
     pass
 
@@ -28,7 +27,6 @@ class TaskListRequest(GenericPaginationRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class TaskResponse(GenericResponse):
     name: str
     error: str

diff --git a/console/api/models/user.py b/console/api/models/user.py
@@ -21,7 +21,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class UserRequest(GenericRequest):
     pass
 
@@ -54,7 +53,6 @@ class UserGroupListRequest(UserGroupRequest, GenericPaginationRequest):
     pass
 
 
-# --- RESPONSE MODELS --- #
 class UserResponse(GenericResponse):
     fullName: str
     username: str

diff --git a/console/api/models/userpermission.py b/console/api/models/userpermission.py
@@ -21,7 +21,6 @@
 )
 
 
-# --- REQUEST MODELS --- #
 class UserPermissionRequest(GenericRequest):
     pass
 
@@ -43,7 +42,6 @@ class UserPermissionRevokeRequest(BaseModel):
     resourceType: Literal["file", "group", "organization", "workspace"]
 
 
-# --- RESPONSE MODELS --- #
 class UserPermissionResponse(GenericResponse):
     user_id: str
     resource_id: str