lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated some docstrings for views and consumers classes/function defs.

Browse Source
This commit is contained in:
freewayml 2023-10-09 16:02:31 +00:00
parent d9abae51b5
commit 006909005e
2 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/paperless/consumers.py
View File

@ -7,6 +7,10 @@ from channels.generic.websocket import WebsocketConsumer
class StatusConsumer(WebsocketConsumer): class StatusConsumer(WebsocketConsumer):
"""
WebSocket consumer class that handles connection, disconnection,
and status update events.
"""
def _authenticated(self): def _authenticated(self):
return "user" in self.scope and self.scope["user"].is_authenticated return "user" in self.scope and self.scope["user"].is_authenticated

21
src/paperless/views.py
View File

@ -21,6 +21,8 @@ from paperless.serialisers import UserSerializer
class StandardPagination(PageNumberPagination): class StandardPagination(PageNumberPagination):
"""A class representing a standard pagination mechanism based on page
numbers."""
page_size = 25 page_size = 25
page_size_query_param = "page_size" page_size_query_param = "page_size"
max_page_size = 100000 max_page_size = 100000
@ -59,6 +61,16 @@ class StandardPagination(PageNumberPagination):
return ids return ids
def get_paginated_response_schema(self, schema): 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 = super().get_paginated_response_schema(schema)
response_schema["properties"]["all"] = { response_schema["properties"]["all"] = {
"type": "array", "type": "array",
@ -68,6 +80,9 @@ class StandardPagination(PageNumberPagination):
class FaviconView(View): class FaviconView(View):
"""
A view for serving the favicon.ico file.
"""
def get(self, request, *args, **kwargs): # pragma: nocover def get(self, request, *args, **kwargs): # pragma: nocover
favicon = os.path.join( favicon = os.path.join(
os.path.dirname(__file__), os.path.dirname(__file__),
@ -81,6 +96,9 @@ class FaviconView(View):
class UserViewSet(ModelViewSet): class UserViewSet(ModelViewSet):
"""
A viewset for handling User model CRUD operations.
"""
model = User model = User
queryset = User.objects.exclude( queryset = User.objects.exclude(
@ -96,6 +114,9 @@ class UserViewSet(ModelViewSet):
class GroupViewSet(ModelViewSet): class GroupViewSet(ModelViewSet):
"""
A viewset for handling Group model CRUD operations.
"""
model = Group model = Group
queryset = Group.objects.order_by(Lower("name")) queryset = Group.objects.order_by(Lower("name"))