Skip to content

Commit 49485f2

Browse files
committed
Find a better way of typing decorators that don't change signature
See python/mypy#3157
1 parent 97537e9 commit 49485f2

1 file changed

Lines changed: 27 additions & 38 deletions

File tree

‎src/server/quarchive/__init__.py‎

Lines changed: 27 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import itertools
66
import logging
77
from uuid import uuid4, UUID
8-
from typing import Mapping, Set, Any, Optional, Callable, Iterable, cast, Tuple
8+
from typing import Mapping, Set, Any, Optional, Callable, Iterable, cast, Tuple, TypeVar
99
from os import environ
1010
from urllib.parse import urlsplit, urlunsplit
1111
import json
@@ -298,38 +298,36 @@ def all_bookmarks(session) -> Iterable[Bookmark]:
298298
yield bookmark_from_sqla(url, sqla_bookmark)
299299

300300

301-
def sign_in_required(
302-
handler: Callable[..., Tuple[flask.Response, int]]
303-
) -> Callable[..., Tuple[flask.Response, int]]:
301+
# Flask's "views" are quite variable
302+
V = TypeVar("V", bound=Callable)
303+
304+
305+
def sign_in_required(handler: V) -> V:
304306
@wraps(handler)
305307
def wrapper(*args, **kwargs):
306308
if "username" not in flask.session:
307309
return flask.redirect("/sign-in"), 302
308310
else:
309311
return handler(*args, **kwargs)
310312

311-
return wrapper
313+
return cast(V, wrapper)
312314

313315

314-
def observe_redirect_to(
315-
handler: Callable[..., Tuple[flask.Response, int]]
316-
) -> Callable[..., Tuple[flask.Response, int]]:
316+
def observe_redirect_to(handler: V) -> V:
317317
@wraps(handler)
318318
def wrapper(*args, **kwargs):
319-
response, status_code = handler(*args, **kwargs)
320-
if status_code == 200 and "redirect_to" in flask.request.args:
319+
response = handler(*args, **kwargs)
320+
if response.status_code == 200 and "redirect_to" in flask.request.args:
321321
redirection = flask.make_response("redirecting",)
322322
redirection.headers["Location"] = flask.request.args["redirect_to"]
323323
return redirection, 303
324324
else:
325-
return response, status_code
325+
return response
326326

327-
return wrapper
327+
return cast(V, wrapper)
328328

329329

330-
def api_key_required(
331-
handler: Callable[[], flask.Response]
332-
) -> Callable[[], flask.Response]:
330+
def api_key_required(handler: V) -> V:
333331
@wraps(handler)
334332
def wrapper(*args, **kwargs):
335333
try:
@@ -347,7 +345,7 @@ def wrapper(*args, **kwargs):
347345
flask.current_app.logger.info("bad api credentials")
348346
return flask.jsonify({"error": "bad api credentials"}), 400
349347

350-
return wrapper
348+
return cast(V, wrapper)
351349

352350

353351
@blueprint.route("/")
@@ -376,17 +374,14 @@ def index() -> Tuple[flask.Response, int]:
376374
url_obj: SQLAUrl = sqla_obj.url_obj
377375
url = URL.from_sqla_url(sqla_obj.url_obj)
378376
bookmarks.append((url, bookmark_from_sqla(url.to_url(), sqla_obj)))
379-
return (
380-
flask.make_response(
381-
flask.render_template(
382-
"index.j2",
383-
bookmarks=bookmarks,
384-
page=page,
385-
prev_page_exists=prev_page_exists,
386-
next_page_exists=next_page_exists,
387-
)
388-
),
389-
200,
377+
return flask.make_response(
378+
flask.render_template(
379+
"index.j2",
380+
bookmarks=bookmarks,
381+
page=page,
382+
prev_page_exists=prev_page_exists,
383+
next_page_exists=next_page_exists,
384+
)
390385
)
391386

392387

@@ -406,7 +401,7 @@ def edit_bookmark(url_uuid: UUID) -> Tuple[flask.Response, int]:
406401
bookmark_fields["updated"] = datetime.utcnow().replace(tzinfo=timezone.utc)
407402
set_bookmark(db.session, Bookmark(**bookmark_fields))
408403
db.session.commit()
409-
return flask.make_response("ok"), 200
404+
return flask.make_response("ok")
410405

411406

412407
@blueprint.route("/url/<uuid:url_uuid>")
@@ -416,11 +411,8 @@ def view_url(url_uuid: UUID) -> Tuple[flask.Response, int]:
416411
if url_obj is None:
417412
raise exc.NotFound()
418413
else:
419-
return (
420-
flask.make_response(
421-
flask.render_template("url.j2", url=URL.from_sqla_url(url_obj))
422-
),
423-
200,
414+
return flask.make_response(
415+
flask.render_template("url.j2", url=URL.from_sqla_url(url_obj))
424416
)
425417

426418

@@ -431,11 +423,8 @@ def view_netloc(netloc: str) -> Tuple[flask.Response, int]:
431423
if url_objs.count() == 0:
432424
raise exc.NotFound()
433425
else:
434-
return (
435-
flask.make_response(
436-
flask.render_template("netloc.j2", netloc=netloc, url_objs=url_objs)
437-
),
438-
200,
426+
return flask.make_response(
427+
flask.render_template("netloc.j2", netloc=netloc, url_objs=url_objs)
439428
)
440429

441430

0 commit comments

Comments
 (0)