B ind )@sddlZddlZddlmZmZddlmZddlmZddl m Z ddl m Z ddl mZddlmZdd lmZmZdd lmZmZmZmZmZejd d d ZGdd d ZdS)N)StateURLPath) Middleware)BaseHTTPMiddleware)ServerErrorMiddleware)ExceptionMiddleware)Request)Response) BaseRouteRouter)ASGIAppLifespanReceiveScopeSendAppType Starlette)boundc@sJeZdZdZd8deejejeejeje ejej ej ej e egejeejefffejejej ejejej ejeddd ddZedd d Zeejedd d Zeej ed ddZeeeddddZeej dddZ d9eeejeddddZ!d:eeejeddddZ"e#ej ddddZ$eje%ej&efej ddd d!Z'eej dd"d#d$Z(d;eej ejejeejeedd&d'd(Z)deejeej d2d3d4Z-eej d5d6d7Z.dS)?raL Creates an application instance. **Parameters:** * **debug** - Boolean indicating if debug tracebacks should be returned on errors. * **routes** - A list of routes to serve incoming HTTP and WebSocket requests. * **middleware** - A list of middleware to run for every request. A starlette application will always automatically include two middleware classes. `ServerErrorMiddleware` is added as the very outermost middleware, to handle any uncaught errors occurring anywhere in the entire stack. `ExceptionMiddleware` is added as the very innermost middleware, to deal with handled exception cases occurring in the routing or endpoints. * **exception_handlers** - A mapping of either integer status codes, or exception class types onto callables which handle the exceptions. Exception handler callables should be of the form `handler(request, exc) -> response` and may be be either standard functions, or async functions. * **on_startup** - A list of callables to run on application startup. Startup handler callables do not take any arguments, and may be be either standard functions, or async functions. * **on_shutdown** - A list of callables to run on application shutdown. Shutdown handler callables do not take any arguments, and may be be either standard functions, or async functions. * **lifespan** - A lifespan context function, which can be used to perform startup and shutdown tasks. This is a newer style that replaces the `on_startup` and `on_shutdown` handlers. Use one or the other, not both. FNr) selfdebugroutes middlewareexception_handlers on_startup on_shutdownlifespanreturncCsv|dks |dkr|dks td||_t|_t||||d|_|dkrLint||_|dkrbgnt||_ d|_ dS)Nz>Use either 'lifespan' or 'on_startup'/'on_shutdown', not both.)rrr) AssertionErrorrrstater routerdictrlistuser_middlewaremiddleware_stack)rrrrrrrrr$:/tmp/pip-unpacked-wheel-_bom8ime/starlette/applications.py__init__/szStarlette.__init__)rc Cs|j}d}i}x0|jD]"\}}|dtfkr4|}q|||<qWtt||dg|jtt||dg}|j}x&t |D]\}} |fd|i| }qvW|S)Ni)handlerr)handlersrapp) rritems Exceptionrrr"rrreversed) rrZ error_handlerrkeyvaluerr)clsoptionsr$r$r%build_middleware_stackRs  z Starlette.build_middleware_stackcCs|jjS)N)rr)rr$r$r%rnszStarlette.routes)_Starlette__name path_paramsrcKs|jj|f|S)N)r url_path_for)rr2r3r$r$r%r4sszStarlette.url_path_for)scopereceivesendrcs4||d<|jdkr||_||||IdHdS)Nr))r#r1)rr5r6r7r$r$r%__call__vs  zStarlette.__call__) event_typercCs |j|S)N)ron_event)rr9r$r$r%r:|szStarlette.on_event)pathr)namercCs|jj|||ddS)N)r)r<)rmount)rr;r)r<r$r$r%r=szStarlette.mount)hostr)r<rcCs|jj|||ddS)N)r)r<)rr>)rr>r)r<r$r$r%r>szStarlette.host)middleware_classr0rcKs,|jdk rtd|jdt|f|dS)Nz6Cannot add middleware after an application has startedr)r# RuntimeErrorr"insertr)rr?r0r$r$r%add_middlewares zStarlette.add_middleware)exc_class_or_status_coder'rcCs||j|<dS)N)r)rrCr'r$r$r%add_exception_handlerszStarlette.add_exception_handler)r9funcrcCs|j||dS)N)radd_event_handler)rr9rEr$r$r%rFszStarlette.add_event_handlerT)r;routemethodsr<include_in_schemarcCs|jj|||||ddS)N)rHr<rI)r add_route)rr;rGrHr<rIr$r$r%rJszStarlette.add_route)r;rGr<rcCs|jj|||ddS)N)r<)radd_websocket_route)rr;rGr<r$r$r%rKszStarlette.add_websocket_route)rCrcs*tdttjtjdfdd }|S)NzThe `exception_handler` decorator is deprecated, and will be removed in version 1.0.0. Refer to https://www.starlette.io/exceptions/ for the recommended approach.)rErcs||S)N)rD)rE)rCrr$r% decorators z.Starlette.exception_handler..decorator)warningswarnDeprecationWarningtypingCallable)rrCrLr$)rCrr%exception_handlers zStarlette.exception_handler)r;rHr<rIrcs0tdttjtjdfdd }|S)z We no longer document this decorator style API, and its usage is discouraged. Instead you should use the following approach: >>> routes = [Route(path, endpoint=...), ...] >>> app = Starlette(routes=routes) zThe `route` decorator is deprecated, and will be removed in version 1.0.0. Refer to https://www.starlette.io/routing/ for the recommended approach.)rErcsjj|d|S)N)rHr<rI)rrJ)rE)rIrHr<r;rr$r%rLsz"Starlette.route..decorator)rMrNrOrPrQ)rr;rHr<rIrLr$)rIrHr<r;rr%rGs  zStarlette.route)r;r<rcs,tdttjtjdfdd }|S)a We no longer document this decorator style API, and its usage is discouraged. Instead you should use the following approach: >>> routes = [WebSocketRoute(path, endpoint=...), ...] >>> app = Starlette(routes=routes) zThe `websocket_route` decorator is deprecated, and will be removed in version 1.0.0. Refer to https://www.starlette.io/routing/#websocket-routing for the recommended approach.)rErcsjj|d|S)N)r<)rrK)rE)r<r;rr$r%rLsz,Starlette.websocket_route..decorator)rMrNrOrPrQ)rr;r<rLr$)r<r;rr%websocket_routes zStarlette.websocket_route)middleware_typercs8tdt|dkstdtjtjdfdd }|S)z We no longer document this decorator style API, and its usage is discouraged. Instead you should use the following approach: >>> middleware = [Middleware(...), ...] >>> app = Starlette(middleware=middleware) zThe `middleware` decorator is deprecated, and will be removed in version 1.0.0. Refer to https://www.starlette.io/middleware/#using-middleware for recommended approach.httpz/Currently only middleware("http") is supported.)rErcsjt|d|S)N)dispatch)rBr)rE)rr$r%rLsz'Starlette.middleware..decorator)rMrNrOrrPrQ)rrTrLr$)rr%rs zStarlette.middleware)FNNNNNN)N)N)NNT)N)NNT)N)/__name__ __module__ __qualname____doc__boolrPOptionalSequencer rMappingAnyrQrr+Unionr Awaitabler r&r r1propertyListrstrrr4rrrr8r:r=r>typerBintTyperDrFrJrKrRrGrSrr$r$r$r%rsP   )rPrMZstarlette.datastructuresrrZstarlette.middlewarerZstarlette.middleware.baserZstarlette.middleware.errorsrZstarlette.middleware.exceptionsrZstarlette.requestsrZstarlette.responsesr Zstarlette.routingr r Zstarlette.typesr r rrrTypeVarrrr$r$r$r%s