Skip to content

Commit 91092c6

Browse files
committed
add RouteDefinition in sample code
this helps avoid python/mypy#10740
1 parent 7ffc036 commit 91092c6

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

‎docs/index.rst‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,19 @@ pigwig is a WSGI framework for python 3.6+::
77

88
#!/usr/bin/env python3
99

10+
import typing
1011
from pigwig import PigWig, Response
12+
if typing.TYPE_CHECKING:
13+
from pigwig import Request
14+
from pigwig.routes import RouteDefinition
1115

12-
def root(request):
16+
def root(request: Request) -> Response:
1317
return Response('hello, world!')
1418

15-
def shout(request, word):
19+
def shout(request: Request, word: str) -> Response:
1620
return Response.json({'input': word, 'OUTPUT': word.upper()})
1721

18-
routes = [
22+
routes: RouteDefinition = [
1923
('GET', '/', root),
2024
('GET', '/shout/<word>', shout),
2125
]

0 commit comments

Comments
 (0)