R `dZeZgdZddlZddlmZddlZddlZddl Z ddl Z ddl Z ddl Z ddl mZn#e$r ddlmZYnwxYw ddlmcmZn#e$r ddlmcmZYnwxYwddlmZmZddlmZmZddlmZd Zd Z d Z!d Z"d Z#Gdde$Z%Gdde%Z&Gdde%Z'Gdde(Z)GddZ*Gdde)Z+Gdde+Z,Gdde)Z-Gdde)e*Z.Gd d!e*Z/Gd"d#e+e*Z0Gd$d%e)Z1Gd&d'e)Z2Gd(d)e+Z3Gd*d+e)Z4Gd,d-e)Z5dS).aNavigate the resources exposed by a web service. The wadllib library helps a web client navigate the resources exposed by a web service. The service defines its resources in a single WADL file. wadllib parses this file and gives access to the resources defined inside. The client code can see the capabilities of a given resource and make the corresponding HTTP requests. If a request returns a representation of the resource, the client can bind the string representation to the wadllib Resource object. ) ApplicationLinkMethodNoBoundRepresentationError ParameterRepresentationDefinitionResponseDefinitionResource ResourceType WADLErrorN)quote) urlencode)URImerge) _make_unicode _string_types) iso_strptimez xmlns:mapz http://www.w3.org/2001/XMLSchemac d|zS)z)Scope a tag name with the WADL namespace.z&{http://research.sun.com/wadl/2006/10}tag_names 5/usr/lib/python3/dist-packages/wadllib/application.pywadl_tagrHs 3h >>c&dt|zS)z#Turn a tag name into an XPath path.z./)rrs r wadl_xpathrMs (8$$ $$rcBi}|D]}||||S)zz-HasParametersMixin.params..sI<<<#''00F::(I..:::r)r8 ValueErrortagfindallr)selfr9r8 param_tagss `` rparamszHasParametersMixin.paramsys  }H  EFF F 8 IX%%j&9&9::  I<<<<.s@@@v|@@@rr zInvalid value 'z': valid values are: "z", ""z$No value for required parameter '%s'zUnrecognized parameter(s): '%s'z', ') r"name fixed_valuer;optionslenjoin is_requiredkeys) r>r@ param_valuesenforce_completenesskw_param_valuesvalidated_valuesr1rGrIs rvalidate_param_valuesz(HasParametersMixin.validate_param_valuess"$L/BB  ' 'E:D ,L(($T*e.???$*(4T(:(:(:DDD(-(9(9(9&;<<<&+%6 T"@@%-@@@GG q  T\%9%9 &g55 j$T***DDD&++g2F2F2F2F"HIII% )): ) ,, !G#'"()))|##)5d); & & |  q >%{{<+<+<+>+>??@AA ArN)T)r%r&r'r(r@rRrrrr/r/vsGKK < < < < 48- - - - - - rr/c*eZdZdZdZdZdZdZdS)WADLResolvableDefinitionz=A base class for objects whose definitions may be references.c"d|_||_dS)zInitialize with a WADL application. :param application: A WADLDefinition. Relative links are assumed to be relative to this object's URL. N) _definition application)r>rXs r__init__z!WADLResolvableDefinition.__init__s  &rc|j|jS|}| ||_|S|j|}||}|t d|z||_|S)aReturn the definition of this object, wherever it is. Resource is a good example. A WADL tag may contain a large number of nested tags describing a resource, or it may just contain a 'type' attribute that references a which contains those same tags. Resource.resolve_definition() will return the original Resource object in the first case, and a ResourceType object in the second case. NNo such XML ID: "%s")rW_get_definition_urlrX lookup_xml_id_definition_factoryKeyError)r> object_urlxml_id definitions rresolve_definitionz+WADLResolvableDefinition.resolve_definitions   '# #--//   $D K!// ;;--f55   1J>?? ?%rct)zxTransform an XML ID into a wadllib wrapper object. Which kind of object it is depends on the subclass. NotImplementedErrorr>ids rr^z,WADLResolvableDefinition._definition_factory "###rct)zmFind the URL that identifies an external reference. How to do this depends on the subclass. rer>s rr\z,WADLResolvableDefinition._get_definition_urlrirN)r%r&r'r(rYrcr^r\rrrrUrUsWGG'''   D$$$$$$$$rrUceZdZdZ dfd ZedZedZedZ dd Z d Z dd Z dd Z dd Z edZddZdZdZdZdZddZdZxZS)r z/A resource, possibly bound to a representation.NTctt||||_t |t r%|j|j|_n||_d|_ |I|dkr1|r'tj t||_ n||_ ntd|z||_|,| ||_dS||j|_dSdS)a[ :param application: A WADLApplication. :param url: The URL to this resource. :param resource_type: An ElementTree or tag. :param representation: A string representation. :param media_type: The media type of the representation. :param representation_needs_processing: Set to False if the 'representation' parameter should be used as is. Otherwise, it will be transformed from a string into an appropriate Python data structure, depending on its media type. :param representation_definition: A RepresentationDefinition object describing the structure of this representation. Used in cases when the representation isn't the result of sending a standard GET to the resource. Napplication/jsonz?This resource doesn't define a representation for media type %s)superr rY_url isinstancerrXget_resource_typer<representationjsonloadsrr+ media_typerepresentation_definitionget_representation_definition) r>rXurl resource_typersrvrepresentation_needs_processingrw __class__s rrYzResource.__init__s"* h&&{333 m] 3 3 %'99-HHLDHH%DH"  %///29*.*%n55+7+7D''+9D''/$&01222%  %(41J...66tGG... & %rc|jS)z Return the URL to this resource.)rprks rryz Resource.url,s yrc |jdS|jjd}||S|jjd}|@t|jj}t|dz|zSdS)z@Return the URL to the type definition for this resource, if any.Ntyperh#)r<r4r5rrX markup_url ensureSlashstr)r>rytype_idbases rtype_urlzResource.type_url1s 8 4ho!!&)) ?J(/%%d++  t'233??AADt99s?W, ,trc&|jjdS)zReturn the ID of this resource.rh)r<r4rks rrhz Resource.idCsxt$$rrnc Jt|j|j|j||||S)aBind the resource to a representation of that resource. :param representation: A string representation :param media_type: The media type of the representation. :param representation_needs_processing: Set to False if the 'representation' parameter should be used as is. :param representation_definition: A RepresentationDefinition object describing the structure of this representation. Used in cases when the representation isn't the result of sending a standard GET to the resource. :return: A Resource bound to a particular representation. )r rXryr<)r>rsrvr{rws rbindz Resource.bindHs."($(DH& 7133 3rc|dj}|D]=}|j}|jd|kr|cS>t d|z)zrvdefault_get_responsersrepresentation_tags rrxz&Resource.get_representation_definition^s#u55>2 & &N!/!B!B!D!D!H !(,,[99ZGG%%%%H')>@J)KLL Lrc|D]t}|jdd}|||kr+t ||}||||r|cSudS)aLook up one of this resource's methods by HTTP method. :param http_method: The HTTP method used to invoke the desired method. Case-insensitive and optional. :param media_type: The media type of the representation accepted by the method. Optional. :param query_params: The names and values of any fixed query parameters used to distinguish between two methods that use the same HTTP method. Optional. :param representation_params: The names and values of any fixed representation parameters used to distinguish between two methods that use the same HTTP method and have the same media type. Optional. :return: A MethodDefinition, or None if there's no definition that fits the given constraints. rGN)_method_tag_iterr4r5lowerris_described_by)r> http_methodrv query_paramsrepresentation_params method_tagrGmethods rrzResource.get_methodhs0//11 " "J$((44::<rvs r parameterszResource.parameterss*33 t  %rcR|||S)aA list naming this resource's parameters. :param media_type: Media type of the representation definition whose parameters are being named. Must be present unless this resource is bound to a representation. :raise NoBoundRepresentationError: If this resource is not bound to a representation and media_type was not provided. )rparameter_namesrs rrzResource.parameter_namess,33 '-- .rc#\K|D]}t||VdS)z6An iterator over the methods defined on this resource.N)rr)r>rs r method_iterzResource.method_itersF//11 + +Jz** * * * * + +rc||}|j}|tdD]2}|jd|krt ||cS3dS)aFind a parameter within a representation definition. :param param_name: Name of the parameter to find. :param media_type: Media type of the representation definition whose parameters are being named. Must be present unless this resource is bound to a representation. :raise NoBoundRepresentationError: If this resource is not bound to a representation and media_type was not provided. r1rGN)rr<r=rr4r5r)r> param_namervrbrr7s r get_parameterzResource.get_parameters99*EE '^+33Jw4G4GHH 2 2I##F++z99 y11111:trc|jtd|jdkr|jdkrt d|jz|j|j}|||j|j\}}|tkrm|dvri t|}nX#t$rK tj tj|ddd }n#t$rt|wxYwYnwxYw|St d |jz) zFind the value of a parameter, given the Parameter object. :raise ValueError: If the parameter value can't be converted into its defined type. Nz,Resource is not bound to any representation.rnplain8Don't know how to find value for a parameter of type %s.)dateTimedatez%Y-%m-%dr zEPath traversal not implemented for a representation of media type %s.)rsrrvr3rfrG_dereference_namespacer<rXML_SCHEMA_NS_URIrr;datetimetimestrptime)r> parameterrD namespace_url data_types rget_parameter_valuezResource.get_parameter_valuesl   &,>@@ @ ?0 0 0')))!*1222' 7E +/+F+FM9>,3,3( y!%666!%999 4 ,U 3 3% 4 4 44$,$5"&-z"B"B1Q3"G%JEE)444#-U"3"33 4"E 4L!#G$(O#455 5s* B C0&)CC0C**C0/C0c|d|vr|dd\}}nd}|t}||d}||fS)zSplits a value into namespace URI and value. :param tag: A tag to use as context when mapping namespace names to URIs. N:r)splitr5NS_MAP)r>r<rD namespacens_maprs rrzResource._dereference_namespaces^  ${{322 IuuI 9d33 e##rc@|jj|S)z-Given an ID, find a ResourceType for that ID.)rXresource_typesr5rgs rr^zResource._definition_factorys.222666rc@|jjdS)zReturn the URL that shows where a resource is 'really' defined. If a resource's capabilities are defined by reference, the tag's 'type' attribute will contain the URL to the that defines them. rr<r4r5rks rr\zResource._get_definition_urlx""6***rc|j|j}n'|||}nt d|S)a3Get the most appropriate representation definition. If media_type is provided, the most appropriate definition is the definition of the representation of that media type. If this resource is bound to a representation, the most appropriate definition is the definition of that representation. Otherwise, the most appropriate definition is the definition of the representation served in response to a standard GET. :param media_type: Media type of the definition to find. Must be present unless the resource is bound to a representation. :raise NoBoundRepresentationError: If this resource is not bound to a representation and media_type was not provided. :return: A RepresentationDefinition NzSResource is not bound to any representation, and no media media type was specified.)rsrwrcrxr)r>rvrbs rrz(Resource._find_representation_definitionsk*   *7JJLLJJ  #;;JGGJJ,,-- -,,...rc#K|j}|tdD]}|VdS)z+Iterate over this resource's tags.rN)rcr<r=r)r>rbrs rrzResource._method_tag_iter*sX,,..2 $,,Z-A-ABB  J      r)NNTN)rnTN)NNNNrS)r%r&r'r(rYpropertyryrrhrrxrrrrrrrr^r\rr __classcell__r|s@rr r s992615+/2I2I2I2I2I2IhXX"%%X%/A-1'+3333,LLLJN)-B % % % % . . . .++X+ &-5-5-5` $ $ $777+++ / / / /Frr ceZdZdZdZedZedZedZedZ d dZ d d Z d d Z dS)rz*A wrapper around an XML tag. cD||_|jj|_||_dS)zaInitialize with a tag. :param method_tag: An ElementTree tag. N)r8rXr<)r>r8rs rrYzMethod.__init__4s# ! =4rclt||jtdS)z@Return the definition of a request that invokes the WADL method.request)RequestDefinitionr<findrrks rrzMethod.request=s*!tx}}Z 5J5J'K'KLLLrcvt|j|jt dS)z9Return the definition of the response to the WADL method.r)rr8r<rrrks rrzMethod.responseBs6"$-"&(-- :0F0F"G"GII Irc@|jjdS)z)The XML ID of the WADL method definition.rhrrks rrhz Method.idHsx""4(((rcd|jjdS)zThe name of the WADL method definition. This is also the name of the HTTP method (GET, POST, etc.) that should be used to invoke the WADL method. rGr<r4r5rrks rrGz Method.nameMs(x""6**00222rNc (|jj|fi|S)4Return the request URL to use to invoke this method.)r build_url)r>rNrPs rbuild_request_urlzMethod.build_request_urlVs%t|%lFFoFFFrc *|jj||fi|S)zBuild a representation to be sent when invoking this method. :return: A 2-tuple of (media_type, representation). )rrs)r>rvrNrPs rbuild_representationzMethod.build_representationZs/ +t|*  99(799 9rcd}||j|}|dS|Mt|dkr:|j}|dS ||j|dn#t $rYdSwxYw|t|dkrdS|||S|jjD]D} |||j |ddS#t $rYAwxYwdS)aReturns true if this method fits the given constraints. :param media_type: The method must accept this media type as a representation. :param query_values: These key-value pairs must be acceptable as values for this method's query parameters. This need not be a complete set of parameters acceptable to the method. :param representation_values: These key-value pairs must be acceptable as values for this method's representation parameters. Again, this need not be a complete set of parameters acceptable to the method. NFr T) rrxrJrRrr;rrepresentationsr@r8)r>rv query_valuesrepresentation_valuesrsrs rrzMethod.is_described_bycsf$  !!\GGN%u  #L(9(9A(=(=lGu --(,????   uu  " )())Q..4  %!11%'' '"l:  N 44"))$-88)5222tt    us$A!! A/.A///C!! C.-C.rSNN)NNN) r%r&r'r(rYrrrrhrGrrrrrrrr1sMMXMIIXI ))X)33X3GGGG/3*.9999=A.2555555rrc\eZdZdZdZedZedZd dZd dZ d dZ dS) rzBA wrapper around the description of the request invoking a method.cf||_|jj|_|jj|_||_dS)zInitialize with a tag. :param resource: The resource to which this request can be sent. :param request_tag: An ElementTree tag. N)rr8rXr<)r>r request_tags rrYzRequestDefinition.__init__s/   , =4rc.|dgS)z,Return the query parameters for this method.queryr@rks rrzRequestDefinition.query_paramss{{G9%%%rc#K|jtdD]}t|j|j|V dS)Nrs)r<r=rrrXr8)r>rbs rrz!RequestDefinition.representationsse(**:6F+G+GHH = =J* $-== = = = = = =rNc<|jD]}| |j|kr|cSdS)z1Return the appropriate representation definition.N)rrvr>rvrss rrxz/RequestDefinition.get_representation_definitions>"2 & &N!^%>*%L%L%%%%&Mtrc p||}|td|z|j|fi|S)zBuild a representation to be sent along with this request. :return: A 2-tuple of (media_type, representation). Nz,Cannot build representation of media type %s)rx TypeErrorr)r>rvrNrPrbs rrsz RequestDefinition.representationsT 77 CC  J()** *z|?????rc |j|j|fi|}|jj}t |dkr=d|vrd}nd}||t t |zz }|S)rr ?&)rRrr8ryrJrsorteditems)r>rNrPrQryappends rrzRequestDefinition.build_urls545  |@@/>@@m  1 $ $czz 6If-=-C-C-E-E&F&FGGG GC rrSr) r%r&r'r(rYrrrrxrsrrrrrrsLL   &&X&==X=  @ @ @ @      rrc8eZdZdZd dZdZdZdZdZdZ dS) rz;A wrapper around the description of a response to a method.NcH|j|_||_||_||_dS)zgInitialize with a tag. :param response_tag: An ElementTree tag. N)rXr8r<headers)r>r8 response_tagrs rrYzResponseDefinition.__init__s( $/   rc#Ktd}|j|D]$}t|jj|j|V%dS)zGet an iterator over the representation definitions. These are the representations returned in response to an invocation of this method. rsN)rr<r=rr8rX)r>pathrs r__iter__zResponseDefinition.__iter__sz *++"&("2"24"8"8 N N * )4=:LNN N N N N N Nrc8t|j|j|S)zBind the response to a set of HTTP headers. A WADL response can have associated header parameters, but no other kind. )rr8r<)r>rs rrzResponseDefinition.binds "$-7CCCrc|jtdD]P}|jd|kr0|jddkrt ||cSQdS)z,Find a header parameter within the response.r1rGr3headerN)r<r=rr4r5r)r>rr7s rrz ResponseDefinition.get_parameters}))*W*=*=>> 2 2I $$V,, ::$((11X== y11111trc|jtd|jdkrtd|jz|j|jS)z:Find the value of a parameter, given the Parameter object.Nz,Response object is not bound to any headers.rr)rrr3rfr5rG)r>rs rrz&ResponseDefinition.get_parameter_valuesj < ,>@@ @ ?h & &%&_-.. .| ///rc@|jdS|D]}|j|kr|cSdS)z8Get one of the possible representations of the response.N)r<rvrs rrxz0ResponseDefinition.get_representation_definition sB 8 4" & &N(J66%%%%7trrS) r%r&r'r(rYrrrrrxrrrrrsEE N N NDDD 0 0 0rrcteZdZdZfdZfdZdZedZdZ dZ dd Z d Z d Z d Zd ZxZS)rz2A definition of the structure of a representation.cttt||||_||_dSrS)rorrYr8r<)r>rXr8rr|s rrYz!RepresentationDefinition.__init__s4 &--66{CCC  %rcZtt|ddg|S)Nrr)rorr@)r>r8r|s rr@zRepresentationDefinition.paramss0-t44;; g ** *rc@d||DS)z#Return the names of all parameters.cg|] }|j Sr)rG)r6r1s rr:z.$s>>>u >>>rr)r>r8s rrz(RepresentationDefinition.parameter_names"s">> H(=(=>>>>rcJ|jjdS)z4The media type of the representation described here.r)rcr<r4rks rrvz#RepresentationDefinition.media_type&s!&&((,3K@@rctttjdz }d|z}t jtj}d||zzdz}||S|}d} dt j|zd zd }t j ||t j sn|d zt|z}|dz }j|S) z;Make a random boundary that does not appear in `all_parts`.rz%%0%ddz===============z==Nr Tz^--z(--)?$ascii)flags.) rJreprsysmaxsizerandom randrangereescapeencodesearch MULTILINEr) r> all_parts_width_fmttokenboundarybcounterpatterns r_make_boundaryz'RepresentationDefinition._make_boundary+sT#+/**++&  --.5  O  ry||+h6>>wGGG9Wir|DDD 3W-A qLG   rc4|D]\}}||d|d||d|d|ddS)z$Write MIME headers to a file object.UTF-8s:  Nwriter )r>bufrkeyrDs r_write_headersz'RepresentationDefinition._write_headers=s!  JC IIcjj)) * * * IIe    IIell7++ , , , IIg     'rFc|d||d|r|d|ddS)z,Write a multipart boundary to a file object.s--rrNr)r>rrclosings r_write_boundaryz(RepresentationDefinition._write_boundaryFsd % (//'**+++   IIe    'rcg}|D]\}}}tj}|r&d}dt|dt|d}nd}dt|z}||dd|fd |fg|rJt |t st d t|z||nt |tst d t|ztj d |} | d dD]?} || d|d@|| d d| ||d|} tj}dt| z}||dd|fg|D]B} ||| || |dC||| d||fS)aVGenerate a multipart/form-data message. This is very loosely based on the email module in the Python standard library. However, that module doesn't really support directly embedding binary data in a form: various versions of Python have mangled line separators in different ways, and none of them get it quite right. Since we only need a tiny subset of MIME here, it's easier to implement it ourselves. :return: a tuple of two elements: the Content-Type of the message, and the entire encoded message as a byte string. zapplication/octet-streamzform-data; name="z "; filename="rFztext/plain; charset="utf-8"zform-data; name="%s")z MIME-Versionz1.0z Content-TypezContent-Dispositionzbytes payload expected: %szstring payload expected: %sz \r\n|\r|\nNrrz"multipart/form-data; boundary="%s"T)r)ioBytesIOr rrqbytesrrrrrrr rgetvaluerrKr) r>parts encoded_parts is_binaryrGrDrctypecdisplinesliner encoded_parts r_generate_multipart_formz1RepresentationDefinition._generate_multipart_formNs &+ 1 1 "ItU*,,C =2 $KKKKt.6.t<   ''&.&     5!%//P#$@4;;$NOOO %    !%77E#5U CEEE66!#2#J''DIIdkk'22333IIg&&&& %)**733444   0 0 0 0&&w||M'B'BCCjll4uXF C # U #"   *  L  h / / / IIl # # # IIg     S(D999cllnn$$rc H|}||j}|j||fi|}|j}|dkr/t t |}n|dkrsg}t} |D]G} | | j | } | | ur&| | j dk| j | fH| |\}}n-|dkrtj|}nt!d|z||fS)zzBind the definition to parameter values, creating a document. :return: A 2-tuple (media_type, document). z!application/x-www-form-urlencodedzmultipart/form-databinaryrnzUnsupported media type: '%s')rcr@r8rRrvrrrobjectr5rGrrr.rtdumpsr;) r>rNrPrbr@rQrvdocr&missingr1rDs rrzRepresentationDefinition.bindsM ,,.. ""4=11545 L55$355_ < < <F#3#9#9#;#;<<==CC 0 0 0EhhG N N(,,UZAA''LL%*"8%*e!LMMM";;EBBOJ - - -*-..CC;jHII I3rc@|jj|S)z9Turn a representation ID into a RepresentationDefinition.)rXrepresentation_definitionsr5rgs rr^z,RepresentationDefinition._definition_factorys:>>rBBBrc@|jjdS)aFind the URL containing the representation's 'real' definition. If a representation's structure is defined by reference, the tag's 'href' attribute will contain the URL to the that defines the structure. hrefrrks rr\z,RepresentationDefinition._get_definition_urlrr)F)r%r&r'r(rYr@rrrvrrrr.rr^r\rrs@rrrs<<&&&&& *****???AAXA$?%?%?%B4CCC+++++++rrceZdZdZdZedZedZedZedZ edZ dZ ed Z ed Z ed Zd S) rz5One of the parameters of a representation definition.c:|j|_||_||_dS)aInitialize with respect to a value container. :param value_container: Usually the resource whose representation has this parameter. If the resource is bound to a representation, you'll be able to find the value of this parameter in the representation. This may also be a server response whose headers define a value for this parameter. :tag: The ElementTree tag for this parameter. N)rXvalue_containerr<)r>r;r<s rrYzParameter.__init__s"+6.rc@|jjdS)zThe name of this parameter.rGrrks rrGzParameter.namex""6***rc@|jjdS)zThe style of this parameter.r3rrks rr3zParameter.stylesx""7+++rc@|jjdS)zThe XSD type of this parameter.rrrks rrzParameter.typer=rc@|jjdS)a9The value to which this parameter is fixed, if any. A fixed parameter must be present in invocations of a WADL method, and it must have a particular value. This is commonly used to designate one parameter as containing the name of the server-side operation to be invoked. fixedrrks rrHzParameter.fixed_valuesx""7+++rcj|jjdddvS)z6Whether or not a value for this parameter is required.requiredfalse)1truerrks rrLzParameter.is_requireds4##J88>>@@ ! "rc6|j|S)zThe value of this parameter in the bound representation/headers. :raise NoBoundRepresentationError: If this parameter's value container is not bound to a representation or a set of headers. )r;rrks r get_valuezParameter.get_values#77===rcjfdjtdDS)z7Return the set of acceptable values for this parameter.c0g|]}t|Sr)Option)r6 option_tagr>s rr:z%Parameter.options..s9KKKtZ((KKKrrE)r<r=rrks`rrIzParameter.optionssNKKKK#'8#3#3Jx4H4H#I#IKKK Krcx|jtd}|dSt||S)zGet the link to another resource. The link may be examined and, if its type is of a known WADL description, it may be followed. :return: A Link object, or None. linkN)r<rrr)r>link_tags rrNzParameter.links:8==F!3!344  4D(###rc@|j}|td|jS)aFollow a link from this parameter to a new resource. This only works for parameters whose WADL definition includes a tag that points to a known WADL description. :return: A Resource object for the resource at the other end of the link. Nz(This parameter isn't a link to anything.)rNr;follow)r>rNs rlinked_resourcezParameter.linked_resources'y <GHH H{rN)r%r&r'r(rYrrGr3rrHrLrHrIrNrRrrrrrs??   ++X+,,X,++X+,,X,""X" >>>KKXK  $ $X $  X   rrc.eZdZdZdZedZdS)rKz0One of a set of possible values for a parameter.c"||_||_dS)z}Initialize the option. :param parameter: A Parameter. :param link_tag: An ElementTree