U lu fa @sdZddlZddlmZddlmZddlmZddlm Z m Z m Z ddl m Z ddlmZmZmZmZdd lmZmZmZmZmZmZmZmZmZGd d d ejZGd d d eZGdddej Z!Gdddej Z"eedeeeee#dfefeee#dfeee#effeee#dfeee#efe#ffZ$GdddeZ%Gdddee%Z&Gddde'Z(Gddde'Z)Gddde)Z*Gddde)Z+Gddde)Z,Gd d!d!e)Z-Gd"d#d#e(Z.ee#e/d$d%d&Z0eddd$d'd&Z0ee#ee/d$d(d&Z0dS))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 AwaitableListDictPatternTupleoverloadc@s@eZdZdZejeeejdddZ e ej ejdddZ dS) RouterzAbstract router interface.requestkwargsreturncKs tdS)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. NNotImplementedError)selfrrr3/tmp/pip-unpacked-wheel-bmg6zs32/tornado/routing.py find_handlers zRouter.find_handler) server_conn request_connrcCs t|||SN)_RoutingDelegate)rr!r"rrr start_requestszRouter.start_requestN) __name__ __module__ __qualname____doc__rHTTPServerRequestr rHTTPMessageDelegater objectHTTPConnectionr%rrrrrs rc@s&eZdZdZeeeedddZdS)ReversibleRouterzxAbstract router interface for routers that can handle named routes and support reversing them to original urls. nameargsrcGs tdS)aReturns 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``). Nr)rr0r1rrr reverse_urlszReversibleRouter.reverse_urlN)r&r'r(r)strr rr2rrrrr.sr.c@s~eZdZeeejddddZeej ej fej e e ddddZee e ddd d Zdd d d Zdd ddZdS)r$N)routerr!r"rcCs||_||_d|_||_dSr#)r!r"delegater4)rr4r!r"rrr__init__sz_RoutingDelegate.__init__) start_lineheadersrcCsjt|tjsttj|j|j||d}|j||_ |j dkr\t d|j |j t|j|_ |j ||S)N) connectionserver_connectionr7r8z$Delegate for %s %s request not found) isinstancerRequestStartLineAssertionErrorr*r"r!r4r r5rdebugmethodpath_DefaultMessageDelegateheaders_received)rr7r8rrrrrBs   z!_RoutingDelegate.headers_received)chunkrcCs|jdk st|j|Sr#)r5r= data_received)rrCrrrrDsz_RoutingDelegate.data_receivedrcCs|jdk st|jdSr#)r5r=finishrrrrrF sz_RoutingDelegate.finishcCs|jdk st|jdSr#)r5r=on_connection_closerGrrrrHsz$_RoutingDelegate.on_connection_close)r&r'r(rr,rr-r6rr<ResponseStartLine HTTPHeadersrrrBbytesrDrFrHrrrrr$s  r$c@s,eZdZejddddZddddZdS)rAN)r9rcCs ||_dSr#)r9)rr9rrrr6sz _DefaultMessageDelegate.__init__rEcCs*|jtdddt|jdS)NzHTTP/1.1iz Not Found)r9Z write_headersrrIrJrFrGrrrrFs  z_DefaultMessageDelegate.finish)r&r'r(rr-r6rFrrrrrAsrARuleMatcherc@s|eZdZdZdeeddddZeddddZddd d d Ze j e ee j d d dZ e e j e ee j dddZdS) RuleRouterz!Rule-based router implementation.NrulesrcCsg|_|r||dS)aIConstructs 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)rP add_rulesrrPrrrr6/szRuleRouter.__init__cCst|D]j}t|ttfr\t|dks&tt|dtrTtt|df|dd}nt|}|j | |qdS)zAppends new rules to the router. :arg rules: a list of Rule instances (or tuples of arguments, which are passed to Rule constructor). )rN) r;tuplelistlenr=r rL PathMatchesrPappend process_rule)rrPrulerrrrQNs zRuleRouter.add_rulesrLr]rcCs|S)zOverride this method for additional preprocessing of each rule. :arg Rule rule: a rule to be processed. :returns: the same or modified Rule instance. rrr]rrrr\^szRuleRouter.process_rulercKsV|jD]J}|j|}|dk r|jr.|j|d<|j|j|f|}|dk r|SqdS)N target_kwargs)rPmatchermatchr`get_target_delegatetarget)rrrr] target_paramsr5rrrr fs    zRuleRouter.find_handler)rdrrercKspt|tr|j|f|St|tjrB|jdk s2t||j|jSt |rl|jdk sXtt t |f||jSdS)aReturns 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 rHTTPServerConnectionDelegater9r=r%r:callablerr)rrdrrerrrrcxs   zRuleRouter.get_target_delegate)N)r&r'r(r)r _RuleListr6rQr\rr*r r+r rcrrrrrN,s  rNcsXeZdZdZd eeddfdd Zdddfdd Zee eed d d Z Z S)ReversibleRuleRouteraA 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`). NrOcsi|_t|dSr#) named_rulessuperr6rR __class__rrr6szReversibleRuleRouter.__init__rLr^cs<t|}|jr8|j|jkr,td|j||j|j<|S)Nz4Multiple handlers named %s; replacing previous value)rkr\r0rjrwarningr_rlrrr\s   z!ReversibleRuleRouter.process_ruler/cGsZ||jkr|j|jj|S|jD]2}t|jtr"|jj|f|}|dk r"|Sq"dSr#)rjrareverserPr;rdr.r2)rr0r1r]Z reversed_urlrrrr2s    z ReversibleRuleRouter.reverse_url)N) r&r'r(r)rrhr6r\r3r r2 __classcell__rrrlrris ric@sZeZdZdZd deeeeefeeddddZeeeddd Z ed d d Z dS)rLzA routing rule.NrM)rardr`r0rcCs6t|trt|}||_||_|r&|ni|_||_dS)adConstructs 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;r3r rardr`r0)rrardr`r0rrrr6s  z Rule.__init__r1rcGs |jj|Sr#)rarorr1rrrrosz Rule.reverserEcCsd|jj|j|j|j|jfSNz%s(%r, %s, kwargs=%r, name=%r))rmr&rardr`r0rGrrr__repr__sz Rule.__repr__)NN) r&r'r(r)r rrr3r6rortrrrrrLs !c@sBeZdZdZejeeee fdddZ e eedddZ dS) rMz*Represents a matcher for request features.rrcCs tdS)a1Matches current instance against the request. :arg httputil.HTTPServerRequest request: current HTTP request :returns: a dict of parameters to be passed to the target handler (for example, ``handler_kwargs``, ``path_args``, ``path_kwargs`` can be passed for proper `~.web.RequestHandler` instantiation). An empty dict is a valid (and common) return value to indicate a match when the argument-passing features are not used. ``None`` must be returned to indicate that there is no match.Nrrrrrrrbs z Matcher.matchrqcGsdS)zEReconstructs full url from matcher instance and additional arguments.NrrrrrrroszMatcher.reverseN) r&r'r(r)rr*rrr3r rbrorrrrrMs c@s.eZdZdZejeeee fdddZ dS) AnyMatcheszMatches any request.rucCsiSr#rrvrrrrbszAnyMatches.matchN) r&r'r(r)rr*rrr3r rbrrrrrwsrwc@sFeZdZdZeeefddddZej e e ee fdddZ dS) HostMatchesz@Matches requests from hosts specified by ``host_pattern`` regex.N) host_patternrcCs4t|tr*|ds|d7}t||_n||_dS)N$)r;r endswithrecompilery)rryrrrr6s   zHostMatches.__init__rucCs|j|jriSdSr#)ryrbZ host_namervrrrrbszHostMatches.match)r&r'r(r)rr3rr6rr*rrr rbrrrrrxsrxc@s@eZdZdZeeddddZeje e e efdddZ dS) DefaultHostMatcheszMatches requests from host that is equal to application's default_host. Always returns no match if ``X-Real-Ip`` header is present. N) applicationryrcCs||_||_dSr#)rry)rrryrrrr6szDefaultHostMatches.__init__rucCs"d|jkr|j|jjriSdS)Nz X-Real-Ip)r8ryrbrZ default_hostrvrrrrb s zDefaultHostMatches.match) r&r'r(r)r rr6rr*rrr3rbrrrrr~sr~c@sxeZdZdZeeefddddZej e e ee fdddZ e e ed d d Zee ee efd d dZdS)rZz@Matches requests with paths specified by ``path_pattern`` regex.N) path_patternrcCslt|tr*|ds|d7}t||_n||_t|jjd|jjfksXt d|jj | \|_ |_ dS)NrzrzDgroups in url regexes must either be all named or all positional: %r)r;r r{r|r}regexrY groupindexgroupsr=pattern _find_groups_path _group_count)rrrrrr6+s  zPathMatches.__init__rucCsp|j|j}|dkrdS|jjs&iSg}i}|jjrRtdd|D}ndd|D}t||dS)Ncss"|]\}}t|t|fVqdSr#)r3_unquote_or_none).0kvrrr Isz$PathMatches.match..cSsg|] }t|qSr)r)rsrrr Msz%PathMatches.match..) path_args path_kwargs)rrbr@rrdict groupdictitems)rrrbrrrrrrb:s zPathMatches.matchrqcGs|jdkrtd|jjt||jks0tdt|s>|jSg}|D]0}t|tt fs`t |}| t t |ddqF|jt|S)NzCannot reverse url regex z&required number of arguments not foundF)plus)r ValueErrorrrrYrr=r;r rKr3r[rrrW)rr1Zconverted_argsarrrroQs zPathMatches.reverserEc Cs|jj}|dr|dd}|dr4|dd}|jj|dkrJdSg}|dD]}d|kr|d}|d krzt||dd}Wnt k rYdSX| d |qXz t|}Wnt k rYdSX| |qXd ||jjfS) zReturns a tuple (reverse string, group count) for a url. For example: Given the url pattern /([0-9]{4})/([a-z-]+)/, this method would return ('/%s/%s/', 2). ^rVNrz()NN)rz%s) rr startswithr{rcountsplitindexr rr[join)rrpiecesfragmentZ paren_locZunescaped_fragmentrrrr`s.         zPathMatches._find_groups)r&r'r(r)rr3rr6rr*rrr rbrorintrrrrrrZ(s rZcsVeZdZdZd eeefeee eefeeddfdd Z edddZ Z S) URLSpeczSpecifies 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. N)rhandlerrr0rcs4t|}t|||||j|_|j|_||_dS)aParameters: * ``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)rZrkr6rrd handler_classr)rrrrr0rarlrrr6s zURLSpec.__init__rEcCs d|jj|jj|j|j|jfSrs)rmr&rrrrr0rGrrrrtszURLSpec.__repr__)NN) r&r'r(r)rr3rr rrr6rtrprrrlrrs  r)rrcCsdSr#rrrrrrsrcCsdSr#rrrrrrscCs|dkr |St|dddS)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)rrrrrrs)1r)r| functoolsrZtornadorZtornado.httpserverrZtornado.escaperrrZ tornado.logrZ tornado.utilr r r r typingr rrrrrrrrrfrr.r+r$rAr3rhrNrir,rLrMrwrxr~rZrrKrrrrrsJ$    ,. h%1a1