Browse Source

API: Fix function return type hints

merge-requests/170/head
Andrew Shu 1 month ago
parent
commit
badbbe1615
  1. 5
      tildes/tildes/views/api/beta/topic.py
  2. 7
      tildes/tildes/views/api/beta/user.py

5
tildes/tildes/views/api/beta/topic.py

@ -4,6 +4,7 @@
"""JSON API endpoints related to topics."""
from pyramid.request import Request
from pyramid.response import Response
from pyramid.view import view_config
from tildes.enums import CommentTreeSortOption, TopicSortOption
from tildes.models.comment import CommentTree, Comment
@ -51,7 +52,7 @@ def topic_to_api_dict(topic: Topic) -> dict:
@view_config(route_name="apibeta.topics", openapi=True, renderer="json")
def get_topics(request: Request) -> dict: # noqa
def get_topics(request: Request) -> dict | Response: # noqa: MC0001
"""Get a list of topics (without comments)."""
limit = request.openapi_validated.parameters.query.get("limit", 50)
period_raw = request.openapi_validated.parameters.query.get("period")
@ -118,7 +119,7 @@ def get_topics(request: Request) -> dict: # noqa
@view_config(route_name="apibeta.topic", openapi=True, renderer="json")
def get_topic(request: Request) -> dict:
def get_topic(request: Request) -> dict | Response:
"""Get a single topic (with comments)."""
topic_id36 = request.openapi_validated.parameters.path.get("topic_id36")
comment_order_raw = request.openapi_validated.parameters.query.get("order")

7
tildes/tildes/views/api/beta/user.py

@ -5,6 +5,7 @@
from typing import Union
from pyramid.request import Request
from pyramid.response import Response
from pyramid.view import view_config
from tildes.models.user.user import User
from tildes.models.comment import Comment
@ -44,7 +45,7 @@ def _user_to_api_dict(request: Request, user: User) -> dict:
@view_config(route_name="apibeta.user", openapi=True, renderer="json")
def get_user(request: Request) -> dict: # noqa
def get_user(request: Request) -> dict | Response: # noqa: MC0001
"""Get a single user with their comment and post history."""
username = request.openapi_validated.parameters.path.get("username")
limit = request.openapi_validated.parameters.query.get("limit", 20)
@ -121,7 +122,7 @@ def get_user(request: Request) -> dict: # noqa
@view_config(route_name="apibeta.user_comments", openapi=True, renderer="json")
def get_user_comments(request: Request) -> dict:
def get_user_comments(request: Request) -> dict | Response:
"""Get comments made by a user."""
username = request.openapi_validated.parameters.path.get("username")
limit = request.openapi_validated.parameters.query.get("limit", 50)
@ -177,7 +178,7 @@ def get_user_comments(request: Request) -> dict:
@view_config(route_name="apibeta.user_topics", openapi=True, renderer="json")
def get_user_topics(request: Request) -> dict:
def get_user_topics(request: Request) -> dict | Response:
"""Get topics made by a user."""
username = request.openapi_validated.parameters.path.get("username")
limit = request.openapi_validated.parameters.query.get("limit", 50)

Loading…
Cancel
Save