3 1R[ @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 yd dl mZWn ek rd dlmZYnXd d ljjZd 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})tag_namerr5/usr/lib/python3/dist-packages/wadllib/application.pywadl_tagEsrcCs dt|S)z#Turn a tag name into an XPath path.z./)r)rrrr wadl_xpathJsrcGs(i}x|D]}|dk r |j|q W|S)zsz-HasParametersMixin.params..)r) ValueErrortagfindallr)selfr*r)Z param_tagsr)r)r*rparamsvs  zHasParametersMixin.paramsTc Kst||}i}x|D]}|j}|jdk r`||krV|||jkrVtd||||jf|j||<dd|jD}t|dkr||kr|||krtd|||dj|f|r|jr||krtd|||kr||||<||=qWt|dkr td d j|j|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) r/r0 param_valuesZenforce_completenesskw_param_valuesvalidated_valuesr#r3r5rrrvalidate_param_valuess6         z(HasParametersMixin.validate_param_values)N)T)rrrrr0r=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)r/r@rrr__init__sz!WADLResolvableDefinition.__init__cCs^|jdk r|jS|j}|dkr*||_|S|jj|}|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. NzNo such XML ID: "%s")r?_get_definition_urlr@ lookup_xml_id_definition_factoryKeyError)r/Z 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. N)NotImplementedError)r/idrrrrDsz,WADLResolvableDefinition._definition_factorycCs tdS)zmFind the URL that identifies an external reference. How to do this depends on the subclass. N)rI)r/rrrrBsz,WADLResolvableDefinition._get_definition_urlN)rrrrrArHrDrBrrrrr>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|j|||_t|tr2|jj|j|_n||_d|_ |dk rx|dkrl|rdt j t ||_ qx||_ n t d|||_|dk r|dk r||_n|j|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. Nzapplication/jsonz?This resource doesn't define a representation for media type %s)superrrA_url isinstancerr@get_resource_typer-representationjsonloadsrr media_typerepresentation_definitionget_representation_definition)r/r@url resource_typerOrRrepresentation_needs_processingrS) __class__rrrAs( zResource.__init__cCs|jS)z Return the URL to this resource.)rL)r/rrrrU)sz Resource.urlcCsb|jdkrdS|jjjd}|dk r(|S|jjjd}|dk r^t|jjj}t|d|SdS)z@Return the URL to the type definition for this resource, if any.NtyperJ#)r-r%r&rr@ markup_urlZ ensureSlashstr)r/rUZtype_idbaserrrtype_url.s zResource.type_urlcCs |jjdS)zReturn the ID of this resource.rJ)r-r%)r/rrrrJ@sz Resource.idapplication/jsoncCst|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. )rr@rUr-)r/rOrRrWrSrrrbindEsz Resource.bindcCsH|jdj}x*|D]"}|jj}|jjd|kr|SqWtd|dS)z tag's 'type' attribute will contain the URL to the that defines them. rY)r-r%r&)r/rrrrBszResource._get_definition_urlcCs:|jdk r|jj}n|dk r*|j|}ntd|jS)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.)rOrSrHrTr)r/rRrGrrrrls   z(Resource._find_representation_definitionccs,|jj}x|jtdD] }|VqWdS)z+Iterate over this resource's tags.rkN)rHr-r.r)r/rGrjrrrrf's zResource._method_tag_iter)NNTN)r_TN)NNNN)N)N)N)N)rrrrrApropertyrUr^rJr`rTrbrmrnrorqr|rvrDrBrlrf __classcell__rr)rXrrs.1       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)r@r-)r/r)rjrrrrA1s zMethod.__init__cCst||jjtdS)z@Return the definition of a request that invokes the WADL method.request)RequestDefinitionr-findr)r/rrrr:szMethod.requestcCst|j|jjtdS)z9Return the definition of the response to the WADL method.rc)rr)r-rr)r/rrrrc?szMethod.responsecCs|jjjdS)z)The XML ID of the WADL method definition.rJ)r-r%r&)r/rrrrJEsz Method.idcCs|jjjdjS)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. r3)r-r%r&rg)r/rrrr3Jsz Method.nameNcKs|jj|f|S)z4Return the request URL to use to invoke this method.)r build_url)r/r: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). )rrO)r/rRr:r;rrrbuild_representationWszMethod.build_representationcCsd}|dk r$|jj|}|dkr$dS|dk rtt|dkrt|j}|dkrJdSy|j|j|dWntk rrdSX|dkst|dkrdS|dk r|j|Sx@|jjD]4}y|j|j|j |ddStk rYqXqWdS)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) rrTr6r=rir,rhrepresentationsr0r))r/rRZ query_valuesZrepresentation_valuesrOrrrrrh`s<   zMethod.is_described_by)N)NN)NNN) rrrrrArrrcrJr3rrrhrrrrr.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)rkr)r@r-)r/rkZ request_tagrrrrAs  zRequestDefinition.__init__cCs |jdgS)z,Return the query parameters for this method.query)r0)r/rrrriszRequestDefinition.query_paramsccs0x*|jjtdD]}t|j|j|VqWdS)NrO)r-r.rrr@r))r/rGrrrrsz!RequestDefinition.representationsNcCs*x$|jD]}|dks|j|kr|SqWdS)z1Return the appropriate representation definition.N)rrR)r/rRrOrrrrTs z/RequestDefinition.get_representation_definitioncKs,|j|}|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)rT TypeErrorr`)r/rRr:r;rGrrrrOs  z RequestDefinition.representationcKsT|j|j|f|}|jj}t|dkrPd|kr4d}nd}||tt|j7}|S)z4Return the request URL to use to invoke this method.r ?&)r=rir)rUr6r sorteditems)r/r:r;r<rUappendrrrrs zRequestDefinition.build_url)N)NN)N) rrrrrArrirrTrOrrrrrrs    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)r@r)r-headers)r/r)Z response_tagrrrrrAszResponseDefinition.__init__ccs6td}x(|jj|D]}t|jj|j|VqWdS)zGet an iterator over the representation definitions. These are the representations returned in response to an invocation of this method. rON)rr-r.rr)r@)r/pathrdrrr__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-)r/rrrrr`szResponseDefinition.bindcCsHxB|jjtdD].}|jjd|kr|jjddkrt||SqWdS)z,Find a header parameter within the response.r#r3r$headerN)r-r.rr%r&r)r/rpr(rrrrqs z ResponseDefinition.get_parametercCs8|jdkrtd|jdkr*td|j|jj|jS)z:Find the value of a parameter, given the Parameter object.Nz,Response object is not bound to any headers.rz8Don't know how to find value for a parameter of type %s.)rrr$rIr&r3)r/rzrrrr|s   z&ResponseDefinition.get_parameter_valuecCs.|jdkrdSx|D]}|j|kr|SqWdS)z8Get one of the possible representations of the response.N)r-rR)r/rRrOrrrrT s    z0ResponseDefinition.get_representation_definition)N) rrrrrArr`rqr|rTrrrrrs   cszeZdZdZfddZfddZddZedd Zd d Z d d Z dddZ ddZ ddZ ddZddZZS)rz2A definition of the structure of a representation.cs tt|j|||_||_dS)N)rKrrAr)r-)r/r@r)rd)rXrrrAsz!RepresentationDefinition.__init__cstt|jddg|S)Nrrr)rKrr0)r/r))rXrrr0s zRepresentationDefinition.paramscCsdd|j|DS)z#Return the names of all parameters.cSsg|] }|jqSr)r3)r'r#rrrr+!sz.)r0)r/r)rrrrnsz(RepresentationDefinition.parameter_namescCs|jjjdS)z4The media type of the representation described here.ra)rHr-r%)r/rrrrR#sz#RepresentationDefinition.media_typec Cstttjd}d|}tjtj}d ||d}|dkrB|S|}d}xHdtj|d jd }tj ||tj d sxP|d t |}|d7}qLW|S)z;Make a random boundary that does not appear in `all_parts`.r~z%%0%dd=z==Nr z^--z(--)?$ascii)flags.z===============) r6reprsysmaxsizerandomZ randrangereescapeencodesearch MULTILINEr\) r/Z all_partsZ_widthZ_fmttokenboundarybZcounterpatternrrr_make_boundary(s  z'RepresentationDefinition._make_boundarycCsTxD|D]<\}}|j|jd|jd|j|jd|jdqW|jddS)z$Write MIME headers to a file object.zUTF-8s: s N)writer)r/bufrkeyr1rrr_write_headers:s  z'RepresentationDefinition._write_headersFcCs6|jd|j|jd|r(|jd|jddS)z,Write a multipart boundary to a file object.s--zUTF-8s N)rr)r/rrclosingrrr_write_boundaryCs   z(RepresentationDefinition._write_boundaryc Csg}x|D]\}}}tj}|r>d}dt|t|f}nd}dt|}|j|dd|fd|fg|rt|tstd t||j|njt|t std t|t j d |} x.| d dD]} |j| j d|jdqW|j| dj d|j |jq W|jdj|} tj}dt| }|j|dd|fgx.|D]&} |j|| |j| |jdqLW|j|| dd||jfS)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" MIME-Version1.0z Content-TypezContent-Dispositionzbytes payload expected: %szstr payload expected: %sz \r\n|\r|\nNr~zUTF-8s z"multipart/form-data; boundary="%s"T)r)rrr)rr)ioBytesIOr rrMbytesrrYrr\rrrrgetvaluerr7r) r/partsZ encoded_partsZ is_binaryr3r1rZctypeZcdisplineslinerZ encoded_partrrr_generate_multipart_formKsJ           z1RepresentationDefinition._generate_multipart_formc Ks|j}|j|j}|j||f|}|j}|dkrDtt|j}n~|dkrg}t} x:|D]2} |j | j | } | | k r\|j | j dk| j | fq\W|j |\}}n |dkrtj|}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-databinaryzapplication/jsonzUnsupported media type: '%s')rHr0r)r=rRr rrobjectr&r3rrYrrPdumpsr,) r/r:r;rGr0r<rRdocrZmissingr#r1rrrr`s&     zRepresentationDefinition.bindcCs|jjj|S)z9Turn a representation ID into a RepresentationDefinition.)r@representation_definitionsr&)r/rJrrrrDsz,RepresentationDefinition._definition_factorycCs|jjjdS)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. Zhref)r-r%r&)r/rrrrBsz,RepresentationDefinition._get_definition_url)F)rrrrrAr0rnrrRrrrrr`rDrBrrr)rXrrs    @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)r@value_containerr-)r/rr-rrrrAs zParameter.__init__cCs|jjjdS)zThe name of this parameter.r3)r-r%r&)r/rrrr3szParameter.namecCs|jjjdS)zThe style of this parameter.r$)r-r%r&)r/rrrr$szParameter.stylecCs|jjjdS)zThe XSD type of this parameter.rY)r-r%r&)r/rrrrYszParameter.typecCs|jjjdS)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. Zfixed)r-r%r&)r/rrrr4s zParameter.fixed_valuecCs|jjjddjdkS)z6Whether or not a value for this parameter is required.ZrequiredZfalse1true)rr)r-r%r&rg)r/rrrr8szParameter.is_requiredcCs |jj|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. )rr|)r/rrr get_valueszParameter.get_valuecsfddjjtdDS)z7Return the set of acceptable values for this parameter.csg|]}t|qSr)Option)r' option_tag)r/rrr+sz%Parameter.options..r2)r-r.r)r/r)r/rr5s zParameter.optionscCs&|jjtd}|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)r/link_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)r/rrrrlinked_resources zParameter.linked_resourceN)rrrrrArr3r$rYr4r8rr5rrrrrrrs      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