U Q[ @sdZeZddddddddd d g Zd d lZd d lmZd d lZd d lZd d l Z d d l Z d d l Z d d l Z zd dl mZWn ek rd dlmZYnXd d lmmZd dlmZmZd dlmZmZd dlmZdZdZddZddZ ddZ!Gdd d e"Z#Gddde#Z$Gddde#Z%Gddde&Z'Gd d!d!Z(Gd"d#d#e'Z)Gd$dde)Z*Gd%dde'Z+Gd&d'd'e'e(Z,Gd(dde(Z-Gd)dde)e(Z.Gd*dde'Z/Gd+d,d,e'Z0Gd-dde)Z1Gd.d d e'Z2Gd/dde'Z3d S)0aNavigate 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/XMLSchemacCsd|S)z)Scope a tag name with the WADL namespace.z&{http://research.sun.com/wadl/2006/10}Ztag_namerr5/usr/lib/python3/dist-packages/wadllib/application.pywadl_tagEsrcCs dt|S)z#Turn a tag name into an XPath path.z./)rrrrr wadl_xpathJsrcGs$i}|D]}|dk r||q|S)zsz-HasParametersMixin.params..)r+ ValueErrortagfindallr)selfr,r+Z param_tagsrr*rparamsvs  zHasParametersMixin.paramsTc Ks t||}i}|D]}|j}|jdk r^||krT|||jkrTtd||||jf|j||<dd|jD}t|dkr||kr|||krtd|||d|f|r|jr||krtd|||kr||||<||=qt|dkrtd d ||S) aMake sure the given valueset is valid. A valueset might be invalid because it contradicts a fixed value or (if enforce_completeness is True) because it lacks a required value. :param params: A list of Parameter objects. :param param_values: A dictionary of parameter values. May include paramters whose names are not valid Python identifiers. :param enforce_completeness: If True, this method will raise an exception when the given value set lacks a value for a required parameter. :param kw_param_values: A dictionary of parameter values. :return: A dictionary of validated parameter values. Nz=Value '%s' for parameter '%s' conflicts with fixed value '%s'cSsg|] }|jqSr)value)r(optionrrrr-sz.r z=Invalid value '%s' for parameter '%s': valid values are: "%s"z", "z$No value for required parameter '%s'zUnrecognized parameter(s): '%s'z', ') rname fixed_valuer.optionslenjoin is_requiredkeys) r1r2 param_valuesZenforce_completenesskw_param_valuesvalidated_valuesr$r5r7rrrvalidate_param_valuessL        z(HasParametersMixin.validate_param_values)N)T)rrrr r2r?rrrrr#ss r#c@s0eZdZdZddZddZddZdd Zd S) WADLResolvableDefinitionz=A base class for objects whose definitions may be references.cCsd|_||_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)r1rBrrr__init__sz!WADLResolvableDefinition.__init__cCs^|jdk r|jS|}|dkr*||_|S|j|}||}|dkrTtd|||_|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")rA_get_definition_urlrB lookup_xml_id_definition_factoryKeyError)r1Z object_urlxml_id definitionrrrresolve_definitions    z+WADLResolvableDefinition.resolve_definitioncCs tdS)zxTransform an XML ID into a wadllib wrapper object. Which kind of object it is depends on the subclass. NNotImplementedErrorr1idrrrrGsz,WADLResolvableDefinition._definition_factorycCs tdS)zmFind the URL that identifies an external reference. How to do this depends on the subclass. NrLr1rrrrEsz,WADLResolvableDefinition._get_definition_urlN)rrrr rCrKrGrErrrrr@s  "r@cseZdZdZd'fdd ZeddZedd Zed d Zd(d dZ ddZ d)ddZ d*ddZ d+ddZ eddZd,ddZddZddZdd Zd!d"Zd-d#d$Zd%d&ZZS).rz/A resource, possibly bound to a representation.NTcstt||||_t|tr2|j|j|_n||_d|_ |dk rx|dkrl|rdt t ||_ qx||_ n t d|||_|dk r|dk r||_n||j|_dS)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)superrrC_url isinstancerrBget_resource_typer/representationjsonloadsrr! media_typerepresentation_definitionget_representation_definition)r1rBurl resource_typerVrYrepresentation_needs_processingrZ __class__rrrCs0  zResource.__init__cCs|jS)z Return the URL to this resource.)rSrPrrrr\)sz Resource.urlcCsb|jdkrdS|jjd}|dk r(|S|jjd}|dk r^t|jj}t|d|SdS)z@Return the URL to the type definition for this resource, if any.NtyperO#)r/r&r'rrB markup_urlZ ensureSlashstr)r1r\Ztype_idbaserrrtype_url.s zResource.type_urlcCs |jjdS)zReturn the ID of this resource.rO)r/r&rPrrrrO@sz Resource.idrQcCst|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. )rrBr\r/)r1rVrYr^rZrrrbindEs z Resource.bindcCsH|dj}|D]&}|j}|jd|kr|Sqtd|dS)z tag's 'type' attribute will contain the URL to the that defines them. rar/r&r'rPrrrrEszResource._get_definition_urlcCs:|jdk r|j}n|dk r*||}ntd|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.)rVrZrKr[r)r1rYrJrrrrss   z(Resource._find_representation_definitionccs(|j}|tdD] }|VqdS)z+Iterate over this resource's tags.rrN)rKr/r0r)r1rJrqrrrrm's zResource._method_tag_iter)NNTN)rQTN)NNNN)N)N)N)N)rrrr rCpropertyr\rfrOrgr[rirurvrwryrr~rGrErsrm __classcell__rrr_rrs>4      !   0 #c@sfeZdZdZddZeddZeddZedd Zed d Z dd dZ dddZ dddZ d S)rz*A wrapper around an XML tag. cCs||_|jj|_||_dS)zaInitialize with a tag. :param method_tag: An ElementTree tag. N)r+rBr/)r1r+rqrrrrC1s zMethod.__init__cCst||jtdS)z@Return the definition of a request that invokes the WADL method.request)RequestDefinitionr/findrrPrrrr:szMethod.requestcCst|j|jtdS)z9Return the definition of the response to the WADL method.rj)rr+r/rrrPrrrrj?szMethod.responsecCs|jjdS)z)The XML ID of the WADL method definition.rOrrPrrrrOEsz Method.idcCs|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. r5r/r&r'rnrPrrrr5Jsz Method.nameNcKs|jj|f|S)4Return the request URL to use to invoke this method.)r build_url)r1r<r=rrrbuild_request_urlSszMethod.build_request_urlcKs|jj||f|S)zBuild a representation to be sent when invoking this method. :return: A 2-tuple of (media_type, representation). )rrV)r1rYr<r=rrrbuild_representationWs zMethod.build_representationc Csd}|dk r$|j|}|dkr$dS|dk rvt|dkrv|j}|dkrJdSz||j|dWntk rtYdSX|dkst|dkrdS|dk r||S|jjD]8}z|||j |dWdStk rYqXqdS)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) rr[r8r?rpr.rorepresentationsr2r+)r1rYZ query_valuesZrepresentation_valuesrVrrrrro`sL   zMethod.is_described_by)N)NN)NNN) rrrr rCrrrjrOr5rrrorrrrr.s"       c@sNeZdZdZddZeddZeddZdd d Zdd d Z dd dZ dS)rzBA wrapper around the description of the request invoking a method.cCs$||_|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)rrr+rBr/)r1rrZ request_tagrrrrCs  zRequestDefinition.__init__cCs |dgS)z,Return the query parameters for this method.queryr2rPrrrrpszRequestDefinition.query_paramsccs,|jtdD]}t|j|j|VqdS)NrV)r/r0rrrBr+)r1rJrrrrs z!RequestDefinition.representationsNcCs*|jD]}|dks|j|kr|SqdS)z1Return the appropriate representation definition.N)rrYr1rYrVrrrr[s  z/RequestDefinition.get_representation_definitioncKs,||}|dkrtd||j|f|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)r[ TypeErrorrg)r1rYr<r=rJrrrrVs  z RequestDefinition.representationcKsT|j|j|f|}|jj}t|dkrPd|kr4d}nd}||tt|7}|S)rr ?&)r?rpr+r\r8r sorteditems)r1r<r=r>r\appendrrrrs zRequestDefinition.build_url)N)NN)N) rrrr rCrrprr[rVrrrrrrs     rc@sBeZdZdZdddZddZddZd d Zd d Zd dZ dS)rz;A wrapper around the description of a response to a method.NcCs|j|_||_||_||_dS)zgInitialize with a tag. :param response_tag: An ElementTree tag. N)rBr+r/headers)r1r+Z response_tagrrrrrCszResponseDefinition.__init__ccs2td}|j|D]}t|jj|j|VqdS)zGet an iterator over the representation definitions. These are the representations returned in response to an invocation of this method. rVN)rr/r0rr+rB)r1pathrkrrr__iter__szResponseDefinition.__iter__cCst|j|j|S)zBind the response to a set of HTTP headers. A WADL response can have associated header parameters, but no other kind. )rr+r/)r1rrrrrgszResponseDefinition.bindcCsH|jtdD]2}|jd|kr|jddkrt||SqdS)z,Find a header parameter within the response.r$r5r%headerN)r/r0rr&r'r)r1rxr)rrrrys z ResponseDefinition.get_parametercCs8|jdkrtd|jdkr*td|j|j|jS)z:Find the value of a parameter, given the Parameter object.Nz,Response object is not bound to any headers.rr{)rrr%rMr'r5)r1rrrrrs  z&ResponseDefinition.get_parameter_valuecCs.|jdkrdS|D]}|j|kr|SqdS)z8Get one of the possible representations of the response.N)r/rYrrrrr[ s    z0ResponseDefinition.get_representation_definition)N) rrrr rCrrgryrr[rrrrrs   cszeZdZdZfddZfddZddZedd Zd d Z d d Z dddZ ddZ ddZ ddZddZZS)rz2A definition of the structure of a representation.cs tt||||_||_dS)N)rRrrCr+r/)r1rBr+rkr_rrrCsz!RepresentationDefinition.__init__cstt|ddg|S)Nrrz)rRrr2r1r+r_rrr2s zRepresentationDefinition.paramscCsdd||DS)z#Return the names of all parameters.cSsg|] }|jqSr)r5)r(r$rrrr-!sz.rrrrrrvsz(RepresentationDefinition.parameter_namescCs|jjdS)z4The media type of the representation described here.rh)rKr/r&rPrrrrY#sz#RepresentationDefinition.media_typec Cstttjd}d|}ttj}d||d}|dkrB|S|}d}dt|dd }tj ||tj d svq|d t |}|d7}qJ|S) z;Make a random boundary that does not appear in `all_parts`.rz%%0%ddz===============z==Nr z^--z(--)?$ascii)flags.) r8reprsysmaxsizerandomZ randrangereescapeencodesearch MULTILINErd) r1Z all_partsZ_widthZ_fmttokenboundarybZcounterpatternrrr_make_boundary(s  z'RepresentationDefinition._make_boundarycCsP|D]<\}}||d|d||d|dq|ddS)z$Write MIME headers to a file object.UTF-8s:  Nwriter)r1bufrkeyr3rrr_write_headers:s    z'RepresentationDefinition._write_headersFcCs6|d||d|r(|d|ddS)z,Write a multipart boundary to a file object.s--rrNr)r1rrclosingrrr_write_boundaryCs   z(RepresentationDefinition._write_boundaryc Csg}|D]\}}}t}|r8d}dt|t|f}nd}dt|}||dd|fd|fg|rt|tstdt|||nft|t std t|t d |} | d d D]} || d |dq|| d  d | |q|d|} t}dt| }||dd|fg|D]&} ||| || |dq>|j|| dd||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-streamz#form-data; name="%s"; filename="%s"ztext/plain; charset="utf-8"zform-data; name="%s")z MIME-Versionz1.0z Content-TypezContent-Dispositionzbytes payload expected: %szstr payload expected: %sz \r\n|\r|\nNrrz"multipart/form-data; boundary="%s"T)r)ioBytesIOr rrTbytesrrarrdrrrrgetvaluerr9r) r1partsZ encoded_partsZ is_binaryr5r3rZctypeZcdisplineslinerZ encoded_partrrr_generate_multipart_formKsR         z1RepresentationDefinition._generate_multipart_formc Ks|}||j}|j||f|}|j}|dkrDtt|}nz|dkrg}t} |D]2} | | j | } | | k rZ| | j dk| j | fqZ| |\}}n |dkrt|}n td|||fS)zzBind the definition to parameter values, creating a document. :return: A 2-tuple (media_type, document). z!application/x-www-form-urlencodedzmultipart/form-databinaryrQzUnsupported media type: '%s')rKr2r+r?rYr rrobjectr'r5rrarrWdumpsr.) r1r<r=rJr2r>rYdocrZmissingr$r3rrrrgs.   zRepresentationDefinition.bindcCs|jj|S)z9Turn a representation ID into a RepresentationDefinition.)rBrepresentation_definitionsr'rNrrrrGsz,RepresentationDefinition._definition_factorycCs|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. ZhrefrrPrrrrEsz,RepresentationDefinition._get_definition_url)F)rrrr rCr2rvrrYrrrrrgrGrErrrr_rrs    @c@seZdZdZddZeddZeddZedd Zed d Z ed d Z ddZ eddZ eddZ eddZdS)rz5One of the parameters of a representation definition.cCs|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)rBvalue_containerr/)r1rr/rrrrCs zParameter.__init__cCs|jjdS)zThe name of this parameter.r5rrPrrrr5szParameter.namecCs|jjdS)zThe style of this parameter.r%rrPrrrr%szParameter.stylecCs|jjdS)zThe XSD type of this parameter.rarrPrrrraszParameter.typecCs|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. ZfixedrrPrrrr6s zParameter.fixed_valuecCs|jjdddkS)z6Whether or not a value for this parameter is required.ZrequiredZfalse)1truerrPrrrr:szParameter.is_requiredcCs |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. )rrrPrrr get_valueszParameter.get_valuecsfddjtdDS)z7Return the set of acceptable values for this parameter.csg|]}t|qSr)Option)r( option_tagrPrrr-sz%Parameter.options..r4)r/r0rrPrrPrr7s zParameter.optionscCs&|jtd}|dkrdSt||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)r1link_tagrrrrs zParameter.linkcCs|j}|dkrtd|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.)rr.follow)r1rrrrlinked_resources zParameter.linked_resourceN)rrrr rCrr5r%rar6r:rr7rrrrrrrs&        c@s$eZdZdZddZeddZdS)rz0One of a set of possible values for a parameter.cCs||_||_dS)z}Initialize the option. :param parameter: A Parameter. :param link_tag: An ElementTree