+ V@i4b Rt^RIt^RIHt^RIHt^RIHt^RIH t H t H t ^RI H t ^RIHtHtHtHt^RIHtHtHtHtHtHtHtHtHtHt!R R ]P<4t!R R ]4t !R R]PB4t"!RR]PB4t#]]R]],]]]$R3,]3,]]]$R3,]]]$]3,3,]]]$R3,]]]$]3,]$3,3,,t%!RR]4t&!RR] ]&4t'!RR4t(!RR4t)!RR])4t*!RR])4t+!RR])4t,!RR ])4t-!R!R"](4t.]R#R$l4t/]R%R&l4t/R'R(lt/R#))apFlexible routing implementation. Tornado routes HTTP requests to appropriate handlers using `Router` class implementations. The `tornado.web.Application` class is a `Router` implementation and may be used directly, or the classes in this module may be used for additional flexibility. The `RuleRouter` class can match on more criteria than `.Application`, or the `Router` interface can be subclassed for maximum customization. `Router` interface extends `~.httputil.HTTPServerConnectionDelegate` to provide additional routing capabilities. This also means that any `Router` implementation can be used directly as a ``request_callback`` for `~.httpserver.HTTPServer` constructor. `Router` subclass must implement a ``find_handler`` method to provide a suitable `~.httputil.HTTPMessageDelegate` instance to handle the request: .. code-block:: python class CustomRouter(Router): def find_handler(self, request, **kwargs): # some routing logic providing a suitable HTTPMessageDelegate instance return MessageDelegate(request.connection) class MessageDelegate(HTTPMessageDelegate): def __init__(self, connection): self.connection = connection def finish(self): self.connection.write_headers( ResponseStartLine("HTTP/1.1", 200, "OK"), HTTPHeaders({"Content-Length": "2"}), b"OK") self.connection.finish() router = CustomRouter() server = HTTPServer(router) The main responsibility of `Router` implementation is to provide a mapping from a request to `~.httputil.HTTPMessageDelegate` instance that will handle this request. In the example above we can see that routing is possible even without instantiating an `~.web.Application`. For routing to `~.web.RequestHandler` implementations we need an `~.web.Application` instance. `~.web.Application.get_handler_delegate` provides a convenient way to create `~.httputil.HTTPMessageDelegate` for a given request and `~.web.RequestHandler`. Here is a simple example of how we can we route to `~.web.RequestHandler` subclasses by HTTP method: .. code-block:: python resources = {} class GetResource(RequestHandler): def get(self, path): if path not in resources: raise HTTPError(404) self.finish(resources[path]) class PostResource(RequestHandler): def post(self, path): resources[path] = self.request.body class HTTPMethodRouter(Router): def __init__(self, app): self.app = app def find_handler(self, request, **kwargs): handler = GetResource if request.method == "GET" else PostResource return self.app.get_handler_delegate(request, handler, path_args=[request.path]) router = HTTPMethodRouter(Application()) server = HTTPServer(router) `ReversibleRouter` interface adds the ability to distinguish between the routes and reverse them to the original urls using route's name and additional arguments. `~.web.Application` is itself an implementation of `ReversibleRouter` class. `RuleRouter` and `ReversibleRuleRouter` are implementations of `Router` and `ReversibleRouter` interfaces and can be used for creating rule-based routing configurations. Rules are instances of `Rule` class. They contain a `Matcher`, which provides the logic for determining whether the rule is a match for a particular request and a target, which can be one of the following. 1) An instance of `~.httputil.HTTPServerConnectionDelegate`: .. code-block:: python router = RuleRouter([ Rule(PathMatches("/handler"), ConnectionDelegate()), # ... more rules ]) class ConnectionDelegate(HTTPServerConnectionDelegate): def start_request(self, server_conn, request_conn): return MessageDelegate(request_conn) 2) A callable accepting a single argument of `~.httputil.HTTPServerRequest` type: .. code-block:: python router = RuleRouter([ Rule(PathMatches("/callable"), request_callable) ]) def request_callable(request): request.write(b"HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nOK") request.finish() 3) Another `Router` instance: .. code-block:: python router = RuleRouter([ Rule(PathMatches("/router.*"), CustomRouter()) ]) Of course a nested `RuleRouter` or a `~.web.Application` is allowed: .. code-block:: python router = RuleRouter([ Rule(HostMatches("example.com"), RuleRouter([ Rule(PathMatches("/app1/.*"), Application([(r"/app1/handler", Handler)])), ])) ]) server = HTTPServer(router) In the example below `RuleRouter` is used to route between applications: .. code-block:: python app1 = Application([ (r"/app1/handler", Handler1), # other handlers ... ]) app2 = Application([ (r"/app2/handler", Handler2), # other handlers ... ]) router = RuleRouter([ Rule(PathMatches("/app1.*"), app1), Rule(PathMatches("/app2.*"), app2) ]) server = HTTPServer(router) For more information on application-level routing see docs for `~.web.Application`. .. versionadded:: 4.5 N)partial)httputil)_CallableAdapter) url_escape url_unescapeutf8)app_log)basestring_type import_object re_unescape unicode_type) AnyUnionOptional AwaitableListDictPatternTupleoverloadSequencecHa]tRt^toRtV3RlRltV3RlRltRtVtR#)RouterzAbstract router interface.cd<V^8dQhRS[PRS[RS[S[P,/#requestkwargsreturnrHTTPServerRequestr rHTTPMessageDelegate)format __classdict__s"1/usr/lib/python3/dist-packages/tornado/routing.py __annotate__Router.__annotate__s6 $ $11 $=@ $ (.. / $c \4h)aMust be implemented to return an appropriate instance of `~.httputil.HTTPMessageDelegate` that can serve the request. Routing implementations may pass additional kwargs to extend the routing logic. :arg httputil.HTTPServerRequest request: current HTTP request. :arg kwargs: additional keyword arguments passed by routing implementation. :returns: an instance of `~.httputil.HTTPMessageDelegate` that will be used to process the request. NotImplementedError)selfrrs&&,r$ find_handlerRouter.find_handlers "##r'cT<V^8dQhRS[RS[PRS[P/#)r server_conn request_connr)objectrHTTPConnectionr!)r"r#s"r$r%r&s6AA!A191H1HA  % %Ar'c\WV4#N)_RoutingDelegate)r+r/r0s&&&r$ start_requestRouter.start_requests <@@r'N) __name__ __module__ __qualname____firstlineno____doc__r,r6__static_attributes____classdictcell__r#s@r$rrs$ $ $AAr'rc6a]tRt^toRtV3RlRltRtVtR#)ReversibleRouterzpAbstract router interface for routers that can handle named routes and support reversing them to original urls. c<<V^8dQhRS[RS[RS[S[,/#rnameargsrstrr r)r"r#s"r$r%ReversibleRouter.__annotate__s&$$$C$HSM$r'c \4h)zReturns url string for a given route name and arguments or ``None`` if no match is found. :arg str name: route name. :arg args: url parameters. :returns: parametrized url string for a given route name (or ``None``). r))r+rErFs&&*r$ reverse_urlReversibleRouter.reverse_urls "##r'r8N)r9r:r;r<r=rKr>r?r@s@r$rBrBs$$r'rBcza]tRt^toV3RlRltV3RlRltV3RlRltV3RlRltV3R lR ltR t Vt R #) r5cD<V^8dQhRS[RS[RS[PRR/#)rrouterr/r0rN)rr1rr2)r"r#s"r$r%_RoutingDelegate.__annotate__s3+1AIAXAX r'c8W nW0nRVnWnR#r4)r/r0delegaterO)r+rOr/r0s&&&&r$__init___RoutingDelegate.__init__s'(  r'c<V^8dQhRS[S[PS[P3,RS[PRS[S[R,,/#)r start_lineheadersrN)rrRequestStartLineResponseStartLine HTTPHeadersrr)r"r#s"r$r%rPsSCC(33X5O5OOPC%%C )D/ " Cr'c\V\P4'gQh\P!VPVP VVR7pVP PV4VnVPfG\P!RVPVP4\VP4VnVPPW4#)) connectionserver_connectionrVrWz$Delegate for %s %s request not found) isinstancerrXr r0r/rOr,rRrdebugmethodpath_DefaultMessageDelegateheaders_received)r+rVrWrs&&& r$rc!_RoutingDelegate.headers_receiveds *h&?&?@@@@,,(("..!   009 == MM6!!  4D4E4EFDM}}--jBBr'cD<V^8dQhRS[RS[S[R,,/#)rchunkrN)bytesrr)r"r#s"r$r%rPs$2252Xio-F2r'cXVPfQhVPPV4#r4)rR data_received)r+rfs&&r$ri_RoutingDelegate.data_receiveds'}}(((}}**511r'c<V^8dQhRR/#rrNr8)r"r#s"r$r%rPsr'cZVPfQhVPP4R#r4)rRfinishr+s&r$rn_RoutingDelegate.finishs"}}((( r'c<V^8dQhRR/#rlr8)r"r#s"r$r%rPs00T0r'cZVPeVPP4R#R#r4)rRon_connection_closeros&r$rs$_RoutingDelegate.on_connection_closes! == $ MM - - / %r')rRr0rOr/N) r9r:r;r<rSrcrirnrsr>r?r@s@r$r5r5s9CC02200r'r5cDa]tRtRtoV3RlRltV3RlRltRtVtR#)rbic8<V^8dQhRS[PRR/#)rr\rN)rr2)r"r#s"r$r%$_DefaultMessageDelegate.__annotate__s!%%8#:#:%t%r'cWnR#r4r\)r+r\s&&r$rS _DefaultMessageDelegate.__init__s$r'c<V^8dQhRR/#rlr8)r"r#s"r$r%rw"s!!!r'cVPP\P!RRR4\P!44VPP 4R#)zHTTP/1.1iz Not FoundN)r\ write_headersrrYrZrnros&r$rn_DefaultMessageDelegate.finish"sD %%  & &z3 D  "   r'ryN)r9r:r;r<rSrnr>r?r@s@r$rbrbs%%!!r'rbRuleMatcherca]tRtRtoRtRV3RlRlltV3RlRltV3RlR ltV3R lR ltV3R lR lt Rt Vt R#) RuleRouteri7z!Rule-based router implementation.Nc4<V^8dQhRS[S[,RR/#rrulesrNr _RuleList)r"r#s"r$r%RuleRouter.__annotate__:s ""hy1"T"r'c J.VnV'dVPV4R#R#)aConstructs a router from an ordered list of rules:: RuleRouter([ Rule(PathMatches("/handler"), Target), # ... more rules ]) You can also omit explicit `Rule` constructor and use tuples of arguments:: RuleRouter([ (PathMatches("/handler"), Target), ]) `PathMatches` is a default matcher, so the example above can be simplified:: RuleRouter([ ("/handler", Target), ]) In the examples above, ``Target`` can be a nested `Router` instance, an instance of `~.httputil.HTTPServerConnectionDelegate` or an old-style callable, accepting a request argument. :arg rules: a list of `Rule` instances or tuples of `Rule` constructor arguments. N)r add_rules)r+rs&&r$rSRuleRouter.__init__:s6  NN5 ! r'c$<V^8dQhRS[RR/#r)r)r"r#s"r$r%rYs77y7T7r'c ^VFp\V\\34'd^\V4R9gQh\V^,\4'd&\ \ V^,4.VR,O5!pM \ V!pVPPVPV44K R#)zAppends new rules to the router. :arg rules: a list of Rule instances (or tuples of arguments, which are passed to Rule constructor). NNN)r) r^tuplelistlenr r PathMatchesrappend process_rule)r+rrules&& r$rRuleRouter.add_rulesYs D$ ..4yI---d1g77 DG 4@tBx@D;D JJ  d//5 6r'c"<V^8dQhRRRR/#rrrrr8)r"r#s"r$r%risFr'c V#)zOverride this method for additional preprocessing of each rule. :arg Rule rule: a rule to be processed. :returns: the same or modified Rule instance. r8)r+rs&&r$rRuleRouter.process_ruleis  r'cd<V^8dQhRS[PRS[RS[S[P,/#rr)r"r#s"r$r%rqs611=@ (.. /r'c VPFkpVPPV4pVfK$VP'dVPVR&VP!VP V3/VBpVfKiVu# R#)N target_kwargs)rmatchermatchrget_target_delegatetarget)r+rrr target_paramsrRs&&, r$r,RuleRouter.find_handlerqs{JJD LL..w7M(%%%595G5GM/233KK,9'#Or'c j<V^8dQhRS[RS[PRS[RS[S[P,/#)rrrrr)r rr rr!)r"r#s"r$r%rs>$,$>$>QT (.. /r'c \V\4'dVP!V3/VB#\V\P4'd7VP fQhVP VPVP 4#\V4'd1VP fQh\\V3/VBVP 4#R#)axReturns an instance of `~.httputil.HTTPMessageDelegate` for a Rule's target. This method is called by `~.find_handler` and can be extended to provide additional target types. :arg target: a Rule's target. :arg httputil.HTTPServerRequest request: current request. :arg target_params: additional parameters that can be useful for `~.httputil.HTTPMessageDelegate` creation. N) r^rr,rHTTPServerConnectionDelegater\r6r]callablerr)r+rrrs&&&,r$rRuleRouter.get_target_delegates ff % %&&w@-@ @  E E F F%%1 11''(A(A7CUCUV V f  %%1 11#0-0'2D2D r')rr4) r9r:r;r<r=rSrrr,rr>r?r@s@r$rr7s:+"">77 $r'rcpaa]tRtRtoRtR V3RlV3RllltV3RlV3RlltV3RlRltR tVt V;t #) ReversibleRuleRouterizA rule-based router that implements ``reverse_url`` method. Each rule added to this router may have a ``name`` attribute that can be used to reconstruct an original uri. The actual reconstruction takes place in a rule's matcher (see `Matcher.reverse`). c4<V^8dQhRS[S[,RR/#rr)r"r#s"r$r%!ReversibleRuleRouter.__annotate__s   hy1 T r'c4</Vn\SV` V4R#r4) named_rulessuperrS)r+r __class__s&&r$rSReversibleRuleRouter.__init__s r'c"<V^8dQhRRRR/#rr8)r"r#s"r$r%rs   F r'c<\SV`V4pVP'dUVPVP9d"\P !RVP4WPVP&V#)z4Multiple handlers named %s; replacing previous value)rrrErrwarning)r+rrs&&r$r!ReversibleRuleRouter.process_rules[w#D) 999yyD,,,JDII+/  TYY ' r'c<<V^8dQhRS[RS[RS[S[,/#rDrG)r"r#s"r$r%rs&   C HSM r'c2WP9d,VPV,PP!V!#VPFKp\ VP \ 4'gK%VP P!V.VO5!pVfKIVu# R#r4)rrreverserr^rrBrK)r+rErFr reversed_urls&&* r$rK ReversibleRuleRouter.reverse_urlsz ## ###D)11994@ @JJD$++'788#{{66tCdC +''  r')rr4) r9r:r;r<r=rSrrKr>r? __classcell__rr#s@@r$rrs-       r'rc^a]tRtRtoRtR V3RlRlltV3RlRltV3RlR ltR tVt R#) rizA routing rule.Nc j<V^8dQhRRRS[RS[S[S[S[3,,RS[S[,RR/#)rrrrrrErN)r rrrH)r"r#s"r$r%Rule.__annotate__sN S#X/  sm   r'c \V\4'd \V4pWnW nV'dTM/VnW@nR#)aConstructs a Rule instance. :arg Matcher matcher: a `Matcher` instance used for determining whether the rule should be considered a match for a specific request. :arg target: a Rule's target (typically a ``RequestHandler`` or `~.httputil.HTTPServerConnectionDelegate` subclass or even a nested `Router`, depending on routing implementation). :arg dict target_kwargs: a dict of parameters that can be useful at the moment of target instantiation (for example, ``status_code`` for a ``RequestHandler`` subclass). They end up in ``target_params['target_kwargs']`` of `RuleRouter.get_target_delegate` method. :arg str name: the name of the rule that can be used to find it in `ReversibleRouter.reverse_url` implementation. N)r^rHr rrrrE)r+rrrrEs&&&&&r$rS Rule.__init__s8. fc " "#6*F  .;] r'c6<V^8dQhRS[RS[S[,/#rrFrr rrH)r"r#s"r$r%rs++S+Xc]+r'c6VPP!V!#r4)rrr+rFs&*r$r Rule.reverses||##T**r'c <V^8dQhRS[/#rrrH)r"r#s"r$r%r  # r'cRPVPPVPVPVP VP 4#z${}({!r}, {}, kwargs={!r}, name={!r}))r"rr9rrrrEros&r$__repr__ Rule.__repr__s@5<< NN # # LL KK    II   r')rrErrNN) r9r:r;r<r=rSrrr>r?r@s@r$rrs'B++  r'cHa]tRtRtoRtV3RlRltV3RlRltRtVtR#) riz*Represents a matcher for request features.c`<V^8dQhRS[PRS[S[S[S[3,,/#rrrrr rrrHr )r"r#s"r$r%Matcher.__annotate__s. $ $X77 $HT#s(^r?r@s@r$rrs4 $ $r'c6a]tRtRtoRtV3RlRltRtVtR#) AnyMatchesi zMatches any request.c`<V^8dQhRS[PRS[S[S[S[3,,/#rr)r"r#s"r$r%AnyMatches.__annotate__ s.X77HT#s(^r?r@s@r$rr sr'rcHa]tRtRtoRtV3RlRltV3RlRltRtVtR#) HostMatchesiz@Matches requests from hosts specified by ``host_pattern`` regex.c:<V^8dQhRS[S[S[3,RR/#)r host_patternrNrrHr)r"r#s"r$r%HostMatches.__annotate__s$--U3<%8-T-r'c\V\4'd>VPR4'g VR, p\P!V4VnR#WnR#)$N)r^r endswithrecompiler)r+rs&&r$rSHostMatches.__init__sA lO 4 4((--# " < 8D  , r'c`<V^8dQhRS[PRS[S[S[S[3,,/#rr)r"r#s"r$r%rs.X77HT#s(^r?r@s@r$rrsJ--r'rcHa]tRtRtoRtV3RlRltV3RlRltRtVtR#) DefaultHostMatchesi"zMatches requests from host that is equal to application's default_host. Always returns no match if ``X-Real-Ip`` header is present. c*<V^8dQhRS[RS[RR/#)r applicationrrN)r r)r"r#s"r$r%DefaultHostMatches.__annotate__'s"))C)w)4)r'cWnW nR#r4rr)r+rrs&&&r$rSDefaultHostMatches.__init__'s&(r'c`<V^8dQhRS[PRS[S[S[S[3,,/#rr)r"r#s"r$r%r+s.X77HT#s(^,-8a-/9R-S* MM$);";<"()4X)>&  01%+(wwv 1 111&, ,+,"(('(s$5D-& E- D?>D? EE)r r rN) r9r:r;r<r=rSrrr r>r?r@s@r$rr3s2J < <BB. 2 2&2&2r'rcXaa]tRtRtoRtRV3RlV3RllltV3RlRltRtVtV;t #) URLSpecizSpecifies mappings between URLs and handlers. .. versionchanged: 4.5 `URLSpec` is now a subclass of a `Rule` with `PathMatches` matcher and is preserved for backwards compatibility. c <V^8dQhRS[S[S[3,RS[RS[S[S[S[3,,RS[S[,RR/#)rr handlerrrErN)rrHrr rr)r"r#s"r$r%URLSpec.__annotate__sWsG|$c3h(  sm   r'c <\V4p\SV` WRW44VPVnVPVnW0nR#)a+Parameters: * ``pattern``: Regular expression to be matched. Any capturing groups in the regex will be passed in to the handler's get/post/etc methods as arguments (by keyword if named, by position if unnamed. Named and unnamed capturing groups may not be mixed in the same rule). * ``handler``: `~.web.RequestHandler` subclass to be invoked. * ``kwargs`` (optional): A dictionary of additional arguments to be passed to the handler's constructor. * ``name`` (optional): A name for this handler. Used by `~.web.Application.reverse_url`. N)rrrSrr handler_classr)r+r r7rrErrs&&&&& r$rSURLSpec.__init__s:0g& 68]] ![[ r'c <V^8dQhRS[/#rr)r"r#s"r$r%r8rr'cRPVPPVPPVP VP VP4#r)r"rr9rr r:rrEros&r$rURLSpec.__repr__sF5<< NN # # JJ      KK II   r')r:rrr) r9r:r;r<r=rSrr>r?rrs@@r$r5r5s#>   r'r5c0V^8dQhR\R\/#rrr)rHrg)r"s"r$r%r%s    r'cR#r4r8rs&r$rrr'c V^8dQhRRRR/#)rrNrr8)r"s"r$r%r%s    r'cR#r4r8rBs&r$rrrCr'c\V^8dQhR\\,R\\,/#r@)rrHrg)r"s"r$r%r%s" 6 6 6(5/ 6r'c*VfV#\VRRR7#)zNone-safe wrapper around url_unescape to handle unmatched optional groups correctly. Note that args are passed as bytes so the handler can decide what encoding to use. NF)encodingr)rrBs&r$rrs y Du 55r')0r=r functoolsrtornadortornado.httpserverrtornado.escaperrr tornado.logr tornado.utilr r r r typingr rrrrrrrrrrrrBr!r5rbrHrrrrrrrrrr5rr8r'r$rPsaF /99RR   AX 2 2A. $v $ +0x33+0\ !h:: !   S  eCN#S() eCN#S$sCx.89 eCN#S$sCx.#=>  @  eeP"+Z"J. . b('$"^2'^2B. d. b         6r'