Small fixes

* Redundant rule in pyproject.toml
* "Raises" docstrings

Author: ivan-borovets

pyproject.toml

@@ -174,7 +174,6 @@ split-on-trailing-comma = true
     "S107", # hardcoded-password-default
 ]
 #
-"src/app/domain/value_objects/base.py" = ["B024", ]                       # abstract-base-class-without-abstract-method
 "src/app/infrastructure/adapters/password_hasher_bcrypt.py" = ["E501", ]  # line-too-long
 "src/app/infrastructure/auth/session/constants.py" = ["S105", ]           # hardcoded-password-string
 "src/app/presentation/http/auth/constants.py" = ["S105", ]                # hardcoded-password-string

src/app/application/common/ports/access_revoker.py

@@ -7,6 +7,4 @@
 class AccessRevoker(Protocol):
     @abstractmethod
     async def remove_all_user_access(self, user_id: UserId) -> None:
-        """
-        :raises DataMapperError:
-        """
+        """:raises DataMapperError:"""

src/app/application/common/ports/flusher.py

@@ -10,8 +10,8 @@ class Flusher(Protocol):
     @abstractmethod
     async def flush(self) -> None:
         """
-        Flush pending changes to validate constraints or trigger side effects.
-
         :raises DataMapperError:
         :raises UsernameAlreadyExists:
+
+        Flush pending changes to validate constraints or trigger side effects.
         """

src/app/application/common/ports/identity_provider.py

@@ -7,6 +7,4 @@
 class IdentityProvider(Protocol):
     @abstractmethod
     async def get_current_user_id(self) -> UserId:
-        """
-        :raises AuthenticationError:
-        """
+        """:raises AuthenticationError:"""

src/app/application/common/ports/transaction_manager.py

@@ -12,7 +12,7 @@ class TransactionManager(Protocol):
     @abstractmethod
     async def commit(self) -> None:
         """
-        Commit the successful outcome of a business transaction.
-
         :raises DataMapperError:
+
+        Commit the successful outcome of a business transaction.
         """

src/app/application/common/ports/user_command_gateway.py

@@ -9,22 +9,16 @@
 class UserCommandGateway(Protocol):
     @abstractmethod
     def add(self, user: User) -> None:
-        """
-        :raises DataMapperError:
-        """
+        """:raises DataMapperError:"""
 
     @abstractmethod
     async def read_by_id(self, user_id: UserId) -> User | None:
-        """
-        :raises DataMapperError:
-        """
+        """:raises DataMapperError:"""
 
     @abstractmethod
     async def read_by_username(
         self,
         username: Username,
         for_update: bool = False,
     ) -> User | None:
-        """
-        :raises DataMapperError:
-        """
+        """:raises DataMapperError:"""

src/app/application/common/ports/user_query_gateway.py

@@ -11,6 +11,4 @@ async def read_all(
         self,
         user_read_all_params: UserListParams,
     ) -> list[UserQueryModel] | None:
-        """
-        :raises ReaderError:
-        """
+        """:raises ReaderError:"""

src/app/application/common/query_params/pagination.py

@@ -13,6 +13,7 @@ class Pagination:
     offset: int
 
     def __post_init__(self):
+        """:raises PaginationError:"""
         if self.limit <= 0:
             raise PaginationError(f"Limit must be greater than 0, got {self.limit}")
         if self.offset < 0:

src/app/application/common/services/authorization/authorize.py

@@ -11,8 +11,6 @@ def authorize[PC: PermissionContext](
     *,
     context: PC,
 ) -> None:
-    """
-    :raises AuthorizationError:
-    """
+    """:raises AuthorizationError:"""
     if not permission.is_satisfied_by(context):
         raise AuthorizationError(AUTHZ_NOT_AUTHORIZED)

src/app/domain/entities/base.py

@@ -11,6 +11,8 @@
 @dataclass(eq=False)
 class Entity[T: ValueObject](ABC):
     """
+    raises DomainError
+
     Base class for domain entities, defined by a unique identity (`id`).
     - `id`: Identity that remains constant throughout the entity's lifecycle.
     - Entities are mutable, but are compared solely by their `id`.
@@ -22,6 +24,8 @@ class Entity[T: ValueObject](ABC):
 
     def __setattr__(self, name: str, value: Any) -> None:
         """
+        :raises DomainError:
+
         Prevents modifying the `id` after it's set.
         Other attributes can be changed as usual.
         """