diff --git a/src/paperless/consumers.py b/src/paperless/consumers.py index cf1a3b548..501060503 100644 --- a/src/paperless/consumers.py +++ b/src/paperless/consumers.py @@ -7,6 +7,10 @@ from channels.generic.websocket import WebsocketConsumer class StatusConsumer(WebsocketConsumer): + """ + WebSocket consumer class that handles connection, disconnection, + and status update events. + """ def _authenticated(self): return "user" in self.scope and self.scope["user"].is_authenticated diff --git a/src/paperless/views.py b/src/paperless/views.py index e872cc19c..0a2406836 100644 --- a/src/paperless/views.py +++ b/src/paperless/views.py @@ -21,6 +21,8 @@ from paperless.serialisers import UserSerializer class StandardPagination(PageNumberPagination): + """A class representing a standard pagination mechanism based on page +numbers.""" page_size = 25 page_size_query_param = "page_size" max_page_size = 100000 @@ -59,6 +61,16 @@ class StandardPagination(PageNumberPagination): return ids def get_paginated_response_schema(self, schema): + """ + Get the paginated response schema. + This function takes a schema as input and returns a modified + version of the schema. + Args: + self: The instance of the class. + schema: The input schema. + Returns: + dict: The modified response schema. + """ response_schema = super().get_paginated_response_schema(schema) response_schema["properties"]["all"] = { "type": "array", @@ -68,6 +80,9 @@ class StandardPagination(PageNumberPagination): class FaviconView(View): + """ + A view for serving the favicon.ico file. + """ def get(self, request, *args, **kwargs): # pragma: nocover favicon = os.path.join( os.path.dirname(__file__), @@ -81,6 +96,9 @@ class FaviconView(View): class UserViewSet(ModelViewSet): + """ + A viewset for handling User model CRUD operations. + """ model = User queryset = User.objects.exclude( @@ -96,6 +114,9 @@ class UserViewSet(ModelViewSet): class GroupViewSet(ModelViewSet): + """ + A viewset for handling Group model CRUD operations. + """ model = Group queryset = Group.objects.order_by(Lower("name"))