Главная Обзор Помощь
Вход
chendeben
/
ProxyPool
1
0
Ответвить 0
Файлы Задачи 0 Запросы на слияние 0 Вики
Дерево: 72e024a6fc
Ветки Метки
ProxyPool
/
docs
/
_build
/
html
/
_modules
/
werkzeug
/
routing.html

routing.html 205 KB
История Исходник

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>werkzeug.routing &#8212; proxypool  documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    13. 

  13.     
    14. 

  14.     <script type="text/javascript">
    15. 

  15.       var DOCUMENTATION_OPTIONS = {
    16. 

  16.         URL_ROOT:    '../../',
    17. 

  17.         VERSION:     '',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

  23.     <script type="text/javascript" src="../../_static/jquery.js"></script>
    24. 

  24.     <script type="text/javascript" src="../../_static/underscore.js"></script>
    25. 

  25.     <script type="text/javascript" src="../../_static/doctools.js"></script>
    26. 

  26.     <link rel="index" title="Index" href="../../genindex.html" />
    27. 

  27.     <link rel="search" title="Search" href="../../search.html" />
    28. 

  28.     <link rel="top" title="proxypool  documentation" href="../../index.html" />
    29. 

  29.     <link rel="up" title="Module code" href="../index.html" />
    30. 

  30.    
    31. 

  31.   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
    32. 

  32.   
    33. 

  33.   
    34. 

  34.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    35. 

  35. 

  36.   </head>
    37. 

  37.   <body role="document">
    38. 

  38.   
    39. 

  39. 

  40.     <div class="document">
    41. 

  41.       <div class="documentwrapper">
    42. 

  42.         <div class="bodywrapper">
    43. 

  43.           <div class="body" role="main">
    44. 

  44.             
    45. 

  45.   <h1>Source code for werkzeug.routing</h1><div class="highlight"><pre>
    46. 

  46. <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
    47. 

  47. <span class="sd">&quot;&quot;&quot;</span>
    48. 

  48. <span class="sd">    werkzeug.routing</span>
    49. 

  49. <span class="sd">    ~~~~~~~~~~~~~~~~</span>
    50. 

  50. 

  51. <span class="sd">    When it comes to combining multiple controller or view functions (however</span>
    52. 

  52. <span class="sd">    you want to call them) you need a dispatcher.  A simple way would be</span>
    53. 

  53. <span class="sd">    applying regular expression tests on the ``PATH_INFO`` and calling</span>
    54. 

  54. <span class="sd">    registered callback functions that return the value then.</span>
    55. 

  55. 

  56. <span class="sd">    This module implements a much more powerful system than simple regular</span>
    57. 

  57. <span class="sd">    expression matching because it can also convert values in the URLs and</span>
    58. 

  58. <span class="sd">    build URLs.</span>
    59. 

  59. 

  60. <span class="sd">    Here a simple example that creates an URL map for an application with</span>
    61. 

  61. <span class="sd">    two subdomains (www and kb) and some URL rules:</span>
    62. 

  62. 

  63. <span class="sd">    &gt;&gt;&gt; m = Map([</span>
    64. 

  64. <span class="sd">    ...     # Static URLs</span>
    65. 

  65. <span class="sd">    ...     Rule(&#39;/&#39;, endpoint=&#39;static/index&#39;),</span>
    66. 

  66. <span class="sd">    ...     Rule(&#39;/about&#39;, endpoint=&#39;static/about&#39;),</span>
    67. 

  67. <span class="sd">    ...     Rule(&#39;/help&#39;, endpoint=&#39;static/help&#39;),</span>
    68. 

  68. <span class="sd">    ...     # Knowledge Base</span>
    69. 

  69. <span class="sd">    ...     Subdomain(&#39;kb&#39;, [</span>
    70. 

  70. <span class="sd">    ...         Rule(&#39;/&#39;, endpoint=&#39;kb/index&#39;),</span>
    71. 

  71. <span class="sd">    ...         Rule(&#39;/browse/&#39;, endpoint=&#39;kb/browse&#39;),</span>
    72. 

  72. <span class="sd">    ...         Rule(&#39;/browse/&lt;int:id&gt;/&#39;, endpoint=&#39;kb/browse&#39;),</span>
    73. 

  73. <span class="sd">    ...         Rule(&#39;/browse/&lt;int:id&gt;/&lt;int:page&gt;&#39;, endpoint=&#39;kb/browse&#39;)</span>
    74. 

  74. <span class="sd">    ...     ])</span>
    75. 

  75. <span class="sd">    ... ], default_subdomain=&#39;www&#39;)</span>
    76. 

  76. 

  77. <span class="sd">    If the application doesn&#39;t use subdomains it&#39;s perfectly fine to not set</span>
    78. 

  78. <span class="sd">    the default subdomain and not use the `Subdomain` rule factory.  The endpoint</span>
    79. 

  79. <span class="sd">    in the rules can be anything, for example import paths or unique</span>
    80. 

  80. <span class="sd">    identifiers.  The WSGI application can use those endpoints to get the</span>
    81. 

  81. <span class="sd">    handler for that URL.  It doesn&#39;t have to be a string at all but it&#39;s</span>
    82. 

  82. <span class="sd">    recommended.</span>
    83. 

  83. 

  84. <span class="sd">    Now it&#39;s possible to create a URL adapter for one of the subdomains and</span>
    85. 

  85. <span class="sd">    build URLs:</span>
    86. 

  86. 

  87. <span class="sd">    &gt;&gt;&gt; c = m.bind(&#39;example.com&#39;)</span>
    88. 

  88. <span class="sd">    &gt;&gt;&gt; c.build(&quot;kb/browse&quot;, dict(id=42))</span>
    89. 

  89. <span class="sd">    &#39;http://kb.example.com/browse/42/&#39;</span>
    90. 

  90. <span class="sd">    &gt;&gt;&gt; c.build(&quot;kb/browse&quot;, dict())</span>
    91. 

  91. <span class="sd">    &#39;http://kb.example.com/browse/&#39;</span>
    92. 

  92. <span class="sd">    &gt;&gt;&gt; c.build(&quot;kb/browse&quot;, dict(id=42, page=3))</span>
    93. 

  93. <span class="sd">    &#39;http://kb.example.com/browse/42/3&#39;</span>
    94. 

  94. <span class="sd">    &gt;&gt;&gt; c.build(&quot;static/about&quot;)</span>
    95. 

  95. <span class="sd">    &#39;/about&#39;</span>
    96. 

  96. <span class="sd">    &gt;&gt;&gt; c.build(&quot;static/index&quot;, force_external=True)</span>
    97. 

  97. <span class="sd">    &#39;http://www.example.com/&#39;</span>
    98. 

  98. 

  99. <span class="sd">    &gt;&gt;&gt; c = m.bind(&#39;example.com&#39;, subdomain=&#39;kb&#39;)</span>
    100. 

  100. <span class="sd">    &gt;&gt;&gt; c.build(&quot;static/about&quot;)</span>
    101. 

  101. <span class="sd">    &#39;http://www.example.com/about&#39;</span>
    102. 

  102. 

  103. <span class="sd">    The first argument to bind is the server name *without* the subdomain.</span>
    104. 

  104. <span class="sd">    Per default it will assume that the script is mounted on the root, but</span>
    105. 

  105. <span class="sd">    often that&#39;s not the case so you can provide the real mount point as</span>
    106. 

  106. <span class="sd">    second argument:</span>
    107. 

  107. 

  108. <span class="sd">    &gt;&gt;&gt; c = m.bind(&#39;example.com&#39;, &#39;/applications/example&#39;)</span>
    109. 

  109. 

  110. <span class="sd">    The third argument can be the subdomain, if not given the default</span>
    111. 

  111. <span class="sd">    subdomain is used.  For more details about binding have a look at the</span>
    112. 

  112. <span class="sd">    documentation of the `MapAdapter`.</span>
    113. 

  113. 

  114. <span class="sd">    And here is how you can match URLs:</span>
    115. 

  115. 

  116. <span class="sd">    &gt;&gt;&gt; c = m.bind(&#39;example.com&#39;)</span>
    117. 

  117. <span class="sd">    &gt;&gt;&gt; c.match(&quot;/&quot;)</span>
    118. 

  118. <span class="sd">    (&#39;static/index&#39;, {})</span>
    119. 

  119. <span class="sd">    &gt;&gt;&gt; c.match(&quot;/about&quot;)</span>
    120. 

  120. <span class="sd">    (&#39;static/about&#39;, {})</span>
    121. 

  121. <span class="sd">    &gt;&gt;&gt; c = m.bind(&#39;example.com&#39;, &#39;/&#39;, &#39;kb&#39;)</span>
    122. 

  122. <span class="sd">    &gt;&gt;&gt; c.match(&quot;/&quot;)</span>
    123. 

  123. <span class="sd">    (&#39;kb/index&#39;, {})</span>
    124. 

  124. <span class="sd">    &gt;&gt;&gt; c.match(&quot;/browse/42/23&quot;)</span>
    125. 

  125. <span class="sd">    (&#39;kb/browse&#39;, {&#39;id&#39;: 42, &#39;page&#39;: 23})</span>
    126. 

  126. 

  127. <span class="sd">    If matching fails you get a `NotFound` exception, if the rule thinks</span>
    128. 

  128. <span class="sd">    it&#39;s a good idea to redirect (for example because the URL was defined</span>
    129. 

  129. <span class="sd">    to have a slash at the end but the request was missing that slash) it</span>
    130. 

  130. <span class="sd">    will raise a `RequestRedirect` exception.  Both are subclasses of the</span>
    131. 

  131. <span class="sd">    `HTTPException` so you can use those errors as responses in the</span>
    132. 

  132. <span class="sd">    application.</span>
    133. 

  133. 

  134. <span class="sd">    If matching succeeded but the URL rule was incompatible to the given</span>
    135. 

  135. <span class="sd">    method (for example there were only rules for `GET` and `HEAD` and</span>
    136. 

  136. <span class="sd">    routing system tried to match a `POST` request) a `MethodNotAllowed`</span>
    137. 

  137. <span class="sd">    method is raised.</span>
    138. 

  138. 

  139. 

  140. <span class="sd">    :copyright: (c) 2014 by the Werkzeug Team, see AUTHORS for more details.</span>
    141. 

  141. <span class="sd">    :license: BSD, see LICENSE for more details.</span>
    142. 

  142. <span class="sd">&quot;&quot;&quot;</span>
    143. 

  143. <span class="kn">import</span> <span class="nn">difflib</span>
    144. 

  144. <span class="kn">import</span> <span class="nn">re</span>
    145. 

  145. <span class="kn">import</span> <span class="nn">uuid</span>
    146. 

  146. <span class="kn">import</span> <span class="nn">posixpath</span>
    147. 

  147. 

  148. <span class="kn">from</span> <span class="nn">pprint</span> <span class="k">import</span> <span class="n">pformat</span>
    149. 

  149. <span class="kn">from</span> <span class="nn">threading</span> <span class="k">import</span> <span class="n">Lock</span>
    150. 

  150. 

  151. <span class="kn">from</span> <span class="nn">werkzeug.urls</span> <span class="k">import</span> <span class="n">url_encode</span><span class="p">,</span> <span class="n">url_quote</span><span class="p">,</span> <span class="n">url_join</span>
    152. 

  152. <span class="kn">from</span> <span class="nn">werkzeug.utils</span> <span class="k">import</span> <span class="n">redirect</span><span class="p">,</span> <span class="n">format_string</span>
    153. 

  153. <span class="kn">from</span> <span class="nn">werkzeug.exceptions</span> <span class="k">import</span> <span class="n">HTTPException</span><span class="p">,</span> <span class="n">NotFound</span><span class="p">,</span> <span class="n">MethodNotAllowed</span><span class="p">,</span> \
    154. 

  154.      <span class="n">BadHost</span>
    155. 

  155. <span class="kn">from</span> <span class="nn">werkzeug._internal</span> <span class="k">import</span> <span class="n">_get_environ</span><span class="p">,</span> <span class="n">_encode_idna</span>
    156. 

  156. <span class="kn">from</span> <span class="nn">werkzeug._compat</span> <span class="k">import</span> <span class="n">itervalues</span><span class="p">,</span> <span class="n">iteritems</span><span class="p">,</span> <span class="n">to_unicode</span><span class="p">,</span> <span class="n">to_bytes</span><span class="p">,</span> \
    157. 

  157.     <span class="n">text_type</span><span class="p">,</span> <span class="n">string_types</span><span class="p">,</span> <span class="n">native_string_result</span><span class="p">,</span> \
    158. 

  158.     <span class="n">implements_to_string</span><span class="p">,</span> <span class="n">wsgi_decoding_dance</span>
    159. 

  159. <span class="kn">from</span> <span class="nn">werkzeug.datastructures</span> <span class="k">import</span> <span class="n">ImmutableDict</span><span class="p">,</span> <span class="n">MultiDict</span>
    160. 

  160. 

  161. 

  162. <span class="n">_rule_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r&#39;&#39;&#39;</span>
    163. 

  163. <span class="s1">    (?P&lt;static&gt;[^&lt;]*)                           # static rule data</span>
    164. 

  164. <span class="s1">    &lt;</span>
    165. 

  165. <span class="s1">    (?:</span>
    166. 

  166. <span class="s1">        (?P&lt;converter&gt;[a-zA-Z_][a-zA-Z0-9_]*)   # converter name</span>
    167. 

  167. <span class="s1">        (?:\((?P&lt;args&gt;.*?)\))?                  # converter arguments</span>
    168. 

  168. <span class="s1">        \:                                      # variable delimiter</span>
    169. 

  169. <span class="s1">    )?</span>
    170. 

  170. <span class="s1">    (?P&lt;variable&gt;[a-zA-Z_][a-zA-Z0-9_]*)        # variable name</span>
    171. 

  171. <span class="s1">    &gt;</span>
    172. 

  172. <span class="s1">&#39;&#39;&#39;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">VERBOSE</span><span class="p">)</span>
    173. 

  173. <span class="n">_simple_rule_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r&#39;&lt;([^&gt;]+)&gt;&#39;</span><span class="p">)</span>
    174. 

  174. <span class="n">_converter_args_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r&#39;&#39;&#39;</span>
    175. 

  175. <span class="s1">    ((?P&lt;name&gt;\w+)\s*=\s*)?</span>
    176. 

  176. <span class="s1">    (?P&lt;value&gt;</span>
    177. 

  177. <span class="s1">        True|False|</span>
    178. 

  178. <span class="s1">        \d+.\d+|</span>
    179. 

  179. <span class="s1">        \d+.|</span>
    180. 

  180. <span class="s1">        \d+|</span>
    181. 

  181. <span class="s1">        \w+|</span>
    182. 

  182. <span class="s1">        [urUR]?(?P&lt;stringval&gt;&quot;[^&quot;]*?&quot;|&#39;[^&#39;]*&#39;)</span>
    183. 

  183. <span class="s1">    )\s*,</span>
    184. 

  184. <span class="s1">&#39;&#39;&#39;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">VERBOSE</span> <span class="o">|</span> <span class="n">re</span><span class="o">.</span><span class="n">UNICODE</span><span class="p">)</span>
    185. 

  185. 

  186. 

  187. <span class="n">_PYTHON_CONSTANTS</span> <span class="o">=</span> <span class="p">{</span>
    188. 

  188.     <span class="s1">&#39;None&#39;</span><span class="p">:</span>     <span class="kc">None</span><span class="p">,</span>
    189. 

  189.     <span class="s1">&#39;True&#39;</span><span class="p">:</span>     <span class="kc">True</span><span class="p">,</span>
    190. 

  190.     <span class="s1">&#39;False&#39;</span><span class="p">:</span>    <span class="kc">False</span>
    191. 

  191. <span class="p">}</span>
    192. 

  192. 

  193. 

  194. <span class="k">def</span> <span class="nf">_pythonize</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
    195. 

  195.     <span class="k">if</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">_PYTHON_CONSTANTS</span><span class="p">:</span>
    196. 

  196.         <span class="k">return</span> <span class="n">_PYTHON_CONSTANTS</span><span class="p">[</span><span class="n">value</span><span class="p">]</span>
    197. 

  197.     <span class="k">for</span> <span class="n">convert</span> <span class="ow">in</span> <span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">:</span>
    198. 

  198.         <span class="k">try</span><span class="p">:</span>
    199. 

  199.             <span class="k">return</span> <span class="n">convert</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    200. 

  200.         <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
    201. 

  201.             <span class="k">pass</span>
    202. 

  202.     <span class="k">if</span> <span class="n">value</span><span class="p">[:</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">value</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">:]</span> <span class="ow">and</span> <span class="n">value</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="s1">&#39;&quot;</span><span class="se">\&#39;</span><span class="s1">&#39;</span><span class="p">:</span>
    203. 

  203.         <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    204. 

  204.     <span class="k">return</span> <span class="n">text_type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    205. 

  205. 

  206. 

  207. <span class="k">def</span> <span class="nf">parse_converter_args</span><span class="p">(</span><span class="n">argstr</span><span class="p">):</span>
    208. 

  208.     <span class="n">argstr</span> <span class="o">+=</span> <span class="s1">&#39;,&#39;</span>
    209. 

  209.     <span class="n">args</span> <span class="o">=</span> <span class="p">[]</span>
    210. 

  210.     <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
    211. 

  211. 

  212.     <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">_converter_args_re</span><span class="o">.</span><span class="n">finditer</span><span class="p">(</span><span class="n">argstr</span><span class="p">):</span>
    213. 

  213.         <span class="n">value</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;stringval&#39;</span><span class="p">)</span>
    214. 

  214.         <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    215. 

  215.             <span class="n">value</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;value&#39;</span><span class="p">)</span>
    216. 

  216.         <span class="n">value</span> <span class="o">=</span> <span class="n">_pythonize</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    217. 

  217.         <span class="k">if</span> <span class="ow">not</span> <span class="n">item</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">):</span>
    218. 

  218.             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    219. 

  219.         <span class="k">else</span><span class="p">:</span>
    220. 

  220.             <span class="n">name</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">)</span>
    221. 

  221.             <span class="n">kwargs</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
    222. 

  222. 

  223.     <span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">args</span><span class="p">),</span> <span class="n">kwargs</span>
    224. 

  224. 

  225. 

  226. <span class="k">def</span> <span class="nf">parse_rule</span><span class="p">(</span><span class="n">rule</span><span class="p">):</span>
    227. 

  227.     <span class="sd">&quot;&quot;&quot;Parse a rule and return it as generator. Each iteration yields tuples</span>
    228. 

  228. <span class="sd">    in the form ``(converter, arguments, variable)``. If the converter is</span>
    229. 

  229. <span class="sd">    `None` it&#39;s a static url part, otherwise it&#39;s a dynamic one.</span>
    230. 

  230. 

  231. <span class="sd">    :internal:</span>
    232. 

  232. <span class="sd">    &quot;&quot;&quot;</span>
    233. 

  233.     <span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span>
    234. 

  234.     <span class="n">end</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">rule</span><span class="p">)</span>
    235. 

  235.     <span class="n">do_match</span> <span class="o">=</span> <span class="n">_rule_re</span><span class="o">.</span><span class="n">match</span>
    236. 

  236.     <span class="n">used_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    237. 

  237.     <span class="k">while</span> <span class="n">pos</span> <span class="o">&lt;</span> <span class="n">end</span><span class="p">:</span>
    238. 

  238.         <span class="n">m</span> <span class="o">=</span> <span class="n">do_match</span><span class="p">(</span><span class="n">rule</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
    239. 

  239.         <span class="k">if</span> <span class="n">m</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    240. 

  240.             <span class="k">break</span>
    241. 

  241.         <span class="n">data</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()</span>
    242. 

  242.         <span class="k">if</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;static&#39;</span><span class="p">]:</span>
    243. 

  243.             <span class="k">yield</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;static&#39;</span><span class="p">]</span>
    244. 

  244.         <span class="n">variable</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;variable&#39;</span><span class="p">]</span>
    245. 

  245.         <span class="n">converter</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;converter&#39;</span><span class="p">]</span> <span class="ow">or</span> <span class="s1">&#39;default&#39;</span>
    246. 

  246.         <span class="k">if</span> <span class="n">variable</span> <span class="ow">in</span> <span class="n">used_names</span><span class="p">:</span>
    247. 

  247.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;variable name </span><span class="si">%r</span><span class="s1"> used twice.&#39;</span> <span class="o">%</span> <span class="n">variable</span><span class="p">)</span>
    248. 

  248.         <span class="n">used_names</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">variable</span><span class="p">)</span>
    249. 

  249.         <span class="k">yield</span> <span class="n">converter</span><span class="p">,</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;args&#39;</span><span class="p">]</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span> <span class="n">variable</span>
    250. 

  250.         <span class="n">pos</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">end</span><span class="p">()</span>
    251. 

  251.     <span class="k">if</span> <span class="n">pos</span> <span class="o">&lt;</span> <span class="n">end</span><span class="p">:</span>
    252. 

  252.         <span class="n">remaining</span> <span class="o">=</span> <span class="n">rule</span><span class="p">[</span><span class="n">pos</span><span class="p">:]</span>
    253. 

  253.         <span class="k">if</span> <span class="s1">&#39;&gt;&#39;</span> <span class="ow">in</span> <span class="n">remaining</span> <span class="ow">or</span> <span class="s1">&#39;&lt;&#39;</span> <span class="ow">in</span> <span class="n">remaining</span><span class="p">:</span>
    254. 

  254.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;malformed url rule: </span><span class="si">%r</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">rule</span><span class="p">)</span>
    255. 

  255.         <span class="k">yield</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">remaining</span>
    256. 

  256. 

  257. 

  258. <span class="k">class</span> <span class="nc">RoutingException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    259. 

  259. 

  260.     <span class="sd">&quot;&quot;&quot;Special exceptions that require the application to redirect, notifying</span>
    261. 

  261. <span class="sd">    about missing urls, etc.</span>
    262. 

  262. 

  263. <span class="sd">    :internal:</span>
    264. 

  264. <span class="sd">    &quot;&quot;&quot;</span>
    265. 

  265. 

  266. 

  267. <span class="k">class</span> <span class="nc">RequestRedirect</span><span class="p">(</span><span class="n">HTTPException</span><span class="p">,</span> <span class="n">RoutingException</span><span class="p">):</span>
    268. 

  268. 

  269.     <span class="sd">&quot;&quot;&quot;Raise if the map requests a redirect. This is for example the case if</span>
    270. 

  270. <span class="sd">    `strict_slashes` are activated and an url that requires a trailing slash.</span>
    271. 

  271. 

  272. <span class="sd">    The attribute `new_url` contains the absolute destination url.</span>
    273. 

  273. <span class="sd">    &quot;&quot;&quot;</span>
    274. 

  274.     <span class="n">code</span> <span class="o">=</span> <span class="mi">301</span>
    275. 

  275. 

  276.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">new_url</span><span class="p">):</span>
    277. 

  277.         <span class="n">RoutingException</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">new_url</span><span class="p">)</span>
    278. 

  278.         <span class="bp">self</span><span class="o">.</span><span class="n">new_url</span> <span class="o">=</span> <span class="n">new_url</span>
    279. 

  279. 

  280.     <span class="k">def</span> <span class="nf">get_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">):</span>
    281. 

  281.         <span class="k">return</span> <span class="n">redirect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">new_url</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">code</span><span class="p">)</span>
    282. 

  282. 

  283. 

  284. <span class="k">class</span> <span class="nc">RequestSlash</span><span class="p">(</span><span class="n">RoutingException</span><span class="p">):</span>
    285. 

  285. 

  286.     <span class="sd">&quot;&quot;&quot;Internal exception.&quot;&quot;&quot;</span>
    287. 

  287. 

  288. 

  289. <span class="k">class</span> <span class="nc">RequestAliasRedirect</span><span class="p">(</span><span class="n">RoutingException</span><span class="p">):</span>
    290. 

  290. 

  291.     <span class="sd">&quot;&quot;&quot;This rule is an alias and wants to redirect to the canonical URL.&quot;&quot;&quot;</span>
    292. 

  292. 

  293.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">matched_values</span><span class="p">):</span>
    294. 

  294.         <span class="bp">self</span><span class="o">.</span><span class="n">matched_values</span> <span class="o">=</span> <span class="n">matched_values</span>
    295. 

  295. 

  296. 

  297. <span class="k">class</span> <span class="nc">BuildError</span><span class="p">(</span><span class="n">RoutingException</span><span class="p">,</span> <span class="ne">LookupError</span><span class="p">):</span>
    298. 

  298. 

  299.     <span class="sd">&quot;&quot;&quot;Raised if the build system cannot find a URL for an endpoint with the</span>
    300. 

  300. <span class="sd">    values provided.</span>
    301. 

  301. <span class="sd">    &quot;&quot;&quot;</span>
    302. 

  302. 

  303.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">adapter</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    304. 

  304.         <span class="ne">LookupError</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">)</span>
    305. 

  305.         <span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span> <span class="o">=</span> <span class="n">endpoint</span>
    306. 

  306.         <span class="bp">self</span><span class="o">.</span><span class="n">values</span> <span class="o">=</span> <span class="n">values</span>
    307. 

  307.         <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">method</span>
    308. 

  308.         <span class="bp">self</span><span class="o">.</span><span class="n">suggested</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">closest_rule</span><span class="p">(</span><span class="n">adapter</span><span class="p">)</span>
    309. 

  309. 

  310.     <span class="k">def</span> <span class="nf">closest_rule</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">adapter</span><span class="p">):</span>
    311. 

  311.         <span class="k">def</span> <span class="nf">score_rule</span><span class="p">(</span><span class="n">rule</span><span class="p">):</span>
    312. 

  312.             <span class="k">return</span> <span class="nb">sum</span><span class="p">([</span>
    313. 

  313.                 <span class="mf">0.98</span> <span class="o">*</span> <span class="n">difflib</span><span class="o">.</span><span class="n">SequenceMatcher</span><span class="p">(</span>
    314. 

  314.                     <span class="kc">None</span><span class="p">,</span> <span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span>
    315. 

  315.                 <span class="p">)</span><span class="o">.</span><span class="n">ratio</span><span class="p">(),</span>
    316. 

  316.                 <span class="mf">0.01</span> <span class="o">*</span> <span class="nb">bool</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">values</span> <span class="ow">or</span> <span class="p">())</span><span class="o">.</span><span class="n">issubset</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">arguments</span><span class="p">)),</span>
    317. 

  317.                 <span class="mf">0.01</span> <span class="o">*</span> <span class="nb">bool</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">methods</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="ow">in</span> <span class="n">rule</span><span class="o">.</span><span class="n">methods</span><span class="p">)</span>
    318. 

  318.             <span class="p">])</span>
    319. 

  319. 

  320.         <span class="k">if</span> <span class="n">adapter</span> <span class="ow">and</span> <span class="n">adapter</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">_rules</span><span class="p">:</span>
    321. 

  321.             <span class="k">return</span> <span class="nb">max</span><span class="p">(</span><span class="n">adapter</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">_rules</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">score_rule</span><span class="p">)</span>
    322. 

  322.         <span class="k">else</span><span class="p">:</span>
    323. 

  323.             <span class="k">return</span> <span class="kc">None</span>
    324. 

  324. 

  325.     <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    326. 

  326.         <span class="n">message</span> <span class="o">=</span> <span class="p">[]</span>
    327. 

  327.         <span class="n">message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;Could not build url for endpoint </span><span class="si">%r</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span><span class="p">)</span>
    328. 

  328.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span><span class="p">:</span>
    329. 

  329.             <span class="n">message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot; (</span><span class="si">%r</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span><span class="p">)</span>
    330. 

  330.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="p">:</span>
    331. 

  331.             <span class="n">message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot; with values </span><span class="si">%r</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
    332. 

  332.         <span class="n">message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">)</span>
    333. 

  333.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">suggested</span><span class="p">:</span>
    334. 

  334.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">suggested</span><span class="o">.</span><span class="n">endpoint</span><span class="p">:</span>
    335. 

  335.                 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">suggested</span><span class="o">.</span><span class="n">methods</span><span class="p">:</span>
    336. 

  336.                     <span class="n">message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot; Did you mean to use methods </span><span class="si">%r</span><span class="s2">?&quot;</span> <span class="o">%</span> <span class="nb">sorted</span><span class="p">(</span>
    337. 

  337.                         <span class="bp">self</span><span class="o">.</span><span class="n">suggested</span><span class="o">.</span><span class="n">methods</span>
    338. 

  338.                     <span class="p">))</span>
    339. 

  339.                 <span class="n">missing_values</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">suggested</span><span class="o">.</span><span class="n">arguments</span><span class="o">.</span><span class="n">union</span><span class="p">(</span>
    340. 

  340.                     <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">suggested</span><span class="o">.</span><span class="n">defaults</span> <span class="ow">or</span> <span class="p">())</span>
    341. 

  341.                 <span class="p">)</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
    342. 

  342.                 <span class="k">if</span> <span class="n">missing_values</span><span class="p">:</span>
    343. 

  343.                     <span class="n">message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
    344. 

  344.                         <span class="s2">&quot; Did you forget to specify values </span><span class="si">%r</span><span class="s2">?&quot;</span> <span class="o">%</span>
    345. 

  345.                         <span class="nb">sorted</span><span class="p">(</span><span class="n">missing_values</span><span class="p">)</span>
    346. 

  346.                     <span class="p">)</span>
    347. 

  347.             <span class="k">else</span><span class="p">:</span>
    348. 

  348.                 <span class="n">message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
    349. 

  349.                     <span class="s2">&quot; Did you mean </span><span class="si">%r</span><span class="s2"> instead?&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">suggested</span><span class="o">.</span><span class="n">endpoint</span>
    350. 

  350.                 <span class="p">)</span>
    351. 

  351.         <span class="k">return</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
    352. 

  352. 

  353. 

  354. <span class="k">class</span> <span class="nc">ValidationError</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
    355. 

  355. 

  356.     <span class="sd">&quot;&quot;&quot;Validation error.  If a rule converter raises this exception the rule</span>
    357. 

  357. <span class="sd">    does not match the current URL and the next URL is tried.</span>
    358. 

  358. <span class="sd">    &quot;&quot;&quot;</span>
    359. 

  359. 

  360. 

  361. <span class="k">class</span> <span class="nc">RuleFactory</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    362. 

  362. 

  363.     <span class="sd">&quot;&quot;&quot;As soon as you have more complex URL setups it&#39;s a good idea to use rule</span>
    364. 

  364. <span class="sd">    factories to avoid repetitive tasks.  Some of them are builtin, others can</span>
    365. 

  365. <span class="sd">    be added by subclassing `RuleFactory` and overriding `get_rules`.</span>
    366. 

  366. <span class="sd">    &quot;&quot;&quot;</span>
    367. 

  367. 

  368.     <span class="k">def</span> <span class="nf">get_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">):</span>
    369. 

  369.         <span class="sd">&quot;&quot;&quot;Subclasses of `RuleFactory` have to override this method and return</span>
    370. 

  370. <span class="sd">        an iterable of rules.&quot;&quot;&quot;</span>
    371. 

  371.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    372. 

  372. 

  373. 

  374. <span class="k">class</span> <span class="nc">Subdomain</span><span class="p">(</span><span class="n">RuleFactory</span><span class="p">):</span>
    375. 

  375. 

  376.     <span class="sd">&quot;&quot;&quot;All URLs provided by this factory have the subdomain set to a</span>
    377. 

  377. <span class="sd">    specific domain. For example if you want to use the subdomain for</span>
    378. 

  378. <span class="sd">    the current language this can be a good setup::</span>
    379. 

  379. 

  380. <span class="sd">        url_map = Map([</span>
    381. 

  381. <span class="sd">            Rule(&#39;/&#39;, endpoint=&#39;#select_language&#39;),</span>
    382. 

  382. <span class="sd">            Subdomain(&#39;&lt;string(length=2):lang_code&gt;&#39;, [</span>
    383. 

  383. <span class="sd">                Rule(&#39;/&#39;, endpoint=&#39;index&#39;),</span>
    384. 

  384. <span class="sd">                Rule(&#39;/about&#39;, endpoint=&#39;about&#39;),</span>
    385. 

  385. <span class="sd">                Rule(&#39;/help&#39;, endpoint=&#39;help&#39;)</span>
    386. 

  386. <span class="sd">            ])</span>
    387. 

  387. <span class="sd">        ])</span>
    388. 

  388. 

  389. <span class="sd">    All the rules except for the ``&#39;#select_language&#39;`` endpoint will now</span>
    390. 

  390. <span class="sd">    listen on a two letter long subdomain that holds the language code</span>
    391. 

  391. <span class="sd">    for the current request.</span>
    392. 

  392. <span class="sd">    &quot;&quot;&quot;</span>
    393. 

  393. 

  394.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">subdomain</span><span class="p">,</span> <span class="n">rules</span><span class="p">):</span>
    395. 

  395.         <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">=</span> <span class="n">subdomain</span>
    396. 

  396.         <span class="bp">self</span><span class="o">.</span><span class="n">rules</span> <span class="o">=</span> <span class="n">rules</span>
    397. 

  397. 

  398.     <span class="k">def</span> <span class="nf">get_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">):</span>
    399. 

  399.         <span class="k">for</span> <span class="n">rulefactory</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">rules</span><span class="p">:</span>
    400. 

  400.             <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rulefactory</span><span class="o">.</span><span class="n">get_rules</span><span class="p">(</span><span class="nb">map</span><span class="p">):</span>
    401. 

  401.                 <span class="n">rule</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="n">empty</span><span class="p">()</span>
    402. 

  402.                 <span class="n">rule</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span>
    403. 

  403.                 <span class="k">yield</span> <span class="n">rule</span>
    404. 

  404. 

  405. 

  406. <span class="k">class</span> <span class="nc">Submount</span><span class="p">(</span><span class="n">RuleFactory</span><span class="p">):</span>
    407. 

  407. 

  408.     <span class="sd">&quot;&quot;&quot;Like `Subdomain` but prefixes the URL rule with a given string::</span>
    409. 

  409. 

  410. <span class="sd">        url_map = Map([</span>
    411. 

  411. <span class="sd">            Rule(&#39;/&#39;, endpoint=&#39;index&#39;),</span>
    412. 

  412. <span class="sd">            Submount(&#39;/blog&#39;, [</span>
    413. 

  413. <span class="sd">                Rule(&#39;/&#39;, endpoint=&#39;blog/index&#39;),</span>
    414. 

  414. <span class="sd">                Rule(&#39;/entry/&lt;entry_slug&gt;&#39;, endpoint=&#39;blog/show&#39;)</span>
    415. 

  415. <span class="sd">            ])</span>
    416. 

  416. <span class="sd">        ])</span>
    417. 

  417. 

  418. <span class="sd">    Now the rule ``&#39;blog/show&#39;`` matches ``/blog/entry/&lt;entry_slug&gt;``.</span>
    419. 

  419. <span class="sd">    &quot;&quot;&quot;</span>
    420. 

  420. 

  421.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">rules</span><span class="p">):</span>
    422. 

  422.         <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
    423. 

  423.         <span class="bp">self</span><span class="o">.</span><span class="n">rules</span> <span class="o">=</span> <span class="n">rules</span>
    424. 

  424. 

  425.     <span class="k">def</span> <span class="nf">get_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">):</span>
    426. 

  426.         <span class="k">for</span> <span class="n">rulefactory</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">rules</span><span class="p">:</span>
    427. 

  427.             <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rulefactory</span><span class="o">.</span><span class="n">get_rules</span><span class="p">(</span><span class="nb">map</span><span class="p">):</span>
    428. 

  428.                 <span class="n">rule</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="n">empty</span><span class="p">()</span>
    429. 

  429.                 <span class="n">rule</span><span class="o">.</span><span class="n">rule</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">+</span> <span class="n">rule</span><span class="o">.</span><span class="n">rule</span>
    430. 

  430.                 <span class="k">yield</span> <span class="n">rule</span>
    431. 

  431. 

  432. 

  433. <span class="k">class</span> <span class="nc">EndpointPrefix</span><span class="p">(</span><span class="n">RuleFactory</span><span class="p">):</span>
    434. 

  434. 

  435.     <span class="sd">&quot;&quot;&quot;Prefixes all endpoints (which must be strings for this factory) with</span>
    436. 

  436. <span class="sd">    another string. This can be useful for sub applications::</span>
    437. 

  437. 

  438. <span class="sd">        url_map = Map([</span>
    439. 

  439. <span class="sd">            Rule(&#39;/&#39;, endpoint=&#39;index&#39;),</span>
    440. 

  440. <span class="sd">            EndpointPrefix(&#39;blog/&#39;, [Submount(&#39;/blog&#39;, [</span>
    441. 

  441. <span class="sd">                Rule(&#39;/&#39;, endpoint=&#39;index&#39;),</span>
    442. 

  442. <span class="sd">                Rule(&#39;/entry/&lt;entry_slug&gt;&#39;, endpoint=&#39;show&#39;)</span>
    443. 

  443. <span class="sd">            ])])</span>
    444. 

  444. <span class="sd">        ])</span>
    445. 

  445. <span class="sd">    &quot;&quot;&quot;</span>
    446. 

  446. 

  447.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">rules</span><span class="p">):</span>
    448. 

  448.         <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span>
    449. 

  449.         <span class="bp">self</span><span class="o">.</span><span class="n">rules</span> <span class="o">=</span> <span class="n">rules</span>
    450. 

  450. 

  451.     <span class="k">def</span> <span class="nf">get_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">):</span>
    452. 

  452.         <span class="k">for</span> <span class="n">rulefactory</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">rules</span><span class="p">:</span>
    453. 

  453.             <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rulefactory</span><span class="o">.</span><span class="n">get_rules</span><span class="p">(</span><span class="nb">map</span><span class="p">):</span>
    454. 

  454.                 <span class="n">rule</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="n">empty</span><span class="p">()</span>
    455. 

  455.                 <span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span>
    456. 

  456.                 <span class="k">yield</span> <span class="n">rule</span>
    457. 

  457. 

  458. 

  459. <span class="k">class</span> <span class="nc">RuleTemplate</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    460. 

  460. 

  461.     <span class="sd">&quot;&quot;&quot;Returns copies of the rules wrapped and expands string templates in</span>
    462. 

  462. <span class="sd">    the endpoint, rule, defaults or subdomain sections.</span>
    463. 

  463. 

  464. <span class="sd">    Here a small example for such a rule template::</span>
    465. 

  465. 

  466. <span class="sd">        from werkzeug.routing import Map, Rule, RuleTemplate</span>
    467. 

  467. 

  468. <span class="sd">        resource = RuleTemplate([</span>
    469. 

  469. <span class="sd">            Rule(&#39;/$name/&#39;, endpoint=&#39;$name.list&#39;),</span>
    470. 

  470. <span class="sd">            Rule(&#39;/$name/&lt;int:id&gt;&#39;, endpoint=&#39;$name.show&#39;)</span>
    471. 

  471. <span class="sd">        ])</span>
    472. 

  472. 

  473. <span class="sd">        url_map = Map([resource(name=&#39;user&#39;), resource(name=&#39;page&#39;)])</span>
    474. 

  474. 

  475. <span class="sd">    When a rule template is called the keyword arguments are used to</span>
    476. 

  476. <span class="sd">    replace the placeholders in all the string parameters.</span>
    477. 

  477. <span class="sd">    &quot;&quot;&quot;</span>
    478. 

  478. 

  479.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rules</span><span class="p">):</span>
    480. 

  480.         <span class="bp">self</span><span class="o">.</span><span class="n">rules</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">rules</span><span class="p">)</span>
    481. 

  481. 

  482.     <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    483. 

  483.         <span class="k">return</span> <span class="n">RuleTemplateFactory</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">rules</span><span class="p">,</span> <span class="nb">dict</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span>
    484. 

  484. 

  485. 

  486. <span class="k">class</span> <span class="nc">RuleTemplateFactory</span><span class="p">(</span><span class="n">RuleFactory</span><span class="p">):</span>
    487. 

  487. 

  488.     <span class="sd">&quot;&quot;&quot;A factory that fills in template variables into rules.  Used by</span>
    489. 

  489. <span class="sd">    `RuleTemplate` internally.</span>
    490. 

  490. 

  491. <span class="sd">    :internal:</span>
    492. 

  492. <span class="sd">    &quot;&quot;&quot;</span>
    493. 

  493. 

  494.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rules</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
    495. 

  495.         <span class="bp">self</span><span class="o">.</span><span class="n">rules</span> <span class="o">=</span> <span class="n">rules</span>
    496. 

  496.         <span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="o">=</span> <span class="n">context</span>
    497. 

  497. 

  498.     <span class="k">def</span> <span class="nf">get_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">):</span>
    499. 

  499.         <span class="k">for</span> <span class="n">rulefactory</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">rules</span><span class="p">:</span>
    500. 

  500.             <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rulefactory</span><span class="o">.</span><span class="n">get_rules</span><span class="p">(</span><span class="nb">map</span><span class="p">):</span>
    501. 

  501.                 <span class="n">new_defaults</span> <span class="o">=</span> <span class="n">subdomain</span> <span class="o">=</span> <span class="kc">None</span>
    502. 

  502.                 <span class="k">if</span> <span class="n">rule</span><span class="o">.</span><span class="n">defaults</span><span class="p">:</span>
    503. 

  503.                     <span class="n">new_defaults</span> <span class="o">=</span> <span class="p">{}</span>
    504. 

  504.                     <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">iteritems</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">defaults</span><span class="p">):</span>
    505. 

  505.                         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">string_types</span><span class="p">):</span>
    506. 

  506.                             <span class="n">value</span> <span class="o">=</span> <span class="n">format_string</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span>
    507. 

  507.                         <span class="n">new_defaults</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
    508. 

  508.                 <span class="k">if</span> <span class="n">rule</span><span class="o">.</span><span class="n">subdomain</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    509. 

  509.                     <span class="n">subdomain</span> <span class="o">=</span> <span class="n">format_string</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">subdomain</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span>
    510. 

  510.                 <span class="n">new_endpoint</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span>
    511. 

  511.                 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">new_endpoint</span><span class="p">,</span> <span class="n">string_types</span><span class="p">):</span>
    512. 

  512.                     <span class="n">new_endpoint</span> <span class="o">=</span> <span class="n">format_string</span><span class="p">(</span><span class="n">new_endpoint</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span>
    513. 

  513.                 <span class="k">yield</span> <span class="n">Rule</span><span class="p">(</span>
    514. 

  514.                     <span class="n">format_string</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">rule</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">),</span>
    515. 

  515.                     <span class="n">new_defaults</span><span class="p">,</span>
    516. 

  516.                     <span class="n">subdomain</span><span class="p">,</span>
    517. 

  517.                     <span class="n">rule</span><span class="o">.</span><span class="n">methods</span><span class="p">,</span>
    518. 

  518.                     <span class="n">rule</span><span class="o">.</span><span class="n">build_only</span><span class="p">,</span>
    519. 

  519.                     <span class="n">new_endpoint</span><span class="p">,</span>
    520. 

  520.                     <span class="n">rule</span><span class="o">.</span><span class="n">strict_slashes</span>
    521. 

  521.                 <span class="p">)</span>
    522. 

  522. 

  523. 

  524. <span class="nd">@implements_to_string</span>
    525. 

  525. <span class="k">class</span> <span class="nc">Rule</span><span class="p">(</span><span class="n">RuleFactory</span><span class="p">):</span>
    526. 

  526. 

  527.     <span class="sd">&quot;&quot;&quot;A Rule represents one URL pattern.  There are some options for `Rule`</span>
    528. 

  528. <span class="sd">    that change the way it behaves and are passed to the `Rule` constructor.</span>
    529. 

  529. <span class="sd">    Note that besides the rule-string all arguments *must* be keyword arguments</span>
    530. 

  530. <span class="sd">    in order to not break the application on Werkzeug upgrades.</span>
    531. 

  531. 

  532. <span class="sd">    `string`</span>
    533. 

  533. <span class="sd">        Rule strings basically are just normal URL paths with placeholders in</span>
    534. 

  534. <span class="sd">        the format ``&lt;converter(arguments):name&gt;`` where the converter and the</span>
    535. 

  535. <span class="sd">        arguments are optional.  If no converter is defined the `default`</span>
    536. 

  536. <span class="sd">        converter is used which means `string` in the normal configuration.</span>
    537. 

  537. 

  538. <span class="sd">        URL rules that end with a slash are branch URLs, others are leaves.</span>
    539. 

  539. <span class="sd">        If you have `strict_slashes` enabled (which is the default), all</span>
    540. 

  540. <span class="sd">        branch URLs that are matched without a trailing slash will trigger a</span>
    541. 

  541. <span class="sd">        redirect to the same URL with the missing slash appended.</span>
    542. 

  542. 

  543. <span class="sd">        The converters are defined on the `Map`.</span>
    544. 

  544. 

  545. <span class="sd">    `endpoint`</span>
    546. 

  546. <span class="sd">        The endpoint for this rule. This can be anything. A reference to a</span>
    547. 

  547. <span class="sd">        function, a string, a number etc.  The preferred way is using a string</span>
    548. 

  548. <span class="sd">        because the endpoint is used for URL generation.</span>
    549. 

  549. 

  550. <span class="sd">    `defaults`</span>
    551. 

  551. <span class="sd">        An optional dict with defaults for other rules with the same endpoint.</span>
    552. 

  552. <span class="sd">        This is a bit tricky but useful if you want to have unique URLs::</span>
    553. 

  553. 

  554. <span class="sd">            url_map = Map([</span>
    555. 

  555. <span class="sd">                Rule(&#39;/all/&#39;, defaults={&#39;page&#39;: 1}, endpoint=&#39;all_entries&#39;),</span>
    556. 

  556. <span class="sd">                Rule(&#39;/all/page/&lt;int:page&gt;&#39;, endpoint=&#39;all_entries&#39;)</span>
    557. 

  557. <span class="sd">            ])</span>
    558. 

  558. 

  559. <span class="sd">        If a user now visits ``http://example.com/all/page/1`` he will be</span>
    560. 

  560. <span class="sd">        redirected to ``http://example.com/all/``.  If `redirect_defaults` is</span>
    561. 

  561. <span class="sd">        disabled on the `Map` instance this will only affect the URL</span>
    562. 

  562. <span class="sd">        generation.</span>
    563. 

  563. 

  564. <span class="sd">    `subdomain`</span>
    565. 

  565. <span class="sd">        The subdomain rule string for this rule. If not specified the rule</span>
    566. 

  566. <span class="sd">        only matches for the `default_subdomain` of the map.  If the map is</span>
    567. 

  567. <span class="sd">        not bound to a subdomain this feature is disabled.</span>
    568. 

  568. 

  569. <span class="sd">        Can be useful if you want to have user profiles on different subdomains</span>
    570. 

  570. <span class="sd">        and all subdomains are forwarded to your application::</span>
    571. 

  571. 

  572. <span class="sd">            url_map = Map([</span>
    573. 

  573. <span class="sd">                Rule(&#39;/&#39;, subdomain=&#39;&lt;username&gt;&#39;, endpoint=&#39;user/homepage&#39;),</span>
    574. 

  574. <span class="sd">                Rule(&#39;/stats&#39;, subdomain=&#39;&lt;username&gt;&#39;, endpoint=&#39;user/stats&#39;)</span>
    575. 

  575. <span class="sd">            ])</span>
    576. 

  576. 

  577. <span class="sd">    `methods`</span>
    578. 

  578. <span class="sd">        A sequence of http methods this rule applies to.  If not specified, all</span>
    579. 

  579. <span class="sd">        methods are allowed. For example this can be useful if you want different</span>
    580. 

  580. <span class="sd">        endpoints for `POST` and `GET`.  If methods are defined and the path</span>
    581. 

  581. <span class="sd">        matches but the method matched against is not in this list or in the</span>
    582. 

  582. <span class="sd">        list of another rule for that path the error raised is of the type</span>
    583. 

  583. <span class="sd">        `MethodNotAllowed` rather than `NotFound`.  If `GET` is present in the</span>
    584. 

  584. <span class="sd">        list of methods and `HEAD` is not, `HEAD` is added automatically.</span>
    585. 

  585. 

  586. <span class="sd">        .. versionchanged:: 0.6.1</span>
    587. 

  587. <span class="sd">           `HEAD` is now automatically added to the methods if `GET` is</span>
    588. 

  588. <span class="sd">           present.  The reason for this is that existing code often did not</span>
    589. 

  589. <span class="sd">           work properly in servers not rewriting `HEAD` to `GET`</span>
    590. 

  590. <span class="sd">           automatically and it was not documented how `HEAD` should be</span>
    591. 

  591. <span class="sd">           treated.  This was considered a bug in Werkzeug because of that.</span>
    592. 

  592. 

  593. <span class="sd">    `strict_slashes`</span>
    594. 

  594. <span class="sd">        Override the `Map` setting for `strict_slashes` only for this rule. If</span>
    595. 

  595. <span class="sd">        not specified the `Map` setting is used.</span>
    596. 

  596. 

  597. <span class="sd">    `build_only`</span>
    598. 

  598. <span class="sd">        Set this to True and the rule will never match but will create a URL</span>
    599. 

  599. <span class="sd">        that can be build. This is useful if you have resources on a subdomain</span>
    600. 

  600. <span class="sd">        or folder that are not handled by the WSGI application (like static data)</span>
    601. 

  601. 

  602. <span class="sd">    `redirect_to`</span>
    603. 

  603. <span class="sd">        If given this must be either a string or callable.  In case of a</span>
    604. 

  604. <span class="sd">        callable it&#39;s called with the url adapter that triggered the match and</span>
    605. 

  605. <span class="sd">        the values of the URL as keyword arguments and has to return the target</span>
    606. 

  606. <span class="sd">        for the redirect, otherwise it has to be a string with placeholders in</span>
    607. 

  607. <span class="sd">        rule syntax::</span>
    608. 

  608. 

  609. <span class="sd">            def foo_with_slug(adapter, id):</span>
    610. 

  610. <span class="sd">                # ask the database for the slug for the old id.  this of</span>
    611. 

  611. <span class="sd">                # course has nothing to do with werkzeug.</span>
    612. 

  612. <span class="sd">                return &#39;foo/&#39; + Foo.get_slug_for_id(id)</span>
    613. 

  613. 

  614. <span class="sd">            url_map = Map([</span>
    615. 

  615. <span class="sd">                Rule(&#39;/foo/&lt;slug&gt;&#39;, endpoint=&#39;foo&#39;),</span>
    616. 

  616. <span class="sd">                Rule(&#39;/some/old/url/&lt;slug&gt;&#39;, redirect_to=&#39;foo/&lt;slug&gt;&#39;),</span>
    617. 

  617. <span class="sd">                Rule(&#39;/other/old/url/&lt;int:id&gt;&#39;, redirect_to=foo_with_slug)</span>
    618. 

  618. <span class="sd">            ])</span>
    619. 

  619. 

  620. <span class="sd">        When the rule is matched the routing system will raise a</span>
    621. 

  621. <span class="sd">        `RequestRedirect` exception with the target for the redirect.</span>
    622. 

  622. 

  623. <span class="sd">        Keep in mind that the URL will be joined against the URL root of the</span>
    624. 

  624. <span class="sd">        script so don&#39;t use a leading slash on the target URL unless you</span>
    625. 

  625. <span class="sd">        really mean root of that domain.</span>
    626. 

  626. 

  627. <span class="sd">    `alias`</span>
    628. 

  628. <span class="sd">        If enabled this rule serves as an alias for another rule with the same</span>
    629. 

  629. <span class="sd">        endpoint and arguments.</span>
    630. 

  630. 

  631. <span class="sd">    `host`</span>
    632. 

  632. <span class="sd">        If provided and the URL map has host matching enabled this can be</span>
    633. 

  633. <span class="sd">        used to provide a match rule for the whole host.  This also means</span>
    634. 

  634. <span class="sd">        that the subdomain feature is disabled.</span>
    635. 

  635. 

  636. <span class="sd">    .. versionadded:: 0.7</span>
    637. 

  637. <span class="sd">       The `alias` and `host` parameters were added.</span>
    638. 

  638. <span class="sd">    &quot;&quot;&quot;</span>
    639. 

  639. 

  640.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">string</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">subdomain</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    641. 

  641.                  <span class="n">build_only</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">endpoint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">strict_slashes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    642. 

  642.                  <span class="n">redirect_to</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">alias</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    643. 

  643.         <span class="k">if</span> <span class="ow">not</span> <span class="n">string</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">):</span>
    644. 

  644.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;urls must start with a leading slash&#39;</span><span class="p">)</span>
    645. 

  645.         <span class="bp">self</span><span class="o">.</span><span class="n">rule</span> <span class="o">=</span> <span class="n">string</span>
    646. 

  646.         <span class="bp">self</span><span class="o">.</span><span class="n">is_leaf</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">string</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
    647. 

  647. 

  648.         <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="o">=</span> <span class="kc">None</span>
    649. 

  649.         <span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span> <span class="o">=</span> <span class="n">strict_slashes</span>
    650. 

  650.         <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">=</span> <span class="n">subdomain</span>
    651. 

  651.         <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span>
    652. 

  652.         <span class="bp">self</span><span class="o">.</span><span class="n">defaults</span> <span class="o">=</span> <span class="n">defaults</span>
    653. 

  653.         <span class="bp">self</span><span class="o">.</span><span class="n">build_only</span> <span class="o">=</span> <span class="n">build_only</span>
    654. 

  654.         <span class="bp">self</span><span class="o">.</span><span class="n">alias</span> <span class="o">=</span> <span class="n">alias</span>
    655. 

  655.         <span class="k">if</span> <span class="n">methods</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    656. 

  656.             <span class="bp">self</span><span class="o">.</span><span class="n">methods</span> <span class="o">=</span> <span class="kc">None</span>
    657. 

  657.         <span class="k">else</span><span class="p">:</span>
    658. 

  658.             <span class="bp">self</span><span class="o">.</span><span class="n">methods</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="n">x</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">methods</span><span class="p">])</span>
    659. 

  659.             <span class="k">if</span> <span class="s1">&#39;HEAD&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">methods</span> <span class="ow">and</span> <span class="s1">&#39;GET&#39;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">methods</span><span class="p">:</span>
    660. 

  660.                 <span class="bp">self</span><span class="o">.</span><span class="n">methods</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">&#39;HEAD&#39;</span><span class="p">)</span>
    661. 

  661.         <span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span> <span class="o">=</span> <span class="n">endpoint</span>
    662. 

  662.         <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to</span> <span class="o">=</span> <span class="n">redirect_to</span>
    663. 

  663. 

  664.         <span class="k">if</span> <span class="n">defaults</span><span class="p">:</span>
    665. 

  665.             <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">defaults</span><span class="p">))</span>
    666. 

  666.         <span class="k">else</span><span class="p">:</span>
    667. 

  667.             <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    668. 

  668.         <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_converters</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_regex</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span> <span class="o">=</span> <span class="kc">None</span>
    669. 

  669. 

  670.     <span class="k">def</span> <span class="nf">empty</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    671. 

  671.         <span class="sd">&quot;&quot;&quot;</span>
    672. 

  672. <span class="sd">        Return an unbound copy of this rule.</span>
    673. 

  673. 

  674. <span class="sd">        This can be useful if want to reuse an already bound URL for another</span>
    675. 

  675. <span class="sd">        map.  See ``get_empty_kwargs`` to override what keyword arguments are</span>
    676. 

  676. <span class="sd">        provided to the new copy.</span>
    677. 

  677. <span class="sd">        &quot;&quot;&quot;</span>
    678. 

  678.         <span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)(</span><span class="bp">self</span><span class="o">.</span><span class="n">rule</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">get_empty_kwargs</span><span class="p">())</span>
    679. 

  679. 

  680.     <span class="k">def</span> <span class="nf">get_empty_kwargs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    681. 

  681.         <span class="sd">&quot;&quot;&quot;</span>
    682. 

  682. <span class="sd">        Provides kwargs for instantiating empty copy with empty()</span>
    683. 

  683. 

  684. <span class="sd">        Use this method to provide custom keyword arguments to the subclass of</span>
    685. 

  685. <span class="sd">        ``Rule`` when calling ``some_rule.empty()``.  Helpful when the subclass</span>
    686. 

  686. <span class="sd">        has custom keyword arguments that are needed at instantiation.</span>
    687. 

  687. 

  688. <span class="sd">        Must return a ``dict`` that will be provided as kwargs to the new</span>
    689. 

  689. <span class="sd">        instance of ``Rule``, following the initial ``self.rule`` value which</span>
    690. 

  690. <span class="sd">        is always provided as the first, required positional argument.</span>
    691. 

  691. <span class="sd">        &quot;&quot;&quot;</span>
    692. 

  692.         <span class="n">defaults</span> <span class="o">=</span> <span class="kc">None</span>
    693. 

  693.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaults</span><span class="p">:</span>
    694. 

  694.             <span class="n">defaults</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">defaults</span><span class="p">)</span>
    695. 

  695.         <span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="n">defaults</span><span class="o">=</span><span class="n">defaults</span><span class="p">,</span> <span class="n">subdomain</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span><span class="p">,</span>
    696. 

  696.                     <span class="n">methods</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">methods</span><span class="p">,</span> <span class="n">build_only</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">build_only</span><span class="p">,</span>
    697. 

  697.                     <span class="n">endpoint</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">strict_slashes</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span><span class="p">,</span>
    698. 

  698.                     <span class="n">redirect_to</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">redirect_to</span><span class="p">,</span> <span class="n">alias</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">alias</span><span class="p">,</span>
    699. 

  699.                     <span class="n">host</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
    700. 

  700. 

  701.     <span class="k">def</span> <span class="nf">get_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">):</span>
    702. 

  702.         <span class="k">yield</span> <span class="bp">self</span>
    703. 

  703. 

  704.     <span class="k">def</span> <span class="nf">refresh</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    705. 

  705.         <span class="sd">&quot;&quot;&quot;Rebinds and refreshes the URL.  Call this if you modified the</span>
    706. 

  706. <span class="sd">        rule in place.</span>
    707. 

  707. 

  708. <span class="sd">        :internal:</span>
    709. 

  709. <span class="sd">        &quot;&quot;&quot;</span>
    710. 

  710.         <span class="bp">self</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="p">,</span> <span class="n">rebind</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    711. 

  711. 

  712.     <span class="k">def</span> <span class="nf">bind</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">,</span> <span class="n">rebind</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    713. 

  713.         <span class="sd">&quot;&quot;&quot;Bind the url to a map and create a regular expression based on</span>
    714. 

  714. <span class="sd">        the information from the rule itself and the defaults from the map.</span>
    715. 

  715. 

  716. <span class="sd">        :internal:</span>
    717. 

  717. <span class="sd">        &quot;&quot;&quot;</span>
    718. 

  718.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">rebind</span><span class="p">:</span>
    719. 

  719.             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;url rule </span><span class="si">%r</span><span class="s1"> already bound to map </span><span class="si">%r</span><span class="s1">&#39;</span> <span class="o">%</span>
    720. 

  720.                                <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="p">))</span>
    721. 

  721.         <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="o">=</span> <span class="nb">map</span>
    722. 

  722.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    723. 

  723.             <span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span> <span class="o">=</span> <span class="nb">map</span><span class="o">.</span><span class="n">strict_slashes</span>
    724. 

  724.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    725. 

  725.             <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">=</span> <span class="nb">map</span><span class="o">.</span><span class="n">default_subdomain</span>
    726. 

  726.         <span class="bp">self</span><span class="o">.</span><span class="n">compile</span><span class="p">()</span>
    727. 

  727. 

  728.     <span class="k">def</span> <span class="nf">get_converter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">variable_name</span><span class="p">,</span> <span class="n">converter_name</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">):</span>
    729. 

  729.         <span class="sd">&quot;&quot;&quot;Looks up the converter for the given parameter.</span>
    730. 

  730. 

  731. <span class="sd">        .. versionadded:: 0.9</span>
    732. 

  732. <span class="sd">        &quot;&quot;&quot;</span>
    733. 

  733.         <span class="k">if</span> <span class="n">converter_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">converters</span><span class="p">:</span>
    734. 

  734.             <span class="k">raise</span> <span class="ne">LookupError</span><span class="p">(</span><span class="s1">&#39;the converter </span><span class="si">%r</span><span class="s1"> does not exist&#39;</span> <span class="o">%</span> <span class="n">converter_name</span><span class="p">)</span>
    735. 

  735.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">converters</span><span class="p">[</span><span class="n">converter_name</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
    736. 

  736. 

  737.     <span class="k">def</span> <span class="nf">compile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    738. 

  738.         <span class="sd">&quot;&quot;&quot;Compiles the regular expression and stores it.&quot;&quot;&quot;</span>
    739. 

  739.         <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;rule not bound&#39;</span>
    740. 

  740. 

  741.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">host_matching</span><span class="p">:</span>
    742. 

  742.             <span class="n">domain_rule</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
    743. 

  743.         <span class="k">else</span><span class="p">:</span>
    744. 

  744.             <span class="n">domain_rule</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
    745. 

  745. 

  746.         <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span> <span class="o">=</span> <span class="p">[]</span>
    747. 

  747.         <span class="bp">self</span><span class="o">.</span><span class="n">_converters</span> <span class="o">=</span> <span class="p">{}</span>
    748. 

  748.         <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span> <span class="o">=</span> <span class="p">[]</span>
    749. 

  749.         <span class="n">regex_parts</span> <span class="o">=</span> <span class="p">[]</span>
    750. 

  750. 

  751.         <span class="k">def</span> <span class="nf">_build_regex</span><span class="p">(</span><span class="n">rule</span><span class="p">):</span>
    752. 

  752.             <span class="k">for</span> <span class="n">converter</span><span class="p">,</span> <span class="n">arguments</span><span class="p">,</span> <span class="n">variable</span> <span class="ow">in</span> <span class="n">parse_rule</span><span class="p">(</span><span class="n">rule</span><span class="p">):</span>
    753. 

  753.                 <span class="k">if</span> <span class="n">converter</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    754. 

  754.                     <span class="n">regex_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">variable</span><span class="p">))</span>
    755. 

  755.                     <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="kc">False</span><span class="p">,</span> <span class="n">variable</span><span class="p">))</span>
    756. 

  756.                     <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">variable</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">):</span>
    757. 

  757.                         <span class="k">if</span> <span class="n">part</span><span class="p">:</span>
    758. 

  758.                             <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">part</span><span class="p">)))</span>
    759. 

  759.                 <span class="k">else</span><span class="p">:</span>
    760. 

  760.                     <span class="k">if</span> <span class="n">arguments</span><span class="p">:</span>
    761. 

  761.                         <span class="n">c_args</span><span class="p">,</span> <span class="n">c_kwargs</span> <span class="o">=</span> <span class="n">parse_converter_args</span><span class="p">(</span><span class="n">arguments</span><span class="p">)</span>
    762. 

  762.                     <span class="k">else</span><span class="p">:</span>
    763. 

  763.                         <span class="n">c_args</span> <span class="o">=</span> <span class="p">()</span>
    764. 

  764.                         <span class="n">c_kwargs</span> <span class="o">=</span> <span class="p">{}</span>
    765. 

  765.                     <span class="n">convobj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_converter</span><span class="p">(</span>
    766. 

  766.                         <span class="n">variable</span><span class="p">,</span> <span class="n">converter</span><span class="p">,</span> <span class="n">c_args</span><span class="p">,</span> <span class="n">c_kwargs</span><span class="p">)</span>
    767. 

  767.                     <span class="n">regex_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;(?P&lt;</span><span class="si">%s</span><span class="s1">&gt;</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">variable</span><span class="p">,</span> <span class="n">convobj</span><span class="o">.</span><span class="n">regex</span><span class="p">))</span>
    768. 

  768.                     <span class="bp">self</span><span class="o">.</span><span class="n">_converters</span><span class="p">[</span><span class="n">variable</span><span class="p">]</span> <span class="o">=</span> <span class="n">convobj</span>
    769. 

  769.                     <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="kc">True</span><span class="p">,</span> <span class="n">variable</span><span class="p">))</span>
    770. 

  770.                     <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="n">convobj</span><span class="o">.</span><span class="n">weight</span><span class="p">))</span>
    771. 

  771.                     <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">variable</span><span class="p">))</span>
    772. 

  772. 

  773.         <span class="n">_build_regex</span><span class="p">(</span><span class="n">domain_rule</span><span class="p">)</span>
    774. 

  774.         <span class="n">regex_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\\</span><span class="s1">|&#39;</span><span class="p">)</span>
    775. 

  775.         <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="kc">False</span><span class="p">,</span> <span class="s1">&#39;|&#39;</span><span class="p">))</span>
    776. 

  776.         <span class="n">_build_regex</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">is_leaf</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">rule</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">rule</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">))</span>
    777. 

  777.         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_leaf</span><span class="p">:</span>
    778. 

  778.             <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="kc">False</span><span class="p">,</span> <span class="s1">&#39;/&#39;</span><span class="p">))</span>
    779. 

  779. 

  780.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_only</span><span class="p">:</span>
    781. 

  781.             <span class="k">return</span>
    782. 

  782.         <span class="n">regex</span> <span class="o">=</span> <span class="s1">r&#39;^</span><span class="si">%s%s</span><span class="s1">$&#39;</span> <span class="o">%</span> <span class="p">(</span>
    783. 

  783.             <span class="s1">u&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">regex_parts</span><span class="p">),</span>
    784. 

  784.             <span class="p">(</span><span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_leaf</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span><span class="p">)</span> <span class="ow">and</span>
    785. 

  785.             <span class="s1">&#39;(?&lt;!/)(?P&lt;__suffix__&gt;/?)&#39;</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
    786. 

  786.         <span class="p">)</span>
    787. 

  787.         <span class="bp">self</span><span class="o">.</span><span class="n">_regex</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">regex</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">UNICODE</span><span class="p">)</span>
    788. 

  788. 

  789.     <span class="k">def</span> <span class="nf">match</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
    790. 

  790.         <span class="sd">&quot;&quot;&quot;Check if the rule matches a given path. Path is a string in the</span>
    791. 

  791. <span class="sd">        form ``&quot;subdomain|/path(method)&quot;`` and is assembled by the map.  If</span>
    792. 

  792. <span class="sd">        the map is doing host matching the subdomain part will be the host</span>
    793. 

  793. <span class="sd">        instead.</span>
    794. 

  794. 

  795. <span class="sd">        If the rule matches a dict with the converted values is returned,</span>
    796. 

  796. <span class="sd">        otherwise the return value is `None`.</span>
    797. 

  797. 

  798. <span class="sd">        :internal:</span>
    799. 

  799. <span class="sd">        &quot;&quot;&quot;</span>
    800. 

  800.         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_only</span><span class="p">:</span>
    801. 

  801.             <span class="n">m</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_regex</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
    802. 

  802.             <span class="k">if</span> <span class="n">m</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    803. 

  803.                 <span class="n">groups</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()</span>
    804. 

  804.                 <span class="c1"># we have a folder like part of the url without a trailing</span>
    805. 

  805.                 <span class="c1"># slash and strict slashes enabled. raise an exception that</span>
    806. 

  806.                 <span class="c1"># tells the map to redirect to the same url but with a</span>
    807. 

  807.                 <span class="c1"># trailing slash</span>
    808. 

  808.                 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_leaf</span> <span class="ow">and</span> \
    809. 

  809.                    <span class="ow">not</span> <span class="n">groups</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;__suffix__&#39;</span><span class="p">):</span>
    810. 

  810.                     <span class="k">raise</span> <span class="n">RequestSlash</span><span class="p">()</span>
    811. 

  811.                 <span class="c1"># if we are not in strict slashes mode we have to remove</span>
    812. 

  812.                 <span class="c1"># a __suffix__</span>
    813. 

  813.                 <span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span><span class="p">:</span>
    814. 

  814.                     <span class="k">del</span> <span class="n">groups</span><span class="p">[</span><span class="s1">&#39;__suffix__&#39;</span><span class="p">]</span>
    815. 

  815. 

  816.                 <span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
    817. 

  817.                 <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">iteritems</span><span class="p">(</span><span class="n">groups</span><span class="p">):</span>
    818. 

  818.                     <span class="k">try</span><span class="p">:</span>
    819. 

  819.                         <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_converters</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">to_python</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    820. 

  820.                     <span class="k">except</span> <span class="n">ValidationError</span><span class="p">:</span>
    821. 

  821.                         <span class="k">return</span>
    822. 

  822.                     <span class="n">result</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">name</span><span class="p">)]</span> <span class="o">=</span> <span class="n">value</span>
    823. 

  823.                 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaults</span><span class="p">:</span>
    824. 

  824.                     <span class="n">result</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">defaults</span><span class="p">)</span>
    825. 

  825. 

  826.                 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">alias</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">redirect_defaults</span><span class="p">:</span>
    827. 

  827.                     <span class="k">raise</span> <span class="n">RequestAliasRedirect</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
    828. 

  828. 

  829.                 <span class="k">return</span> <span class="n">result</span>
    830. 

  830. 

  831.     <span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">append_unknown</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
    832. 

  832.         <span class="sd">&quot;&quot;&quot;Assembles the relative url for that rule and the subdomain.</span>
    833. 

  833. <span class="sd">        If building doesn&#39;t work for some reasons `None` is returned.</span>
    834. 

  834. 

  835. <span class="sd">        :internal:</span>
    836. 

  836. <span class="sd">        &quot;&quot;&quot;</span>
    837. 

  837.         <span class="n">tmp</span> <span class="o">=</span> <span class="p">[]</span>
    838. 

  838.         <span class="n">add</span> <span class="o">=</span> <span class="n">tmp</span><span class="o">.</span><span class="n">append</span>
    839. 

  839.         <span class="n">processed</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="p">)</span>
    840. 

  840.         <span class="k">for</span> <span class="n">is_dynamic</span><span class="p">,</span> <span class="n">data</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span><span class="p">:</span>
    841. 

  841.             <span class="k">if</span> <span class="n">is_dynamic</span><span class="p">:</span>
    842. 

  842.                 <span class="k">try</span><span class="p">:</span>
    843. 

  843.                     <span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_converters</span><span class="p">[</span><span class="n">data</span><span class="p">]</span><span class="o">.</span><span class="n">to_url</span><span class="p">(</span><span class="n">values</span><span class="p">[</span><span class="n">data</span><span class="p">]))</span>
    844. 

  844.                 <span class="k">except</span> <span class="n">ValidationError</span><span class="p">:</span>
    845. 

  845.                     <span class="k">return</span>
    846. 

  846.                 <span class="n">processed</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
    847. 

  847.             <span class="k">else</span><span class="p">:</span>
    848. 

  848.                 <span class="n">add</span><span class="p">(</span><span class="n">url_quote</span><span class="p">(</span><span class="n">to_bytes</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">charset</span><span class="p">),</span> <span class="n">safe</span><span class="o">=</span><span class="s1">&#39;/:|+&#39;</span><span class="p">))</span>
    849. 

  849.         <span class="n">domain_part</span><span class="p">,</span> <span class="n">url</span> <span class="o">=</span> <span class="p">(</span><span class="s1">u&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp</span><span class="p">))</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">u&#39;|&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
    850. 

  850. 

  851.         <span class="k">if</span> <span class="n">append_unknown</span><span class="p">:</span>
    852. 

  852.             <span class="n">query_vars</span> <span class="o">=</span> <span class="n">MultiDict</span><span class="p">(</span><span class="n">values</span><span class="p">)</span>
    853. 

  853.             <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">processed</span><span class="p">:</span>
    854. 

  854.                 <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">query_vars</span><span class="p">:</span>
    855. 

  855.                     <span class="k">del</span> <span class="n">query_vars</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
    856. 

  856. 

  857.             <span class="k">if</span> <span class="n">query_vars</span><span class="p">:</span>
    858. 

  858.                 <span class="n">url</span> <span class="o">+=</span> <span class="s1">u&#39;?&#39;</span> <span class="o">+</span> <span class="n">url_encode</span><span class="p">(</span><span class="n">query_vars</span><span class="p">,</span> <span class="n">charset</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">charset</span><span class="p">,</span>
    859. 

  859.                                          <span class="n">sort</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">sort_parameters</span><span class="p">,</span>
    860. 

  860.                                          <span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">sort_key</span><span class="p">)</span>
    861. 

  861. 

  862.         <span class="k">return</span> <span class="n">domain_part</span><span class="p">,</span> <span class="n">url</span>
    863. 

  863. 

  864.     <span class="k">def</span> <span class="nf">provides_defaults_for</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rule</span><span class="p">):</span>
    865. 

  865.         <span class="sd">&quot;&quot;&quot;Check if this rule has defaults for a given rule.</span>
    866. 

  866. 

  867. <span class="sd">        :internal:</span>
    868. 

  868. <span class="sd">        &quot;&quot;&quot;</span>
    869. 

  869.         <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_only</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaults</span> <span class="ow">and</span> \
    870. 

  870.             <span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span> <span class="o">==</span> <span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span> <span class="ow">and</span> <span class="bp">self</span> <span class="o">!=</span> <span class="n">rule</span> <span class="ow">and</span> \
    871. 

  871.             <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span> <span class="o">==</span> <span class="n">rule</span><span class="o">.</span><span class="n">arguments</span>
    872. 

  872. 

  873.     <span class="k">def</span> <span class="nf">suitable_for</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    874. 

  874.         <span class="sd">&quot;&quot;&quot;Check if the dict of values has enough data for url generation.</span>
    875. 

  875. 

  876. <span class="sd">        :internal:</span>
    877. 

  877. <span class="sd">        &quot;&quot;&quot;</span>
    878. 

  878.         <span class="c1"># if a method was given explicitly and that method is not supported</span>
    879. 

  879.         <span class="c1"># by this rule, this rule is not suitable.</span>
    880. 

  880.         <span class="k">if</span> <span class="n">method</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">methods</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> \
    881. 

  881.            <span class="ow">and</span> <span class="n">method</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">methods</span><span class="p">:</span>
    882. 

  882.             <span class="k">return</span> <span class="kc">False</span>
    883. 

  883. 

  884.         <span class="n">defaults</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaults</span> <span class="ow">or</span> <span class="p">()</span>
    885. 

  885. 

  886.         <span class="c1"># all arguments required must be either in the defaults dict or</span>
    887. 

  887.         <span class="c1"># the value dictionary otherwise it&#39;s not suitable</span>
    888. 

  888.         <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="p">:</span>
    889. 

  889.             <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">defaults</span> <span class="ow">and</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">values</span><span class="p">:</span>
    890. 

  890.                 <span class="k">return</span> <span class="kc">False</span>
    891. 

  891. 

  892.         <span class="c1"># in case defaults are given we ensure taht either the value was</span>
    893. 

  893.         <span class="c1"># skipped or the value is the same as the default value.</span>
    894. 

  894.         <span class="k">if</span> <span class="n">defaults</span><span class="p">:</span>
    895. 

  895.             <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">iteritems</span><span class="p">(</span><span class="n">defaults</span><span class="p">):</span>
    896. 

  896.                 <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">values</span> <span class="ow">and</span> <span class="n">value</span> <span class="o">!=</span> <span class="n">values</span><span class="p">[</span><span class="n">key</span><span class="p">]:</span>
    897. 

  897.                     <span class="k">return</span> <span class="kc">False</span>
    898. 

  898. 

  899.         <span class="k">return</span> <span class="kc">True</span>
    900. 

  900. 

  901.     <span class="k">def</span> <span class="nf">match_compare_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    902. 

  902.         <span class="sd">&quot;&quot;&quot;The match compare key for sorting.</span>
    903. 

  903. 

  904. <span class="sd">        Current implementation:</span>
    905. 

  905. 

  906. <span class="sd">        1.  rules without any arguments come first for performance</span>
    907. 

  907. <span class="sd">            reasons only as we expect them to match faster and some</span>
    908. 

  908. <span class="sd">            common ones usually don&#39;t have any arguments (index pages etc.)</span>
    909. 

  909. <span class="sd">        2.  The more complex rules come first so the second argument is the</span>
    910. 

  910. <span class="sd">            negative length of the number of weights.</span>
    911. 

  911. <span class="sd">        3.  lastly we order by the actual weights.</span>
    912. 

  912. 

  913. <span class="sd">        :internal:</span>
    914. 

  914. <span class="sd">        &quot;&quot;&quot;</span>
    915. 

  915.         <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="p">),</span> <span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_weights</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span>
    916. 

  916. 

  917.     <span class="k">def</span> <span class="nf">build_compare_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    918. 

  918.         <span class="sd">&quot;&quot;&quot;The build compare key for sorting.</span>
    919. 

  919. 

  920. <span class="sd">        :internal:</span>
    921. 

  921. <span class="sd">        &quot;&quot;&quot;</span>
    922. 

  922.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">alias</span> <span class="ow">and</span> <span class="mi">1</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="p">),</span> \
    923. 

  923.             <span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">defaults</span> <span class="ow">or</span> <span class="p">())</span>
    924. 

  924. 

  925.     <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
    926. 

  926.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span> <span class="ow">is</span> <span class="n">other</span><span class="o">.</span><span class="n">__class__</span> <span class="ow">and</span> \
    927. 

  927.             <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_trace</span>
    928. 

  928. 

  929.     <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
    930. 

  930.         <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">__eq__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
    931. 

  931. 

  932.     <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    933. 

  933.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">rule</span>
    934. 

  934. 

  935.     <span class="nd">@native_string_result</span>
    936. 

  936.     <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    937. 

  937.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    938. 

  938.             <span class="k">return</span> <span class="s1">u&#39;&lt;</span><span class="si">%s</span><span class="s1"> (unbound)&gt;&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span>
    939. 

  939.         <span class="n">tmp</span> <span class="o">=</span> <span class="p">[]</span>
    940. 

  940.         <span class="k">for</span> <span class="n">is_dynamic</span><span class="p">,</span> <span class="n">data</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_trace</span><span class="p">:</span>
    941. 

  941.             <span class="k">if</span> <span class="n">is_dynamic</span><span class="p">:</span>
    942. 

  942.                 <span class="n">tmp</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">u&#39;&lt;</span><span class="si">%s</span><span class="s1">&gt;&#39;</span> <span class="o">%</span> <span class="n">data</span><span class="p">)</span>
    943. 

  943.             <span class="k">else</span><span class="p">:</span>
    944. 

  944.                 <span class="n">tmp</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
    945. 

  945.         <span class="k">return</span> <span class="s1">u&#39;&lt;</span><span class="si">%s</span><span class="s1"> </span><span class="si">%s%s</span><span class="s1"> -&gt; </span><span class="si">%s</span><span class="s1">&gt;&#39;</span> <span class="o">%</span> <span class="p">(</span>
    946. 

  946.             <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span>
    947. 

  947.             <span class="nb">repr</span><span class="p">((</span><span class="s1">u&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp</span><span class="p">))</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">u&#39;|&#39;</span><span class="p">))</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">u&#39;u&#39;</span><span class="p">),</span>
    948. 

  948.             <span class="bp">self</span><span class="o">.</span><span class="n">methods</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
    949. 

  949.             <span class="ow">and</span> <span class="s1">u&#39; (</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="s1">u&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">methods</span><span class="p">)</span>
    950. 

  950.             <span class="ow">or</span> <span class="s1">u&#39;&#39;</span><span class="p">,</span>
    951. 

  951.             <span class="bp">self</span><span class="o">.</span><span class="n">endpoint</span>
    952. 

  952.         <span class="p">)</span>
    953. 

  953. 

  954. 

  955. <span class="k">class</span> <span class="nc">BaseConverter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    956. 

  956. 

  957.     <span class="sd">&quot;&quot;&quot;Base class for all converters.&quot;&quot;&quot;</span>
    958. 

  958.     <span class="n">regex</span> <span class="o">=</span> <span class="s1">&#39;[^/]+&#39;</span>
    959. 

  959.     <span class="n">weight</span> <span class="o">=</span> <span class="mi">100</span>
    960. 

  960. 

  961.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">):</span>
    962. 

  962.         <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="o">=</span> <span class="nb">map</span>
    963. 

  963. 

  964.     <span class="k">def</span> <span class="nf">to_python</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    965. 

  965.         <span class="k">return</span> <span class="n">value</span>
    966. 

  966. 

  967.     <span class="k">def</span> <span class="nf">to_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    968. 

  968.         <span class="k">return</span> <span class="n">url_quote</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">charset</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">charset</span><span class="p">)</span>
    969. 

  969. 

  970. 

  971. <span class="k">class</span> <span class="nc">UnicodeConverter</span><span class="p">(</span><span class="n">BaseConverter</span><span class="p">):</span>
    972. 

  972. 

  973.     <span class="sd">&quot;&quot;&quot;This converter is the default converter and accepts any string but</span>
    974. 

  974. <span class="sd">    only one path segment.  Thus the string can not include a slash.</span>
    975. 

  975. 

  976. <span class="sd">    This is the default validator.</span>
    977. 

  977. 

  978. <span class="sd">    Example::</span>
    979. 

  979. 

  980. <span class="sd">        Rule(&#39;/pages/&lt;page&gt;&#39;),</span>
    981. 

  981. <span class="sd">        Rule(&#39;/&lt;string(length=2):lang_code&gt;&#39;)</span>
    982. 

  982. 

  983. <span class="sd">    :param map: the :class:`Map`.</span>
    984. 

  984. <span class="sd">    :param minlength: the minimum length of the string.  Must be greater</span>
    985. 

  985. <span class="sd">                      or equal 1.</span>
    986. 

  986. <span class="sd">    :param maxlength: the maximum length of the string.</span>
    987. 

  987. <span class="sd">    :param length: the exact length of the string.</span>
    988. 

  988. <span class="sd">    &quot;&quot;&quot;</span>
    989. 

  989. 

  990.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">,</span> <span class="n">minlength</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">maxlength</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">length</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    991. 

  991.         <span class="n">BaseConverter</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">)</span>
    992. 

  992.         <span class="k">if</span> <span class="n">length</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    993. 

  993.             <span class="n">length</span> <span class="o">=</span> <span class="s1">&#39;{</span><span class="si">%d</span><span class="s1">}&#39;</span> <span class="o">%</span> <span class="nb">int</span><span class="p">(</span><span class="n">length</span><span class="p">)</span>
    994. 

  994.         <span class="k">else</span><span class="p">:</span>
    995. 

  995.             <span class="k">if</span> <span class="n">maxlength</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    996. 

  996.                 <span class="n">maxlength</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    997. 

  997.             <span class="k">else</span><span class="p">:</span>
    998. 

  998.                 <span class="n">maxlength</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">maxlength</span><span class="p">)</span>
    999. 

  999.             <span class="n">length</span> <span class="o">=</span> <span class="s1">&#39;{</span><span class="si">%s</span><span class="s1">,</span><span class="si">%s</span><span class="s1">}&#39;</span> <span class="o">%</span> <span class="p">(</span>
    1000. 

  1000.                 <span class="nb">int</span><span class="p">(</span><span class="n">minlength</span><span class="p">),</span>
    1001. 

  1001.                 <span class="n">maxlength</span>
    1002. 

  1002.             <span class="p">)</span>
    1003. 

  1003.         <span class="bp">self</span><span class="o">.</span><span class="n">regex</span> <span class="o">=</span> <span class="s1">&#39;[^/]&#39;</span> <span class="o">+</span> <span class="n">length</span>
    1004. 

  1004. 

  1005. 

  1006. <span class="k">class</span> <span class="nc">AnyConverter</span><span class="p">(</span><span class="n">BaseConverter</span><span class="p">):</span>
    1007. 

  1007. 

  1008.     <span class="sd">&quot;&quot;&quot;Matches one of the items provided.  Items can either be Python</span>
    1009. 

  1009. <span class="sd">    identifiers or strings::</span>
    1010. 

  1010. 

  1011. <span class="sd">        Rule(&#39;/&lt;any(about, help, imprint, class, &quot;foo,bar&quot;):page_name&gt;&#39;)</span>
    1012. 

  1012. 

  1013. <span class="sd">    :param map: the :class:`Map`.</span>
    1014. 

  1014. <span class="sd">    :param items: this function accepts the possible items as positional</span>
    1015. 

  1015. <span class="sd">                  arguments.</span>
    1016. 

  1016. <span class="sd">    &quot;&quot;&quot;</span>
    1017. 

  1017. 

  1018.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">,</span> <span class="o">*</span><span class="n">items</span><span class="p">):</span>
    1019. 

  1019.         <span class="n">BaseConverter</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">)</span>
    1020. 

  1020.         <span class="bp">self</span><span class="o">.</span><span class="n">regex</span> <span class="o">=</span> <span class="s1">&#39;(?:</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="s1">&#39;|&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">items</span><span class="p">])</span>
    1021. 

  1021. 

  1022. 

  1023. <span class="k">class</span> <span class="nc">PathConverter</span><span class="p">(</span><span class="n">BaseConverter</span><span class="p">):</span>
    1024. 

  1024. 

  1025.     <span class="sd">&quot;&quot;&quot;Like the default :class:`UnicodeConverter`, but it also matches</span>
    1026. 

  1026. <span class="sd">    slashes.  This is useful for wikis and similar applications::</span>
    1027. 

  1027. 

  1028. <span class="sd">        Rule(&#39;/&lt;path:wikipage&gt;&#39;)</span>
    1029. 

  1029. <span class="sd">        Rule(&#39;/&lt;path:wikipage&gt;/edit&#39;)</span>
    1030. 

  1030. 

  1031. <span class="sd">    :param map: the :class:`Map`.</span>
    1032. 

  1032. <span class="sd">    &quot;&quot;&quot;</span>
    1033. 

  1033.     <span class="n">regex</span> <span class="o">=</span> <span class="s1">&#39;[^/].*?&#39;</span>
    1034. 

  1034.     <span class="n">weight</span> <span class="o">=</span> <span class="mi">200</span>
    1035. 

  1035. 

  1036. 

  1037. <span class="k">class</span> <span class="nc">NumberConverter</span><span class="p">(</span><span class="n">BaseConverter</span><span class="p">):</span>
    1038. 

  1038. 

  1039.     <span class="sd">&quot;&quot;&quot;Baseclass for `IntegerConverter` and `FloatConverter`.</span>
    1040. 

  1040. 

  1041. <span class="sd">    :internal:</span>
    1042. 

  1042. <span class="sd">    &quot;&quot;&quot;</span>
    1043. 

  1043.     <span class="n">weight</span> <span class="o">=</span> <span class="mi">50</span>
    1044. 

  1044. 

  1045.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">,</span> <span class="n">fixed_digits</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="nb">min</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="nb">max</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1046. 

  1046.         <span class="n">BaseConverter</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">)</span>
    1047. 

  1047.         <span class="bp">self</span><span class="o">.</span><span class="n">fixed_digits</span> <span class="o">=</span> <span class="n">fixed_digits</span>
    1048. 

  1048.         <span class="bp">self</span><span class="o">.</span><span class="n">min</span> <span class="o">=</span> <span class="nb">min</span>
    1049. 

  1049.         <span class="bp">self</span><span class="o">.</span><span class="n">max</span> <span class="o">=</span> <span class="nb">max</span>
    1050. 

  1050. 

  1051.     <span class="k">def</span> <span class="nf">to_python</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    1052. 

  1052.         <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fixed_digits</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fixed_digits</span><span class="p">):</span>
    1053. 

  1053.             <span class="k">raise</span> <span class="n">ValidationError</span><span class="p">()</span>
    1054. 

  1054.         <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_convert</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    1055. 

  1055.         <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">min</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">value</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">min</span><span class="p">)</span> <span class="ow">or</span> \
    1056. 

  1056.            <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">value</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">max</span><span class="p">):</span>
    1057. 

  1057.             <span class="k">raise</span> <span class="n">ValidationError</span><span class="p">()</span>
    1058. 

  1058.         <span class="k">return</span> <span class="n">value</span>
    1059. 

  1059. 

  1060.     <span class="k">def</span> <span class="nf">to_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    1061. 

  1061.         <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_convert</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    1062. 

  1062.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">fixed_digits</span><span class="p">:</span>
    1063. 

  1063.             <span class="n">value</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;</span><span class="si">%%</span><span class="s1">0</span><span class="si">%s</span><span class="s1">d&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">fixed_digits</span><span class="p">)</span> <span class="o">%</span> <span class="n">value</span>
    1064. 

  1064.         <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    1065. 

  1065. 

  1066. 

  1067. <span class="k">class</span> <span class="nc">IntegerConverter</span><span class="p">(</span><span class="n">NumberConverter</span><span class="p">):</span>
    1068. 

  1068. 

  1069.     <span class="sd">&quot;&quot;&quot;This converter only accepts integer values::</span>
    1070. 

  1070. 

  1071. <span class="sd">        Rule(&#39;/page/&lt;int:page&gt;&#39;)</span>
    1072. 

  1072. 

  1073. <span class="sd">    This converter does not support negative values.</span>
    1074. 

  1074. 

  1075. <span class="sd">    :param map: the :class:`Map`.</span>
    1076. 

  1076. <span class="sd">    :param fixed_digits: the number of fixed digits in the URL.  If you set</span>
    1077. 

  1077. <span class="sd">                         this to ``4`` for example, the application will</span>
    1078. 

  1078. <span class="sd">                         only match if the url looks like ``/0001/``.  The</span>
    1079. 

  1079. <span class="sd">                         default is variable length.</span>
    1080. 

  1080. <span class="sd">    :param min: the minimal value.</span>
    1081. 

  1081. <span class="sd">    :param max: the maximal value.</span>
    1082. 

  1082. <span class="sd">    &quot;&quot;&quot;</span>
    1083. 

  1083.     <span class="n">regex</span> <span class="o">=</span> <span class="s1">r&#39;\d+&#39;</span>
    1084. 

  1084.     <span class="n">num_convert</span> <span class="o">=</span> <span class="nb">int</span>
    1085. 

  1085. 

  1086. 

  1087. <span class="k">class</span> <span class="nc">FloatConverter</span><span class="p">(</span><span class="n">NumberConverter</span><span class="p">):</span>
    1088. 

  1088. 

  1089.     <span class="sd">&quot;&quot;&quot;This converter only accepts floating point values::</span>
    1090. 

  1090. 

  1091. <span class="sd">        Rule(&#39;/probability/&lt;float:probability&gt;&#39;)</span>
    1092. 

  1092. 

  1093. <span class="sd">    This converter does not support negative values.</span>
    1094. 

  1094. 

  1095. <span class="sd">    :param map: the :class:`Map`.</span>
    1096. 

  1096. <span class="sd">    :param min: the minimal value.</span>
    1097. 

  1097. <span class="sd">    :param max: the maximal value.</span>
    1098. 

  1098. <span class="sd">    &quot;&quot;&quot;</span>
    1099. 

  1099.     <span class="n">regex</span> <span class="o">=</span> <span class="s1">r&#39;\d+\.\d+&#39;</span>
    1100. 

  1100.     <span class="n">num_convert</span> <span class="o">=</span> <span class="nb">float</span>
    1101. 

  1101. 

  1102.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">,</span> <span class="nb">min</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="nb">max</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1103. 

  1103.         <span class="n">NumberConverter</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="nb">min</span><span class="p">,</span> <span class="nb">max</span><span class="p">)</span>
    1104. 

  1104. 

  1105. 

  1106. <span class="k">class</span> <span class="nc">UUIDConverter</span><span class="p">(</span><span class="n">BaseConverter</span><span class="p">):</span>
    1107. 

  1107. 

  1108.     <span class="sd">&quot;&quot;&quot;This converter only accepts UUID strings::</span>
    1109. 

  1109. 

  1110. <span class="sd">        Rule(&#39;/object/&lt;uuid:identifier&gt;&#39;)</span>
    1111. 

  1111. 

  1112. <span class="sd">    .. versionadded:: 0.10</span>
    1113. 

  1113. 

  1114. <span class="sd">    :param map: the :class:`Map`.</span>
    1115. 

  1115. <span class="sd">    &quot;&quot;&quot;</span>
    1116. 

  1116.     <span class="n">regex</span> <span class="o">=</span> <span class="s1">r&#39;[A-Fa-f0-9]</span><span class="si">{8}</span><span class="s1">-[A-Fa-f0-9]</span><span class="si">{4}</span><span class="s1">-&#39;</span> \
    1117. 

  1117.             <span class="s1">r&#39;[A-Fa-f0-9]</span><span class="si">{4}</span><span class="s1">-[A-Fa-f0-9]</span><span class="si">{4}</span><span class="s1">-[A-Fa-f0-9]</span><span class="si">{12}</span><span class="s1">&#39;</span>
    1118. 

  1118. 

  1119.     <span class="k">def</span> <span class="nf">to_python</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    1120. 

  1120.         <span class="k">return</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    1121. 

  1121. 

  1122.     <span class="k">def</span> <span class="nf">to_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    1123. 

  1123.         <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    1124. 

  1124. 

  1125. 

  1126. <span class="c1">#: the default converter mapping for the map.</span>
    1127. 

  1127. <span class="n">DEFAULT_CONVERTERS</span> <span class="o">=</span> <span class="p">{</span>
    1128. 

  1128.     <span class="s1">&#39;default&#39;</span><span class="p">:</span>          <span class="n">UnicodeConverter</span><span class="p">,</span>
    1129. 

  1129.     <span class="s1">&#39;string&#39;</span><span class="p">:</span>           <span class="n">UnicodeConverter</span><span class="p">,</span>
    1130. 

  1130.     <span class="s1">&#39;any&#39;</span><span class="p">:</span>              <span class="n">AnyConverter</span><span class="p">,</span>
    1131. 

  1131.     <span class="s1">&#39;path&#39;</span><span class="p">:</span>             <span class="n">PathConverter</span><span class="p">,</span>
    1132. 

  1132.     <span class="s1">&#39;int&#39;</span><span class="p">:</span>              <span class="n">IntegerConverter</span><span class="p">,</span>
    1133. 

  1133.     <span class="s1">&#39;float&#39;</span><span class="p">:</span>            <span class="n">FloatConverter</span><span class="p">,</span>
    1134. 

  1134.     <span class="s1">&#39;uuid&#39;</span><span class="p">:</span>             <span class="n">UUIDConverter</span><span class="p">,</span>
    1135. 

  1135. <span class="p">}</span>
    1136. 

  1136. 

  1137. 

  1138. <span class="k">class</span> <span class="nc">Map</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    1139. 

  1139. 

  1140.     <span class="sd">&quot;&quot;&quot;The map class stores all the URL rules and some configuration</span>
    1141. 

  1141. <span class="sd">    parameters.  Some of the configuration values are only stored on the</span>
    1142. 

  1142. <span class="sd">    `Map` instance since those affect all rules, others are just defaults</span>
    1143. 

  1143. <span class="sd">    and can be overridden for each rule.  Note that you have to specify all</span>
    1144. 

  1144. <span class="sd">    arguments besides the `rules` as keyword arguments!</span>
    1145. 

  1145. 

  1146. <span class="sd">    :param rules: sequence of url rules for this map.</span>
    1147. 

  1147. <span class="sd">    :param default_subdomain: The default subdomain for rules without a</span>
    1148. 

  1148. <span class="sd">                              subdomain defined.</span>
    1149. 

  1149. <span class="sd">    :param charset: charset of the url. defaults to ``&quot;utf-8&quot;``</span>
    1150. 

  1150. <span class="sd">    :param strict_slashes: Take care of trailing slashes.</span>
    1151. 

  1151. <span class="sd">    :param redirect_defaults: This will redirect to the default rule if it</span>
    1152. 

  1152. <span class="sd">                              wasn&#39;t visited that way. This helps creating</span>
    1153. 

  1153. <span class="sd">                              unique URLs.</span>
    1154. 

  1154. <span class="sd">    :param converters: A dict of converters that adds additional converters</span>
    1155. 

  1155. <span class="sd">                       to the list of converters. If you redefine one</span>
    1156. 

  1156. <span class="sd">                       converter this will override the original one.</span>
    1157. 

  1157. <span class="sd">    :param sort_parameters: If set to `True` the url parameters are sorted.</span>
    1158. 

  1158. <span class="sd">                            See `url_encode` for more details.</span>
    1159. 

  1159. <span class="sd">    :param sort_key: The sort key function for `url_encode`.</span>
    1160. 

  1160. <span class="sd">    :param encoding_errors: the error method to use for decoding</span>
    1161. 

  1161. <span class="sd">    :param host_matching: if set to `True` it enables the host matching</span>
    1162. 

  1162. <span class="sd">                          feature and disables the subdomain one.  If</span>
    1163. 

  1163. <span class="sd">                          enabled the `host` parameter to rules is used</span>
    1164. 

  1164. <span class="sd">                          instead of the `subdomain` one.</span>
    1165. 

  1165. 

  1166. <span class="sd">    .. versionadded:: 0.5</span>
    1167. 

  1167. <span class="sd">        `sort_parameters` and `sort_key` was added.</span>
    1168. 

  1168. 

  1169. <span class="sd">    .. versionadded:: 0.7</span>
    1170. 

  1170. <span class="sd">        `encoding_errors` and `host_matching` was added.</span>
    1171. 

  1171. <span class="sd">    &quot;&quot;&quot;</span>
    1172. 

  1172. 

  1173.     <span class="c1">#: .. versionadded:: 0.6</span>
    1174. 

  1174.     <span class="c1">#:    a dict of default converters to be used.</span>
    1175. 

  1175.     <span class="n">default_converters</span> <span class="o">=</span> <span class="n">ImmutableDict</span><span class="p">(</span><span class="n">DEFAULT_CONVERTERS</span><span class="p">)</span>
    1176. 

  1176. 

  1177.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rules</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">default_subdomain</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">charset</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">,</span>
    1178. 

  1178.                  <span class="n">strict_slashes</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">redirect_defaults</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
    1179. 

  1179.                  <span class="n">converters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sort_parameters</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">sort_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1180. 

  1180.                  <span class="n">encoding_errors</span><span class="o">=</span><span class="s1">&#39;replace&#39;</span><span class="p">,</span> <span class="n">host_matching</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    1181. 

  1181.         <span class="bp">self</span><span class="o">.</span><span class="n">_rules</span> <span class="o">=</span> <span class="p">[]</span>
    1182. 

  1182.         <span class="bp">self</span><span class="o">.</span><span class="n">_rules_by_endpoint</span> <span class="o">=</span> <span class="p">{}</span>
    1183. 

  1183.         <span class="bp">self</span><span class="o">.</span><span class="n">_remap</span> <span class="o">=</span> <span class="kc">True</span>
    1184. 

  1184.         <span class="bp">self</span><span class="o">.</span><span class="n">_remap_lock</span> <span class="o">=</span> <span class="n">Lock</span><span class="p">()</span>
    1185. 

  1185. 

  1186.         <span class="bp">self</span><span class="o">.</span><span class="n">default_subdomain</span> <span class="o">=</span> <span class="n">default_subdomain</span>
    1187. 

  1187.         <span class="bp">self</span><span class="o">.</span><span class="n">charset</span> <span class="o">=</span> <span class="n">charset</span>
    1188. 

  1188.         <span class="bp">self</span><span class="o">.</span><span class="n">encoding_errors</span> <span class="o">=</span> <span class="n">encoding_errors</span>
    1189. 

  1189.         <span class="bp">self</span><span class="o">.</span><span class="n">strict_slashes</span> <span class="o">=</span> <span class="n">strict_slashes</span>
    1190. 

  1190.         <span class="bp">self</span><span class="o">.</span><span class="n">redirect_defaults</span> <span class="o">=</span> <span class="n">redirect_defaults</span>
    1191. 

  1191.         <span class="bp">self</span><span class="o">.</span><span class="n">host_matching</span> <span class="o">=</span> <span class="n">host_matching</span>
    1192. 

  1192. 

  1193.         <span class="bp">self</span><span class="o">.</span><span class="n">converters</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_converters</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
    1194. 

  1194.         <span class="k">if</span> <span class="n">converters</span><span class="p">:</span>
    1195. 

  1195.             <span class="bp">self</span><span class="o">.</span><span class="n">converters</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">converters</span><span class="p">)</span>
    1196. 

  1196. 

  1197.         <span class="bp">self</span><span class="o">.</span><span class="n">sort_parameters</span> <span class="o">=</span> <span class="n">sort_parameters</span>
    1198. 

  1198.         <span class="bp">self</span><span class="o">.</span><span class="n">sort_key</span> <span class="o">=</span> <span class="n">sort_key</span>
    1199. 

  1199. 

  1200.         <span class="k">for</span> <span class="n">rulefactory</span> <span class="ow">in</span> <span class="n">rules</span> <span class="ow">or</span> <span class="p">():</span>
    1201. 

  1201.             <span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rulefactory</span><span class="p">)</span>
    1202. 

  1202. 

  1203.     <span class="k">def</span> <span class="nf">is_endpoint_expecting</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="o">*</span><span class="n">arguments</span><span class="p">):</span>
    1204. 

  1204.         <span class="sd">&quot;&quot;&quot;Iterate over all rules and check if the endpoint expects</span>
    1205. 

  1205. <span class="sd">        the arguments provided.  This is for example useful if you have</span>
    1206. 

  1206. <span class="sd">        some URLs that expect a language code and others that do not and</span>
    1207. 

  1207. <span class="sd">        you want to wrap the builder a bit so that the current language</span>
    1208. 

  1208. <span class="sd">        code is automatically added if not provided but endpoints expect</span>
    1209. 

  1209. <span class="sd">        it.</span>
    1210. 

  1210. 

  1211. <span class="sd">        :param endpoint: the endpoint to check.</span>
    1212. 

  1212. <span class="sd">        :param arguments: this function accepts one or more arguments</span>
    1213. 

  1213. <span class="sd">                          as positional arguments.  Each one of them is</span>
    1214. 

  1214. <span class="sd">                          checked.</span>
    1215. 

  1215. <span class="sd">        &quot;&quot;&quot;</span>
    1216. 

  1216.         <span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">()</span>
    1217. 

  1217.         <span class="n">arguments</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">arguments</span><span class="p">)</span>
    1218. 

  1218.         <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_rules_by_endpoint</span><span class="p">[</span><span class="n">endpoint</span><span class="p">]:</span>
    1219. 

  1219.             <span class="k">if</span> <span class="n">arguments</span><span class="o">.</span><span class="n">issubset</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">arguments</span><span class="p">):</span>
    1220. 

  1220.                 <span class="k">return</span> <span class="kc">True</span>
    1221. 

  1221.         <span class="k">return</span> <span class="kc">False</span>
    1222. 

  1222. 

  1223.     <span class="k">def</span> <span class="nf">iter_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1224. 

  1224.         <span class="sd">&quot;&quot;&quot;Iterate over all rules or the rules of an endpoint.</span>
    1225. 

  1225. 

  1226. <span class="sd">        :param endpoint: if provided only the rules for that endpoint</span>
    1227. 

  1227. <span class="sd">                         are returned.</span>
    1228. 

  1228. <span class="sd">        :return: an iterator</span>
    1229. 

  1229. <span class="sd">        &quot;&quot;&quot;</span>
    1230. 

  1230.         <span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">()</span>
    1231. 

  1231.         <span class="k">if</span> <span class="n">endpoint</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    1232. 

  1232.             <span class="k">return</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_rules_by_endpoint</span><span class="p">[</span><span class="n">endpoint</span><span class="p">])</span>
    1233. 

  1233.         <span class="k">return</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_rules</span><span class="p">)</span>
    1234. 

  1234. 

  1235.     <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rulefactory</span><span class="p">):</span>
    1236. 

  1236.         <span class="sd">&quot;&quot;&quot;Add a new rule or factory to the map and bind it.  Requires that the</span>
    1237. 

  1237. <span class="sd">        rule is not bound to another map.</span>
    1238. 

  1238. 

  1239. <span class="sd">        :param rulefactory: a :class:`Rule` or :class:`RuleFactory`</span>
    1240. 

  1240. <span class="sd">        &quot;&quot;&quot;</span>
    1241. 

  1241.         <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rulefactory</span><span class="o">.</span><span class="n">get_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1242. 

  1242.             <span class="n">rule</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
    1243. 

  1243.             <span class="bp">self</span><span class="o">.</span><span class="n">_rules</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rule</span><span class="p">)</span>
    1244. 

  1244.             <span class="bp">self</span><span class="o">.</span><span class="n">_rules_by_endpoint</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rule</span><span class="p">)</span>
    1245. 

  1245.         <span class="bp">self</span><span class="o">.</span><span class="n">_remap</span> <span class="o">=</span> <span class="kc">True</span>
    1246. 

  1246. 

  1247.     <span class="k">def</span> <span class="nf">bind</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">script_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">subdomain</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1248. 

  1248.              <span class="n">url_scheme</span><span class="o">=</span><span class="s1">&#39;http&#39;</span><span class="p">,</span> <span class="n">default_method</span><span class="o">=</span><span class="s1">&#39;GET&#39;</span><span class="p">,</span> <span class="n">path_info</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1249. 

  1249.              <span class="n">query_args</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1250. 

  1250.         <span class="sd">&quot;&quot;&quot;Return a new :class:`MapAdapter` with the details specified to the</span>
    1251. 

  1251. <span class="sd">        call.  Note that `script_name` will default to ``&#39;/&#39;`` if not further</span>
    1252. 

  1252. <span class="sd">        specified or `None`.  The `server_name` at least is a requirement</span>
    1253. 

  1253. <span class="sd">        because the HTTP RFC requires absolute URLs for redirects and so all</span>
    1254. 

  1254. <span class="sd">        redirect exceptions raised by Werkzeug will contain the full canonical</span>
    1255. 

  1255. <span class="sd">        URL.</span>
    1256. 

  1256. 

  1257. <span class="sd">        If no path_info is passed to :meth:`match` it will use the default path</span>
    1258. 

  1258. <span class="sd">        info passed to bind.  While this doesn&#39;t really make sense for</span>
    1259. 

  1259. <span class="sd">        manual bind calls, it&#39;s useful if you bind a map to a WSGI</span>
    1260. 

  1260. <span class="sd">        environment which already contains the path info.</span>
    1261. 

  1261. 

  1262. <span class="sd">        `subdomain` will default to the `default_subdomain` for this map if</span>
    1263. 

  1263. <span class="sd">        no defined. If there is no `default_subdomain` you cannot use the</span>
    1264. 

  1264. <span class="sd">        subdomain feature.</span>
    1265. 

  1265. 

  1266. <span class="sd">        .. versionadded:: 0.7</span>
    1267. 

  1267. <span class="sd">           `query_args` added</span>
    1268. 

  1268. 

  1269. <span class="sd">        .. versionadded:: 0.8</span>
    1270. 

  1270. <span class="sd">           `query_args` can now also be a string.</span>
    1271. 

  1271. <span class="sd">        &quot;&quot;&quot;</span>
    1272. 

  1272.         <span class="n">server_name</span> <span class="o">=</span> <span class="n">server_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
    1273. 

  1273.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">host_matching</span><span class="p">:</span>
    1274. 

  1274.             <span class="k">if</span> <span class="n">subdomain</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    1275. 

  1275.                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;host matching enabled and a &#39;</span>
    1276. 

  1276.                                    <span class="s1">&#39;subdomain was provided&#39;</span><span class="p">)</span>
    1277. 

  1277.         <span class="k">elif</span> <span class="n">subdomain</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1278. 

  1278.             <span class="n">subdomain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_subdomain</span>
    1279. 

  1279.         <span class="k">if</span> <span class="n">script_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1280. 

  1280.             <span class="n">script_name</span> <span class="o">=</span> <span class="s1">&#39;/&#39;</span>
    1281. 

  1281.         <span class="k">try</span><span class="p">:</span>
    1282. 

  1282.             <span class="n">server_name</span> <span class="o">=</span> <span class="n">_encode_idna</span><span class="p">(</span><span class="n">server_name</span><span class="p">)</span>
    1283. 

  1283.         <span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
    1284. 

  1284.             <span class="k">raise</span> <span class="n">BadHost</span><span class="p">()</span>
    1285. 

  1285.         <span class="k">return</span> <span class="n">MapAdapter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">script_name</span><span class="p">,</span> <span class="n">subdomain</span><span class="p">,</span>
    1286. 

  1286.                           <span class="n">url_scheme</span><span class="p">,</span> <span class="n">path_info</span><span class="p">,</span> <span class="n">default_method</span><span class="p">,</span> <span class="n">query_args</span><span class="p">)</span>
    1287. 

  1287. 

  1288.     <span class="k">def</span> <span class="nf">bind_to_environ</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">server_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">subdomain</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1289. 

  1289.         <span class="sd">&quot;&quot;&quot;Like :meth:`bind` but you can pass it an WSGI environment and it</span>
    1290. 

  1290. <span class="sd">        will fetch the information from that dictionary.  Note that because of</span>
    1291. 

  1291. <span class="sd">        limitations in the protocol there is no way to get the current</span>
    1292. 

  1292. <span class="sd">        subdomain and real `server_name` from the environment.  If you don&#39;t</span>
    1293. 

  1293. <span class="sd">        provide it, Werkzeug will use `SERVER_NAME` and `SERVER_PORT` (or</span>
    1294. 

  1294. <span class="sd">        `HTTP_HOST` if provided) as used `server_name` with disabled subdomain</span>
    1295. 

  1295. <span class="sd">        feature.</span>
    1296. 

  1296. 

  1297. <span class="sd">        If `subdomain` is `None` but an environment and a server name is</span>
    1298. 

  1298. <span class="sd">        provided it will calculate the current subdomain automatically.</span>
    1299. 

  1299. <span class="sd">        Example: `server_name` is ``&#39;example.com&#39;`` and the `SERVER_NAME`</span>
    1300. 

  1300. <span class="sd">        in the wsgi `environ` is ``&#39;staging.dev.example.com&#39;`` the calculated</span>
    1301. 

  1301. <span class="sd">        subdomain will be ``&#39;staging.dev&#39;``.</span>
    1302. 

  1302. 

  1303. <span class="sd">        If the object passed as environ has an environ attribute, the value of</span>
    1304. 

  1304. <span class="sd">        this attribute is used instead.  This allows you to pass request</span>
    1305. 

  1305. <span class="sd">        objects.  Additionally `PATH_INFO` added as a default of the</span>
    1306. 

  1306. <span class="sd">        :class:`MapAdapter` so that you don&#39;t have to pass the path info to</span>
    1307. 

  1307. <span class="sd">        the match method.</span>
    1308. 

  1308. 

  1309. <span class="sd">        .. versionchanged:: 0.5</span>
    1310. 

  1310. <span class="sd">            previously this method accepted a bogus `calculate_subdomain`</span>
    1311. 

  1311. <span class="sd">            parameter that did not have any effect.  It was removed because</span>
    1312. 

  1312. <span class="sd">            of that.</span>
    1313. 

  1313. 

  1314. <span class="sd">        .. versionchanged:: 0.8</span>
    1315. 

  1315. <span class="sd">           This will no longer raise a ValueError when an unexpected server</span>
    1316. 

  1316. <span class="sd">           name was passed.</span>
    1317. 

  1317. 

  1318. <span class="sd">        :param environ: a WSGI environment.</span>
    1319. 

  1319. <span class="sd">        :param server_name: an optional server name hint (see above).</span>
    1320. 

  1320. <span class="sd">        :param subdomain: optionally the current subdomain (see above).</span>
    1321. 

  1321. <span class="sd">        &quot;&quot;&quot;</span>
    1322. 

  1322.         <span class="n">environ</span> <span class="o">=</span> <span class="n">_get_environ</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
    1323. 

  1323. 

  1324.         <span class="k">if</span> <span class="s1">&#39;HTTP_HOST&#39;</span> <span class="ow">in</span> <span class="n">environ</span><span class="p">:</span>
    1325. 

  1325.             <span class="n">wsgi_server_name</span> <span class="o">=</span> <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;HTTP_HOST&#39;</span><span class="p">]</span>
    1326. 

  1326. 

  1327.             <span class="k">if</span> <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;wsgi.url_scheme&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;http&#39;</span> \
    1328. 

  1328.                     <span class="ow">and</span> <span class="n">wsgi_server_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;:80&#39;</span><span class="p">):</span>
    1329. 

  1329.                 <span class="n">wsgi_server_name</span> <span class="o">=</span> <span class="n">wsgi_server_name</span><span class="p">[:</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span>
    1330. 

  1330.             <span class="k">elif</span> <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;wsgi.url_scheme&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;https&#39;</span> \
    1331. 

  1331.                     <span class="ow">and</span> <span class="n">wsgi_server_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;:443&#39;</span><span class="p">):</span>
    1332. 

  1332.                 <span class="n">wsgi_server_name</span> <span class="o">=</span> <span class="n">wsgi_server_name</span><span class="p">[:</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span>
    1333. 

  1333.         <span class="k">else</span><span class="p">:</span>
    1334. 

  1334.             <span class="n">wsgi_server_name</span> <span class="o">=</span> <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;SERVER_NAME&#39;</span><span class="p">]</span>
    1335. 

  1335. 

  1336.             <span class="k">if</span> <span class="p">(</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;wsgi.url_scheme&#39;</span><span class="p">],</span> <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;SERVER_PORT&#39;</span><span class="p">])</span> <span class="ow">not</span> \
    1337. 

  1337.                <span class="ow">in</span> <span class="p">((</span><span class="s1">&#39;https&#39;</span><span class="p">,</span> <span class="s1">&#39;443&#39;</span><span class="p">),</span> <span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">,</span> <span class="s1">&#39;80&#39;</span><span class="p">)):</span>
    1338. 

  1338.                 <span class="n">wsgi_server_name</span> <span class="o">+=</span> <span class="s1">&#39;:&#39;</span> <span class="o">+</span> <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;SERVER_PORT&#39;</span><span class="p">]</span>
    1339. 

  1339. 

  1340.         <span class="n">wsgi_server_name</span> <span class="o">=</span> <span class="n">wsgi_server_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
    1341. 

  1341. 

  1342.         <span class="k">if</span> <span class="n">server_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1343. 

  1343.             <span class="n">server_name</span> <span class="o">=</span> <span class="n">wsgi_server_name</span>
    1344. 

  1344.         <span class="k">else</span><span class="p">:</span>
    1345. 

  1345.             <span class="n">server_name</span> <span class="o">=</span> <span class="n">server_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
    1346. 

  1346. 

  1347.         <span class="k">if</span> <span class="n">subdomain</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">host_matching</span><span class="p">:</span>
    1348. 

  1348.             <span class="n">cur_server_name</span> <span class="o">=</span> <span class="n">wsgi_server_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
    1349. 

  1349.             <span class="n">real_server_name</span> <span class="o">=</span> <span class="n">server_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
    1350. 

  1350.             <span class="n">offset</span> <span class="o">=</span> <span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">real_server_name</span><span class="p">)</span>
    1351. 

  1351.             <span class="k">if</span> <span class="n">cur_server_name</span><span class="p">[</span><span class="n">offset</span><span class="p">:]</span> <span class="o">!=</span> <span class="n">real_server_name</span><span class="p">:</span>
    1352. 

  1352.                 <span class="c1"># This can happen even with valid configs if the server was</span>
    1353. 

  1353.                 <span class="c1"># accesssed directly by IP address under some situations.</span>
    1354. 

  1354.                 <span class="c1"># Instead of raising an exception like in Werkzeug 0.7 or</span>
    1355. 

  1355.                 <span class="c1"># earlier we go by an invalid subdomain which will result</span>
    1356. 

  1356.                 <span class="c1"># in a 404 error on matching.</span>
    1357. 

  1357.                 <span class="n">subdomain</span> <span class="o">=</span> <span class="s1">&#39;&lt;invalid&gt;&#39;</span>
    1358. 

  1358.             <span class="k">else</span><span class="p">:</span>
    1359. 

  1359.                 <span class="n">subdomain</span> <span class="o">=</span> <span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">cur_server_name</span><span class="p">[:</span><span class="n">offset</span><span class="p">]))</span>
    1360. 

  1360. 

  1361.         <span class="k">def</span> <span class="nf">_get_wsgi_string</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
    1362. 

  1362.             <span class="n">val</span> <span class="o">=</span> <span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    1363. 

  1363.             <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    1364. 

  1364.                 <span class="k">return</span> <span class="n">wsgi_decoding_dance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">charset</span><span class="p">)</span>
    1365. 

  1365. 

  1366.         <span class="n">script_name</span> <span class="o">=</span> <span class="n">_get_wsgi_string</span><span class="p">(</span><span class="s1">&#39;SCRIPT_NAME&#39;</span><span class="p">)</span>
    1367. 

  1367.         <span class="n">path_info</span> <span class="o">=</span> <span class="n">_get_wsgi_string</span><span class="p">(</span><span class="s1">&#39;PATH_INFO&#39;</span><span class="p">)</span>
    1368. 

  1368.         <span class="n">query_args</span> <span class="o">=</span> <span class="n">_get_wsgi_string</span><span class="p">(</span><span class="s1">&#39;QUERY_STRING&#39;</span><span class="p">)</span>
    1369. 

  1369.         <span class="k">return</span> <span class="n">Map</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">script_name</span><span class="p">,</span>
    1370. 

  1370.                         <span class="n">subdomain</span><span class="p">,</span> <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;wsgi.url_scheme&#39;</span><span class="p">],</span>
    1371. 

  1371.                         <span class="n">environ</span><span class="p">[</span><span class="s1">&#39;REQUEST_METHOD&#39;</span><span class="p">],</span> <span class="n">path_info</span><span class="p">,</span>
    1372. 

  1372.                         <span class="n">query_args</span><span class="o">=</span><span class="n">query_args</span><span class="p">)</span>
    1373. 

  1373. 

  1374.     <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1375. 

  1375.         <span class="sd">&quot;&quot;&quot;Called before matching and building to keep the compiled rules</span>
    1376. 

  1376. <span class="sd">        in the correct order after things changed.</span>
    1377. 

  1377. <span class="sd">        &quot;&quot;&quot;</span>
    1378. 

  1378.         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_remap</span><span class="p">:</span>
    1379. 

  1379.             <span class="k">return</span>
    1380. 

  1380. 

  1381.         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_remap_lock</span><span class="p">:</span>
    1382. 

  1382.             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_remap</span><span class="p">:</span>
    1383. 

  1383.                 <span class="k">return</span>
    1384. 

  1384. 

  1385.             <span class="bp">self</span><span class="o">.</span><span class="n">_rules</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">match_compare_key</span><span class="p">())</span>
    1386. 

  1386.             <span class="k">for</span> <span class="n">rules</span> <span class="ow">in</span> <span class="n">itervalues</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_rules_by_endpoint</span><span class="p">):</span>
    1387. 

  1387.                 <span class="n">rules</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">build_compare_key</span><span class="p">())</span>
    1388. 

  1388.             <span class="bp">self</span><span class="o">.</span><span class="n">_remap</span> <span class="o">=</span> <span class="kc">False</span>
    1389. 

  1389. 

  1390.     <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1391. 

  1391.         <span class="n">rules</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">iter_rules</span><span class="p">()</span>
    1392. 

  1392.         <span class="k">return</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">(</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">pformat</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">rules</span><span class="p">)))</span>
    1393. 

  1393. 

  1394. 

  1395. <span class="k">class</span> <span class="nc">MapAdapter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    1396. 

  1396. 

  1397.     <span class="sd">&quot;&quot;&quot;Returned by :meth:`Map.bind` or :meth:`Map.bind_to_environ` and does</span>
    1398. 

  1398. <span class="sd">    the URL matching and building based on runtime information.</span>
    1399. 

  1399. <span class="sd">    &quot;&quot;&quot;</span>
    1400. 

  1400. 

  1401.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">map</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">script_name</span><span class="p">,</span> <span class="n">subdomain</span><span class="p">,</span>
    1402. 

  1402.                  <span class="n">url_scheme</span><span class="p">,</span> <span class="n">path_info</span><span class="p">,</span> <span class="n">default_method</span><span class="p">,</span> <span class="n">query_args</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1403. 

  1403.         <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="o">=</span> <span class="nb">map</span>
    1404. 

  1404.         <span class="bp">self</span><span class="o">.</span><span class="n">server_name</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">server_name</span><span class="p">)</span>
    1405. 

  1405.         <span class="n">script_name</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">script_name</span><span class="p">)</span>
    1406. 

  1406.         <span class="k">if</span> <span class="ow">not</span> <span class="n">script_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">u&#39;/&#39;</span><span class="p">):</span>
    1407. 

  1407.             <span class="n">script_name</span> <span class="o">+=</span> <span class="s1">u&#39;/&#39;</span>
    1408. 

  1408.         <span class="bp">self</span><span class="o">.</span><span class="n">script_name</span> <span class="o">=</span> <span class="n">script_name</span>
    1409. 

  1409.         <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">subdomain</span><span class="p">)</span>
    1410. 

  1410.         <span class="bp">self</span><span class="o">.</span><span class="n">url_scheme</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">url_scheme</span><span class="p">)</span>
    1411. 

  1411.         <span class="bp">self</span><span class="o">.</span><span class="n">path_info</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">path_info</span><span class="p">)</span>
    1412. 

  1412.         <span class="bp">self</span><span class="o">.</span><span class="n">default_method</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">default_method</span><span class="p">)</span>
    1413. 

  1413.         <span class="bp">self</span><span class="o">.</span><span class="n">query_args</span> <span class="o">=</span> <span class="n">query_args</span>
    1414. 

  1414. 

  1415.     <span class="k">def</span> <span class="nf">dispatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view_func</span><span class="p">,</span> <span class="n">path_info</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1416. 

  1416.                  <span class="n">catch_http_exceptions</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    1417. 

  1417.         <span class="sd">&quot;&quot;&quot;Does the complete dispatching process.  `view_func` is called with</span>
    1418. 

  1418. <span class="sd">        the endpoint and a dict with the values for the view.  It should</span>
    1419. 

  1419. <span class="sd">        look up the view function, call it, and return a response object</span>
    1420. 

  1420. <span class="sd">        or WSGI application.  http exceptions are not caught by default</span>
    1421. 

  1421. <span class="sd">        so that applications can display nicer error messages by just</span>
    1422. 

  1422. <span class="sd">        catching them by hand.  If you want to stick with the default</span>
    1423. 

  1423. <span class="sd">        error messages you can pass it ``catch_http_exceptions=True`` and</span>
    1424. 

  1424. <span class="sd">        it will catch the http exceptions.</span>
    1425. 

  1425. 

  1426. <span class="sd">        Here a small example for the dispatch usage::</span>
    1427. 

  1427. 

  1428. <span class="sd">            from werkzeug.wrappers import Request, Response</span>
    1429. 

  1429. <span class="sd">            from werkzeug.wsgi import responder</span>
    1430. 

  1430. <span class="sd">            from werkzeug.routing import Map, Rule</span>
    1431. 

  1431. 

  1432. <span class="sd">            def on_index(request):</span>
    1433. 

  1433. <span class="sd">                return Response(&#39;Hello from the index&#39;)</span>
    1434. 

  1434. 

  1435. <span class="sd">            url_map = Map([Rule(&#39;/&#39;, endpoint=&#39;index&#39;)])</span>
    1436. 

  1436. <span class="sd">            views = {&#39;index&#39;: on_index}</span>
    1437. 

  1437. 

  1438. <span class="sd">            @responder</span>
    1439. 

  1439. <span class="sd">            def application(environ, start_response):</span>
    1440. 

  1440. <span class="sd">                request = Request(environ)</span>
    1441. 

  1441. <span class="sd">                urls = url_map.bind_to_environ(environ)</span>
    1442. 

  1442. <span class="sd">                return urls.dispatch(lambda e, v: views[e](request, **v),</span>
    1443. 

  1443. <span class="sd">                                     catch_http_exceptions=True)</span>
    1444. 

  1444. 

  1445. <span class="sd">        Keep in mind that this method might return exception objects, too, so</span>
    1446. 

  1446. <span class="sd">        use :class:`Response.force_type` to get a response object.</span>
    1447. 

  1447. 

  1448. <span class="sd">        :param view_func: a function that is called with the endpoint as</span>
    1449. 

  1449. <span class="sd">                          first argument and the value dict as second.  Has</span>
    1450. 

  1450. <span class="sd">                          to dispatch to the actual view function with this</span>
    1451. 

  1451. <span class="sd">                          information.  (see above)</span>
    1452. 

  1452. <span class="sd">        :param path_info: the path info to use for matching.  Overrides the</span>
    1453. 

  1453. <span class="sd">                          path info specified on binding.</span>
    1454. 

  1454. <span class="sd">        :param method: the HTTP method used for matching.  Overrides the</span>
    1455. 

  1455. <span class="sd">                       method specified on binding.</span>
    1456. 

  1456. <span class="sd">        :param catch_http_exceptions: set to `True` to catch any of the</span>
    1457. 

  1457. <span class="sd">                                      werkzeug :class:`HTTPException`\s.</span>
    1458. 

  1458. <span class="sd">        &quot;&quot;&quot;</span>
    1459. 

  1459.         <span class="k">try</span><span class="p">:</span>
    1460. 

  1460.             <span class="k">try</span><span class="p">:</span>
    1461. 

  1461.                 <span class="n">endpoint</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">path_info</span><span class="p">,</span> <span class="n">method</span><span class="p">)</span>
    1462. 

  1462.             <span class="k">except</span> <span class="n">RequestRedirect</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    1463. 

  1463.                 <span class="k">return</span> <span class="n">e</span>
    1464. 

  1464.             <span class="k">return</span> <span class="n">view_func</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
    1465. 

  1465.         <span class="k">except</span> <span class="n">HTTPException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    1466. 

  1466.             <span class="k">if</span> <span class="n">catch_http_exceptions</span><span class="p">:</span>
    1467. 

  1467.                 <span class="k">return</span> <span class="n">e</span>
    1468. 

  1468.             <span class="k">raise</span>
    1469. 

  1469. 

  1470.     <span class="k">def</span> <span class="nf">match</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_info</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">return_rule</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
    1471. 

  1471.               <span class="n">query_args</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1472. 

  1472.         <span class="sd">&quot;&quot;&quot;The usage is simple: you just pass the match method the current</span>
    1473. 

  1473. <span class="sd">        path info as well as the method (which defaults to `GET`).  The</span>
    1474. 

  1474. <span class="sd">        following things can then happen:</span>
    1475. 

  1475. 

  1476. <span class="sd">        - you receive a `NotFound` exception that indicates that no URL is</span>
    1477. 

  1477. <span class="sd">          matching.  A `NotFound` exception is also a WSGI application you</span>
    1478. 

  1478. <span class="sd">          can call to get a default page not found page (happens to be the</span>
    1479. 

  1479. <span class="sd">          same object as `werkzeug.exceptions.NotFound`)</span>
    1480. 

  1480. 

  1481. <span class="sd">        - you receive a `MethodNotAllowed` exception that indicates that there</span>
    1482. 

  1482. <span class="sd">          is a match for this URL but not for the current request method.</span>
    1483. 

  1483. <span class="sd">          This is useful for RESTful applications.</span>
    1484. 

  1484. 

  1485. <span class="sd">        - you receive a `RequestRedirect` exception with a `new_url`</span>
    1486. 

  1486. <span class="sd">          attribute.  This exception is used to notify you about a request</span>
    1487. 

  1487. <span class="sd">          Werkzeug requests from your WSGI application.  This is for example the</span>
    1488. 

  1488. <span class="sd">          case if you request ``/foo`` although the correct URL is ``/foo/``</span>
    1489. 

  1489. <span class="sd">          You can use the `RequestRedirect` instance as response-like object</span>
    1490. 

  1490. <span class="sd">          similar to all other subclasses of `HTTPException`.</span>
    1491. 

  1491. 

  1492. <span class="sd">        - you get a tuple in the form ``(endpoint, arguments)`` if there is</span>
    1493. 

  1493. <span class="sd">          a match (unless `return_rule` is True, in which case you get a tuple</span>
    1494. 

  1494. <span class="sd">          in the form ``(rule, arguments)``)</span>
    1495. 

  1495. 

  1496. <span class="sd">        If the path info is not passed to the match method the default path</span>
    1497. 

  1497. <span class="sd">        info of the map is used (defaults to the root URL if not defined</span>
    1498. 

  1498. <span class="sd">        explicitly).</span>
    1499. 

  1499. 

  1500. <span class="sd">        All of the exceptions raised are subclasses of `HTTPException` so they</span>
    1501. 

  1501. <span class="sd">        can be used as WSGI responses.  The will all render generic error or</span>
    1502. 

  1502. <span class="sd">        redirect pages.</span>
    1503. 

  1503. 

  1504. <span class="sd">        Here is a small example for matching:</span>
    1505. 

  1505. 

  1506. <span class="sd">        &gt;&gt;&gt; m = Map([</span>
    1507. 

  1507. <span class="sd">        ...     Rule(&#39;/&#39;, endpoint=&#39;index&#39;),</span>
    1508. 

  1508. <span class="sd">        ...     Rule(&#39;/downloads/&#39;, endpoint=&#39;downloads/index&#39;),</span>
    1509. 

  1509. <span class="sd">        ...     Rule(&#39;/downloads/&lt;int:id&gt;&#39;, endpoint=&#39;downloads/show&#39;)</span>
    1510. 

  1510. <span class="sd">        ... ])</span>
    1511. 

  1511. <span class="sd">        &gt;&gt;&gt; urls = m.bind(&quot;example.com&quot;, &quot;/&quot;)</span>
    1512. 

  1512. <span class="sd">        &gt;&gt;&gt; urls.match(&quot;/&quot;, &quot;GET&quot;)</span>
    1513. 

  1513. <span class="sd">        (&#39;index&#39;, {})</span>
    1514. 

  1514. <span class="sd">        &gt;&gt;&gt; urls.match(&quot;/downloads/42&quot;)</span>
    1515. 

  1515. <span class="sd">        (&#39;downloads/show&#39;, {&#39;id&#39;: 42})</span>
    1516. 

  1516. 

  1517. <span class="sd">        And here is what happens on redirect and missing URLs:</span>
    1518. 

  1518. 

  1519. <span class="sd">        &gt;&gt;&gt; urls.match(&quot;/downloads&quot;)</span>
    1520. 

  1520. <span class="sd">        Traceback (most recent call last):</span>
    1521. 

  1521. <span class="sd">          ...</span>
    1522. 

  1522. <span class="sd">        RequestRedirect: http://example.com/downloads/</span>
    1523. 

  1523. <span class="sd">        &gt;&gt;&gt; urls.match(&quot;/missing&quot;)</span>
    1524. 

  1524. <span class="sd">        Traceback (most recent call last):</span>
    1525. 

  1525. <span class="sd">          ...</span>
    1526. 

  1526. <span class="sd">        NotFound: 404 Not Found</span>
    1527. 

  1527. 

  1528. <span class="sd">        :param path_info: the path info to use for matching.  Overrides the</span>
    1529. 

  1529. <span class="sd">                          path info specified on binding.</span>
    1530. 

  1530. <span class="sd">        :param method: the HTTP method used for matching.  Overrides the</span>
    1531. 

  1531. <span class="sd">                       method specified on binding.</span>
    1532. 

  1532. <span class="sd">        :param return_rule: return the rule that matched instead of just the</span>
    1533. 

  1533. <span class="sd">                            endpoint (defaults to `False`).</span>
    1534. 

  1534. <span class="sd">        :param query_args: optional query arguments that are used for</span>
    1535. 

  1535. <span class="sd">                           automatic redirects as string or dictionary.  It&#39;s</span>
    1536. 

  1536. <span class="sd">                           currently not possible to use the query arguments</span>
    1537. 

  1537. <span class="sd">                           for URL matching.</span>
    1538. 

  1538. 

  1539. <span class="sd">        .. versionadded:: 0.6</span>
    1540. 

  1540. <span class="sd">           `return_rule` was added.</span>
    1541. 

  1541. 

  1542. <span class="sd">        .. versionadded:: 0.7</span>
    1543. 

  1543. <span class="sd">           `query_args` was added.</span>
    1544. 

  1544. 

  1545. <span class="sd">        .. versionchanged:: 0.8</span>
    1546. 

  1546. <span class="sd">           `query_args` can now also be a string.</span>
    1547. 

  1547. <span class="sd">        &quot;&quot;&quot;</span>
    1548. 

  1548.         <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">update</span><span class="p">()</span>
    1549. 

  1549.         <span class="k">if</span> <span class="n">path_info</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1550. 

  1550.             <span class="n">path_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">path_info</span>
    1551. 

  1551.         <span class="k">else</span><span class="p">:</span>
    1552. 

  1552.             <span class="n">path_info</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">path_info</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">charset</span><span class="p">)</span>
    1553. 

  1553.         <span class="k">if</span> <span class="n">query_args</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1554. 

  1554.             <span class="n">query_args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">query_args</span>
    1555. 

  1555.         <span class="n">method</span> <span class="o">=</span> <span class="p">(</span><span class="n">method</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_method</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
    1556. 

  1556. 

  1557.         <span class="n">path</span> <span class="o">=</span> <span class="s1">u&#39;</span><span class="si">%s</span><span class="s1">|</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
    1558. 

  1558.             <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">host_matching</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">server_name</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span><span class="p">,</span>
    1559. 

  1559.             <span class="n">path_info</span> <span class="ow">and</span> <span class="s1">&#39;/</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">path_info</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
    1560. 

  1560.         <span class="p">)</span>
    1561. 

  1561. 

  1562.         <span class="n">have_match_for</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    1563. 

  1563.         <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">_rules</span><span class="p">:</span>
    1564. 

  1564.             <span class="k">try</span><span class="p">:</span>
    1565. 

  1565.                 <span class="n">rv</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
    1566. 

  1566.             <span class="k">except</span> <span class="n">RequestSlash</span><span class="p">:</span>
    1567. 

  1567.                 <span class="k">raise</span> <span class="n">RequestRedirect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">make_redirect_url</span><span class="p">(</span>
    1568. 

  1568.                     <span class="n">url_quote</span><span class="p">(</span><span class="n">path_info</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">charset</span><span class="p">,</span>
    1569. 

  1569.                               <span class="n">safe</span><span class="o">=</span><span class="s1">&#39;/:|+&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span><span class="p">,</span> <span class="n">query_args</span><span class="p">))</span>
    1570. 

  1570.             <span class="k">except</span> <span class="n">RequestAliasRedirect</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    1571. 

  1571.                 <span class="k">raise</span> <span class="n">RequestRedirect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">make_alias_redirect_url</span><span class="p">(</span>
    1572. 

  1572.                     <span class="n">path</span><span class="p">,</span> <span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">matched_values</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">query_args</span><span class="p">))</span>
    1573. 

  1573.             <span class="k">if</span> <span class="n">rv</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1574. 

  1574.                 <span class="k">continue</span>
    1575. 

  1575.             <span class="k">if</span> <span class="n">rule</span><span class="o">.</span><span class="n">methods</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">method</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">rule</span><span class="o">.</span><span class="n">methods</span><span class="p">:</span>
    1576. 

  1576.                 <span class="n">have_match_for</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">methods</span><span class="p">)</span>
    1577. 

  1577.                 <span class="k">continue</span>
    1578. 

  1578. 

  1579.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">redirect_defaults</span><span class="p">:</span>
    1580. 

  1580.                 <span class="n">redirect_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_default_redirect</span><span class="p">(</span><span class="n">rule</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">rv</span><span class="p">,</span>
    1581. 

  1581.                                                          <span class="n">query_args</span><span class="p">)</span>
    1582. 

  1582.                 <span class="k">if</span> <span class="n">redirect_url</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    1583. 

  1583.                     <span class="k">raise</span> <span class="n">RequestRedirect</span><span class="p">(</span><span class="n">redirect_url</span><span class="p">)</span>
    1584. 

  1584. 

  1585.             <span class="k">if</span> <span class="n">rule</span><span class="o">.</span><span class="n">redirect_to</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    1586. 

  1586.                 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rule</span><span class="o">.</span><span class="n">redirect_to</span><span class="p">,</span> <span class="n">string_types</span><span class="p">):</span>
    1587. 

  1587.                     <span class="k">def</span> <span class="nf">_handle_match</span><span class="p">(</span><span class="n">match</span><span class="p">):</span>
    1588. 

  1588.                         <span class="n">value</span> <span class="o">=</span> <span class="n">rv</span><span class="p">[</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)]</span>
    1589. 

  1589.                         <span class="k">return</span> <span class="n">rule</span><span class="o">.</span><span class="n">_converters</span><span class="p">[</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)]</span><span class="o">.</span><span class="n">to_url</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    1590. 

  1590.                     <span class="n">redirect_url</span> <span class="o">=</span> <span class="n">_simple_rule_re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="n">_handle_match</span><span class="p">,</span>
    1591. 

  1591.                                                        <span class="n">rule</span><span class="o">.</span><span class="n">redirect_to</span><span class="p">)</span>
    1592. 

  1592.                 <span class="k">else</span><span class="p">:</span>
    1593. 

  1593.                     <span class="n">redirect_url</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="n">redirect_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">rv</span><span class="p">)</span>
    1594. 

  1594.                 <span class="k">raise</span> <span class="n">RequestRedirect</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">url_join</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1">://</span><span class="si">%s%s%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
    1595. 

  1595.                     <span class="bp">self</span><span class="o">.</span><span class="n">url_scheme</span> <span class="ow">or</span> <span class="s1">&#39;http&#39;</span><span class="p">,</span>
    1596. 

  1596.                     <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
    1597. 

  1597.                     <span class="bp">self</span><span class="o">.</span><span class="n">server_name</span><span class="p">,</span>
    1598. 

  1598.                     <span class="bp">self</span><span class="o">.</span><span class="n">script_name</span>
    1599. 

  1599.                 <span class="p">),</span> <span class="n">redirect_url</span><span class="p">)))</span>
    1600. 

  1600. 

  1601.             <span class="k">if</span> <span class="n">return_rule</span><span class="p">:</span>
    1602. 

  1602.                 <span class="k">return</span> <span class="n">rule</span><span class="p">,</span> <span class="n">rv</span>
    1603. 

  1603.             <span class="k">else</span><span class="p">:</span>
    1604. 

  1604.                 <span class="k">return</span> <span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">rv</span>
    1605. 

  1605. 

  1606.         <span class="k">if</span> <span class="n">have_match_for</span><span class="p">:</span>
    1607. 

  1607.             <span class="k">raise</span> <span class="n">MethodNotAllowed</span><span class="p">(</span><span class="n">valid_methods</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="n">have_match_for</span><span class="p">))</span>
    1608. 

  1608.         <span class="k">raise</span> <span class="n">NotFound</span><span class="p">()</span>
    1609. 

  1609. 

  1610.     <span class="k">def</span> <span class="nf">test</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_info</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1611. 

  1611.         <span class="sd">&quot;&quot;&quot;Test if a rule would match.  Works like `match` but returns `True`</span>
    1612. 

  1612. <span class="sd">        if the URL matches, or `False` if it does not exist.</span>
    1613. 

  1613. 

  1614. <span class="sd">        :param path_info: the path info to use for matching.  Overrides the</span>
    1615. 

  1615. <span class="sd">                          path info specified on binding.</span>
    1616. 

  1616. <span class="sd">        :param method: the HTTP method used for matching.  Overrides the</span>
    1617. 

  1617. <span class="sd">                       method specified on binding.</span>
    1618. 

  1618. <span class="sd">        &quot;&quot;&quot;</span>
    1619. 

  1619.         <span class="k">try</span><span class="p">:</span>
    1620. 

  1620.             <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">path_info</span><span class="p">,</span> <span class="n">method</span><span class="p">)</span>
    1621. 

  1621.         <span class="k">except</span> <span class="n">RequestRedirect</span><span class="p">:</span>
    1622. 

  1622.             <span class="k">pass</span>
    1623. 

  1623.         <span class="k">except</span> <span class="n">HTTPException</span><span class="p">:</span>
    1624. 

  1624.             <span class="k">return</span> <span class="kc">False</span>
    1625. 

  1625.         <span class="k">return</span> <span class="kc">True</span>
    1626. 

  1626. 

  1627.     <span class="k">def</span> <span class="nf">allowed_methods</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_info</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1628. 

  1628.         <span class="sd">&quot;&quot;&quot;Returns the valid methods that match for a given path.</span>
    1629. 

  1629. 

  1630. <span class="sd">        .. versionadded:: 0.7</span>
    1631. 

  1631. <span class="sd">        &quot;&quot;&quot;</span>
    1632. 

  1632.         <span class="k">try</span><span class="p">:</span>
    1633. 

  1633.             <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">path_info</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;--&#39;</span><span class="p">)</span>
    1634. 

  1634.         <span class="k">except</span> <span class="n">MethodNotAllowed</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    1635. 

  1635.             <span class="k">return</span> <span class="n">e</span><span class="o">.</span><span class="n">valid_methods</span>
    1636. 

  1636.         <span class="k">except</span> <span class="n">HTTPException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    1637. 

  1637.             <span class="k">pass</span>
    1638. 

  1638.         <span class="k">return</span> <span class="p">[]</span>
    1639. 

  1639. 

  1640.     <span class="k">def</span> <span class="nf">get_host</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain_part</span><span class="p">):</span>
    1641. 

  1641.         <span class="sd">&quot;&quot;&quot;Figures out the full host name for the given domain part.  The</span>
    1642. 

  1642. <span class="sd">        domain part is a subdomain in case host matching is disabled or</span>
    1643. 

  1643. <span class="sd">        a full host name.</span>
    1644. 

  1644. <span class="sd">        &quot;&quot;&quot;</span>
    1645. 

  1645.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">host_matching</span><span class="p">:</span>
    1646. 

  1646.             <span class="k">if</span> <span class="n">domain_part</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1647. 

  1647.                 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">server_name</span>
    1648. 

  1648.             <span class="k">return</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">domain_part</span><span class="p">,</span> <span class="s1">&#39;ascii&#39;</span><span class="p">)</span>
    1649. 

  1649.         <span class="n">subdomain</span> <span class="o">=</span> <span class="n">domain_part</span>
    1650. 

  1650.         <span class="k">if</span> <span class="n">subdomain</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1651. 

  1651.             <span class="n">subdomain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span>
    1652. 

  1652.         <span class="k">else</span><span class="p">:</span>
    1653. 

  1653.             <span class="n">subdomain</span> <span class="o">=</span> <span class="n">to_unicode</span><span class="p">(</span><span class="n">subdomain</span><span class="p">,</span> <span class="s1">&#39;ascii&#39;</span><span class="p">)</span>
    1654. 

  1654.         <span class="k">return</span> <span class="p">(</span><span class="n">subdomain</span> <span class="ow">and</span> <span class="n">subdomain</span> <span class="o">+</span> <span class="s1">u&#39;.&#39;</span> <span class="ow">or</span> <span class="s1">u&#39;&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">server_name</span>
    1655. 

  1655. 

  1656.     <span class="k">def</span> <span class="nf">get_default_redirect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rule</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">query_args</span><span class="p">):</span>
    1657. 

  1657.         <span class="sd">&quot;&quot;&quot;A helper that returns the URL to redirect to if it finds one.</span>
    1658. 

  1658. <span class="sd">        This is used for default redirecting only.</span>
    1659. 

  1659. 

  1660. <span class="sd">        :internal:</span>
    1661. 

  1661. <span class="sd">        &quot;&quot;&quot;</span>
    1662. 

  1662.         <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">redirect_defaults</span>
    1663. 

  1663.         <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">_rules_by_endpoint</span><span class="p">[</span><span class="n">rule</span><span class="o">.</span><span class="n">endpoint</span><span class="p">]:</span>
    1664. 

  1664.             <span class="c1"># every rule that comes after this one, including ourself</span>
    1665. 

  1665.             <span class="c1"># has a lower priority for the defaults.  We order the ones</span>
    1666. 

  1666.             <span class="c1"># with the highest priority up for building.</span>
    1667. 

  1667.             <span class="k">if</span> <span class="n">r</span> <span class="ow">is</span> <span class="n">rule</span><span class="p">:</span>
    1668. 

  1668.                 <span class="k">break</span>
    1669. 

  1669.             <span class="k">if</span> <span class="n">r</span><span class="o">.</span><span class="n">provides_defaults_for</span><span class="p">(</span><span class="n">rule</span><span class="p">)</span> <span class="ow">and</span> \
    1670. 

  1670.                <span class="n">r</span><span class="o">.</span><span class="n">suitable_for</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
    1671. 

  1671.                 <span class="n">values</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">defaults</span><span class="p">)</span>
    1672. 

  1672.                 <span class="n">domain_part</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="n">values</span><span class="p">)</span>
    1673. 

  1673.                 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_redirect_url</span><span class="p">(</span>
    1674. 

  1674.                     <span class="n">path</span><span class="p">,</span> <span class="n">query_args</span><span class="p">,</span> <span class="n">domain_part</span><span class="o">=</span><span class="n">domain_part</span><span class="p">)</span>
    1675. 

  1675. 

  1676.     <span class="k">def</span> <span class="nf">encode_query_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query_args</span><span class="p">):</span>
    1677. 

  1677.         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">query_args</span><span class="p">,</span> <span class="n">string_types</span><span class="p">):</span>
    1678. 

  1678.             <span class="n">query_args</span> <span class="o">=</span> <span class="n">url_encode</span><span class="p">(</span><span class="n">query_args</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">charset</span><span class="p">)</span>
    1679. 

  1679.         <span class="k">return</span> <span class="n">query_args</span>
    1680. 

  1680. 

  1681.     <span class="k">def</span> <span class="nf">make_redirect_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_info</span><span class="p">,</span> <span class="n">query_args</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">domain_part</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1682. 

  1682.         <span class="sd">&quot;&quot;&quot;Creates a redirect URL.</span>
    1683. 

  1683. 

  1684. <span class="sd">        :internal:</span>
    1685. 

  1685. <span class="sd">        &quot;&quot;&quot;</span>
    1686. 

  1686.         <span class="n">suffix</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    1687. 

  1687.         <span class="k">if</span> <span class="n">query_args</span><span class="p">:</span>
    1688. 

  1688.             <span class="n">suffix</span> <span class="o">=</span> <span class="s1">&#39;?&#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">encode_query_args</span><span class="p">(</span><span class="n">query_args</span><span class="p">)</span>
    1689. 

  1689.         <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1">://</span><span class="si">%s</span><span class="s1">/</span><span class="si">%s%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
    1690. 

  1690.             <span class="bp">self</span><span class="o">.</span><span class="n">url_scheme</span> <span class="ow">or</span> <span class="s1">&#39;http&#39;</span><span class="p">,</span>
    1691. 

  1691.             <span class="bp">self</span><span class="o">.</span><span class="n">get_host</span><span class="p">(</span><span class="n">domain_part</span><span class="p">),</span>
    1692. 

  1692.             <span class="n">posixpath</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">script_name</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">),</span>
    1693. 

  1693.                            <span class="n">path_info</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)),</span>
    1694. 

  1694.             <span class="n">suffix</span>
    1695. 

  1695.         <span class="p">))</span>
    1696. 

  1696. 

  1697.     <span class="k">def</span> <span class="nf">make_alias_redirect_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">query_args</span><span class="p">):</span>
    1698. 

  1698.         <span class="sd">&quot;&quot;&quot;Internally called to make an alias redirect URL.&quot;&quot;&quot;</span>
    1699. 

  1699.         <span class="n">url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">append_unknown</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
    1700. 

  1700.                          <span class="n">force_external</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    1701. 

  1701.         <span class="k">if</span> <span class="n">query_args</span><span class="p">:</span>
    1702. 

  1702.             <span class="n">url</span> <span class="o">+=</span> <span class="s1">&#39;?&#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">encode_query_args</span><span class="p">(</span><span class="n">query_args</span><span class="p">)</span>
    1703. 

  1703.         <span class="k">assert</span> <span class="n">url</span> <span class="o">!=</span> <span class="n">path</span><span class="p">,</span> <span class="s1">&#39;detected invalid alias setting.  No canonical &#39;</span> \
    1704. 

  1704.             <span class="s1">&#39;URL found&#39;</span>
    1705. 

  1705.         <span class="k">return</span> <span class="n">url</span>
    1706. 

  1706. 

  1707.     <span class="k">def</span> <span class="nf">_partial_build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">append_unknown</span><span class="p">):</span>
    1708. 

  1708.         <span class="sd">&quot;&quot;&quot;Helper for :meth:`build`.  Returns subdomain and path for the</span>
    1709. 

  1709. <span class="sd">        rule that accepts this endpoint, values and method.</span>
    1710. 

  1710. 

  1711. <span class="sd">        :internal:</span>
    1712. 

  1712. <span class="sd">        &quot;&quot;&quot;</span>
    1713. 

  1713.         <span class="c1"># in case the method is none, try with the default method first</span>
    1714. 

  1714.         <span class="k">if</span> <span class="n">method</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1715. 

  1715.             <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_partial_build</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_method</span><span class="p">,</span>
    1716. 

  1716.                                      <span class="n">append_unknown</span><span class="p">)</span>
    1717. 

  1717.             <span class="k">if</span> <span class="n">rv</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    1718. 

  1718.                 <span class="k">return</span> <span class="n">rv</span>
    1719. 

  1719. 

  1720.         <span class="c1"># default method did not match or a specific method is passed,</span>
    1721. 

  1721.         <span class="c1"># check all and go with first result.</span>
    1722. 

  1722.         <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">_rules_by_endpoint</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="p">()):</span>
    1723. 

  1723.             <span class="k">if</span> <span class="n">rule</span><span class="o">.</span><span class="n">suitable_for</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
    1724. 

  1724.                 <span class="n">rv</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">append_unknown</span><span class="p">)</span>
    1725. 

  1725.                 <span class="k">if</span> <span class="n">rv</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    1726. 

  1726.                     <span class="k">return</span> <span class="n">rv</span>
    1727. 

  1727. 

  1728.     <span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">force_external</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
    1729. 

  1729.               <span class="n">append_unknown</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
    1730. 

  1730.         <span class="sd">&quot;&quot;&quot;Building URLs works pretty much the other way round.  Instead of</span>
    1731. 

  1731. <span class="sd">        `match` you call `build` and pass it the endpoint and a dict of</span>
    1732. 

  1732. <span class="sd">        arguments for the placeholders.</span>
    1733. 

  1733. 

  1734. <span class="sd">        The `build` function also accepts an argument called `force_external`</span>
    1735. 

  1735. <span class="sd">        which, if you set it to `True` will force external URLs. Per default</span>
    1736. 

  1736. <span class="sd">        external URLs (include the server name) will only be used if the</span>
    1737. 

  1737. <span class="sd">        target URL is on a different subdomain.</span>
    1738. 

  1738. 

  1739. <span class="sd">        &gt;&gt;&gt; m = Map([</span>
    1740. 

  1740. <span class="sd">        ...     Rule(&#39;/&#39;, endpoint=&#39;index&#39;),</span>
    1741. 

  1741. <span class="sd">        ...     Rule(&#39;/downloads/&#39;, endpoint=&#39;downloads/index&#39;),</span>
    1742. 

  1742. <span class="sd">        ...     Rule(&#39;/downloads/&lt;int:id&gt;&#39;, endpoint=&#39;downloads/show&#39;)</span>
    1743. 

  1743. <span class="sd">        ... ])</span>
    1744. 

  1744. <span class="sd">        &gt;&gt;&gt; urls = m.bind(&quot;example.com&quot;, &quot;/&quot;)</span>
    1745. 

  1745. <span class="sd">        &gt;&gt;&gt; urls.build(&quot;index&quot;, {})</span>
    1746. 

  1746. <span class="sd">        &#39;/&#39;</span>
    1747. 

  1747. <span class="sd">        &gt;&gt;&gt; urls.build(&quot;downloads/show&quot;, {&#39;id&#39;: 42})</span>
    1748. 

  1748. <span class="sd">        &#39;/downloads/42&#39;</span>
    1749. 

  1749. <span class="sd">        &gt;&gt;&gt; urls.build(&quot;downloads/show&quot;, {&#39;id&#39;: 42}, force_external=True)</span>
    1750. 

  1750. <span class="sd">        &#39;http://example.com/downloads/42&#39;</span>
    1751. 

  1751. 

  1752. <span class="sd">        Because URLs cannot contain non ASCII data you will always get</span>
    1753. 

  1753. <span class="sd">        bytestrings back.  Non ASCII characters are urlencoded with the</span>
    1754. 

  1754. <span class="sd">        charset defined on the map instance.</span>
    1755. 

  1755. 

  1756. <span class="sd">        Additional values are converted to unicode and appended to the URL as</span>
    1757. 

  1757. <span class="sd">        URL querystring parameters:</span>
    1758. 

  1758. 

  1759. <span class="sd">        &gt;&gt;&gt; urls.build(&quot;index&quot;, {&#39;q&#39;: &#39;My Searchstring&#39;})</span>
    1760. 

  1760. <span class="sd">        &#39;/?q=My+Searchstring&#39;</span>
    1761. 

  1761. 

  1762. <span class="sd">        When processing those additional values, lists are furthermore</span>
    1763. 

  1763. <span class="sd">        interpreted as multiple values (as per</span>
    1764. 

  1764. <span class="sd">        :py:class:`werkzeug.datastructures.MultiDict`):</span>
    1765. 

  1765. 

  1766. <span class="sd">        &gt;&gt;&gt; urls.build(&quot;index&quot;, {&#39;q&#39;: [&#39;a&#39;, &#39;b&#39;, &#39;c&#39;]})</span>
    1767. 

  1767. <span class="sd">        &#39;/?q=a&amp;q=b&amp;q=c&#39;</span>
    1768. 

  1768. 

  1769. <span class="sd">        If a rule does not exist when building a `BuildError` exception is</span>
    1770. 

  1770. <span class="sd">        raised.</span>
    1771. 

  1771. 

  1772. <span class="sd">        The build method accepts an argument called `method` which allows you</span>
    1773. 

  1773. <span class="sd">        to specify the method you want to have an URL built for if you have</span>
    1774. 

  1774. <span class="sd">        different methods for the same endpoint specified.</span>
    1775. 

  1775. 

  1776. <span class="sd">        .. versionadded:: 0.6</span>
    1777. 

  1777. <span class="sd">           the `append_unknown` parameter was added.</span>
    1778. 

  1778. 

  1779. <span class="sd">        :param endpoint: the endpoint of the URL to build.</span>
    1780. 

  1780. <span class="sd">        :param values: the values for the URL to build.  Unhandled values are</span>
    1781. 

  1781. <span class="sd">                       appended to the URL as query parameters.</span>
    1782. 

  1782. <span class="sd">        :param method: the HTTP method for the rule if there are different</span>
    1783. 

  1783. <span class="sd">                       URLs for different methods on the same endpoint.</span>
    1784. 

  1784. <span class="sd">        :param force_external: enforce full canonical external URLs. If the URL</span>
    1785. 

  1785. <span class="sd">                               scheme is not provided, this will generate</span>
    1786. 

  1786. <span class="sd">                               a protocol-relative URL.</span>
    1787. 

  1787. <span class="sd">        :param append_unknown: unknown parameters are appended to the generated</span>
    1788. 

  1788. <span class="sd">                               URL as query string argument.  Disable this</span>
    1789. 

  1789. <span class="sd">                               if you want the builder to ignore those.</span>
    1790. 

  1790. <span class="sd">        &quot;&quot;&quot;</span>
    1791. 

  1791.         <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">update</span><span class="p">()</span>
    1792. 

  1792.         <span class="k">if</span> <span class="n">values</span><span class="p">:</span>
    1793. 

  1793.             <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">MultiDict</span><span class="p">):</span>
    1794. 

  1794.                 <span class="n">valueiter</span> <span class="o">=</span> <span class="n">iteritems</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">multi</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    1795. 

  1795.             <span class="k">else</span><span class="p">:</span>
    1796. 

  1796.                 <span class="n">valueiter</span> <span class="o">=</span> <span class="n">iteritems</span><span class="p">(</span><span class="n">values</span><span class="p">)</span>
    1797. 

  1797.             <span class="n">values</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">valueiter</span> <span class="k">if</span> <span class="n">v</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">)</span>
    1798. 

  1798.         <span class="k">else</span><span class="p">:</span>
    1799. 

  1799.             <span class="n">values</span> <span class="o">=</span> <span class="p">{}</span>
    1800. 

  1800. 

  1801.         <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_partial_build</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">append_unknown</span><span class="p">)</span>
    1802. 

  1802.         <span class="k">if</span> <span class="n">rv</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1803. 

  1803.             <span class="k">raise</span> <span class="n">BuildError</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
    1804. 

  1804.         <span class="n">domain_part</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">rv</span>
    1805. 

  1805. 

  1806.         <span class="n">host</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_host</span><span class="p">(</span><span class="n">domain_part</span><span class="p">)</span>
    1807. 

  1807. 

  1808.         <span class="c1"># shortcut this.</span>
    1809. 

  1809.         <span class="k">if</span> <span class="ow">not</span> <span class="n">force_external</span> <span class="ow">and</span> <span class="p">(</span>
    1810. 

  1810.             <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">host_matching</span> <span class="ow">and</span> <span class="n">host</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">server_name</span><span class="p">)</span> <span class="ow">or</span>
    1811. 

  1811.             <span class="p">(</span><span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">host_matching</span> <span class="ow">and</span> <span class="n">domain_part</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span><span class="p">)</span>
    1812. 

  1812.         <span class="p">):</span>
    1813. 

  1813.             <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">url_join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">script_name</span><span class="p">,</span> <span class="s1">&#39;./&#39;</span> <span class="o">+</span> <span class="n">path</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)))</span>
    1814. 

  1814.         <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1">//</span><span class="si">%s%s</span><span class="s1">/</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
    1815. 

  1815.             <span class="bp">self</span><span class="o">.</span><span class="n">url_scheme</span> <span class="o">+</span> <span class="s1">&#39;:&#39;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_scheme</span> <span class="k">else</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
    1816. 

  1816.             <span class="n">host</span><span class="p">,</span>
    1817. 

  1817.             <span class="bp">self</span><span class="o">.</span><span class="n">script_name</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span>
    1818. 

  1818.             <span class="n">path</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
    1819. 

  1819.         <span class="p">))</span>
    1820. 

  1820. </pre></div>
    1821. 

  1821. 

  1822.           </div>
    1823. 

  1823.         </div>
    1824. 

  1824.       </div>
    1825. 

  1825.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    1826. 

  1826.         <div class="sphinxsidebarwrapper"><div class="relations">
    1827. 

  1827. <h3>Related Topics</h3>
    1828. 

  1828. <ul>
    1829. 

  1829.   <li><a href="../../index.html">Documentation overview</a><ul>
    1830. 

  1830.   <li><a href="../index.html">Module code</a><ul>
    1831. 

  1831.   </ul></li>
    1832. 

  1832.   </ul></li>
    1833. 

  1833. </ul>
    1834. 

  1834. </div>
    1835. 

  1835. <div id="searchbox" style="display: none" role="search">
    1836. 

  1836.   <h3>Quick search</h3>
    1837. 

  1837.     <form class="search" action="../../search.html" method="get">
    1838. 

  1838.       <div><input type="text" name="q" /></div>
    1839. 

  1839.       <div><input type="submit" value="Go" /></div>
    1840. 

  1840.       <input type="hidden" name="check_keywords" value="yes" />
    1841. 

  1841.       <input type="hidden" name="area" value="default" />
    1842. 

  1842.     </form>
    1843. 

  1843. </div>
    1844. 

  1844. <script type="text/javascript">$('#searchbox').show(0);</script>
    1845. 

  1845.         </div>
    1846. 

  1846.       </div>
    1847. 

  1847.       <div class="clearer"></div>
    1848. 

  1848.     </div>
    1849. 

  1849.     <div class="footer">
    1850. 

  1850.       &copy;2016, Author.
    1851. 

  1851.       
    1852. 

  1852.       |
    1853. 

  1853.       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
    1854. 

  1854.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
    1855. 

  1855.       
    1856. 

  1856.     </div>
    1857. 

  1857. 

  1858.     
    1859. 

  1859. 

  1860.     
    1861. 

  1861.   </body>
    1862. 

  1862. </html>
    1863.