o R `@sdZeZgdZddlZddlmZddlZddlZddl Z ddl Z ddl Z ddl Z zddl mZWneyAddlmZYnwz ddlmmZWney_ddlmmZYnwddlmZmZddlmZmZddlmZd Zd Z d d Z!d dZ"ddZ#Gddde$Z%Gddde%Z&Gddde%Z'Gddde(Z)GdddZ*Gddde)Z+Gddde+Z,Gdd d e)Z-Gd!d"d"e)e*Z.Gd#d$d$e*Z/Gd%d&d&e+e*Z0Gd'd(d(e)Z1Gd)d*d*e)Z2Gd+d,d,e+Z3Gd-d.d.e)Z4Gd/d0d0e)Z5dS)1aNavigate 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_tagHsrcCs dt|S)z#Turn a tag name into an XPath path.z./)rrrrr wadl_xpathMs rcGs$i}|D] }|dur||q|S)zsz-HasParametersMixin.params..)r- ValueErrortagfindallr)selfr.r-Z param_tagsrr,rparamsys  zHasParametersMixin.paramsTc Ks t||}i}|D]h}|j}|jdur/||vr*|||jkr*td||||jf|j||<dd|jD}t|dkrU||vrU|||vrUtd|||d|f|rd|jrd||vrdtd|||vrq||||<||=q t|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'cSg|]}|jqSr)value)r*optionrrrr/z.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_valuer0optionslenjoin is_requiredkeys) r3r4 param_valuesZenforce_completenesskw_param_valuesvalidated_valuesr&r9r;rrrvalidate_param_valuessJ         z(HasParametersMixin.validate_param_valuesN)T)rrr r!r4rCrrrrr%vs  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)r3rGrrr__init__ z!WADLResolvableDefinition.__init__cCs^|jdur|jS|}|dur||_|S|j|}||}|dur*td|||_|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")rF_get_definition_urlrG lookup_xml_id_definition_factoryKeyError)r3Z object_urlxml_id definitionrrrresolve_definitions    z+WADLResolvableDefinition.resolve_definitioncCt)zxTransform an XML ID into a wadllib wrapper object. Which kind of object it is depends on the subclass. NotImplementedErrorr3idrrrrMz,WADLResolvableDefinition._definition_factorycCrR)zmFind the URL that identifies an external reference. How to do this depends on the subclass. rSr3rrrrKrWz,WADLResolvableDefinition._get_definition_urlN)rrr r!rHrQrMrKrrrrrEs  " rEcseZdZdZ   d'fdd ZeddZedd Zed d Z  d(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|tr|j|j|_n||_d|_ |dur<|dkr6|r2t t ||_ n ||_ nt d|||_|durU|durL||_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)superrrH_url isinstancerrGget_resource_typer1representationjsonloadsrr# media_typerepresentation_definitionget_representation_definition)r3rGurl resource_typer^rarepresentation_needs_processingrb __class__rrrHs2   zResource.__init__cCs|jS)z Return the URL to this resource.)r[rXrrrrd,sz Resource.urlcCsb|jdurdS|jjd}|dur|S|jjd}|dur/t|jj}t|d|SdS)z@Return the URL to the type definition for this resource, if any.NtyperV#)r1r(r)rrG markup_urlZ ensureSlashstr)r3rdZtype_idbaserrrtype_url1s zResource.type_urlcCs |jjdS)zReturn the ID of this resource.rV)r1r(rXrrrrVC z Resource.idrYcCst|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. )rrGrdr1)r3r^rarfrbrrrbindHs z Resource.bindcCsD|dj}|D]}|j}|jd|kr|Sqtd|)z tag's 'type' attribute will contain the URL to the that defines them. rir1r(r)rXrrrrKzResource._get_definition_urlcCs>|jdur|j}|S|dur||}|Std)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.)r^rbrQrcr)r3rarPrrrr}s   z(Resource._find_representation_definitionccs*|j}|tdD]}|Vq dS)z+Iterate over this resource's tags.r{N)rQr1r2r)r3rPrzrrrrv*s  zResource._method_tag_iter)NNTN)rYTN)NNNNrD)rrr r!rHpropertyrdrnrVrprcrrrrrrrrrMrKr}rv __classcell__rrrgrrs>4      !   0 #rc@sneZdZdZddZeddZeddZedd 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-rGr1)r3r-rzrrrrH4s  zMethod.__init__cCst||jtdS)z@Return the definition of a request that invokes the WADL method.request)RequestDefinitionr1findrrXrrrr=szMethod.requestcCst|j|jtdS)z9Return the definition of the response to the WADL method.rs)rr-r1rrrXrrrrsBszMethod.responsecCr)z)The XML ID of the WADL method definition.rVrrXrrrrVHz 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. r9r1r(r)rwrXrrrr9Msz Method.nameNcKs|jj|fi|S)4Return the request URL to use to invoke this method.)r build_url)r3r@rArrrbuild_request_urlVzMethod.build_request_urlcKs|jj||fi|S)zBuild a representation to be sent when invoking this method. :return: A 2-tuple of (media_type, representation). )rr^)r3rar@rArrrbuild_representationZs zMethod.build_representationc Csd}|dur|j|}|durdS|dur:t|dkr:|j}|dur%dSz ||j|dWn ty9YdSw|dusDt|dkrFdS|durO||S|jjD]}z|||j |dWdStymYqSwdS)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) rrcr<rCryr0rxrepresentationsr4r-)r3raZ query_valuesZrepresentation_valuesr^rrrrrxcsJ     zMethod.is_described_byrDNN)NNN) rrr r!rHrrrsrVr9rrrxrrrrr1s$       rc@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)r{r-rGr1)r3r{Z request_tagrrrrHs   zRequestDefinition.__init__cCs |dgS)z,Return the query parameters for this method.queryr4rXrrrryrozRequestDefinition.query_paramsccs.|jtdD] }t|j|j|Vq dS)Nr^)r1r2rrrGr-)r3rPrrrrs  z!RequestDefinition.representationsNcCs*|jD]}|dus|j|kr|SqdS)z1Return the appropriate representation definition.N)rrar3rar^rrrrcs z/RequestDefinition.get_representation_definitioncKs0||}|durtd||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)rc TypeErrorrp)r3rar@rArPrrrr^s z RequestDefinition.representationcKsX|j|j|fi|}|jj}t|dkr*d|vrd}nd}||tt|7}|S)rr ?&)rCryr-rdr<r sorteditems)r3r@rArBrdappendrrrrs zRequestDefinition.build_urlrDr) rrr r!rHrryrrcr^rrrrrrs     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)rGr-r1headers)r3r-Z response_tagrrrrrHs zResponseDefinition.__init__ccs4td}|j|D] }t|jj|j|Vq dS)zGet an iterator over the representation definitions. These are the representations returned in response to an invocation of this method. r^N)rr1r2rr-rG)r3pathrtrrr__iter__s zResponseDefinition.__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-r1)r3rrrrrpszResponseDefinition.bindcCsH|jtdD]}|jd|kr!|jddkr!t||SqdS)z,Find a header parameter within the response.r&r9r'headerN)r1r2rr(r)r)r3rr+rrrrsz ResponseDefinition.get_parametercCs8|jdur td|jdkrtd|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'rTr)r9)r3rrrrrs  z&ResponseDefinition.get_parameter_valuecCs.|jdurdS|D] }|j|kr|Sq dS)z8Get one of the possible representations of the response.N)r1rarrrrrc s  z0ResponseDefinition.get_representation_definitionrD) rrr r!rHrrprrrcrrrrrs    rcszeZdZdZfddZfddZddZedd Zd d Z d d Z dddZ ddZ ddZ ddZddZZS)rz2A definition of the structure of a representation.cs tt||||_||_dSrD)rZrrHr-r1)r3rGr-rtrgrrrHs z!RepresentationDefinition.__init__cstt|ddg|S)Nrr)rZrr4r3r-rgrrr4s zRepresentationDefinition.paramscCsdd||DS)z#Return the names of all parameters.cSr5r)r9)r*r&rrrr/$r8z.rrrrrr"rz(RepresentationDefinition.parameter_namescCs|jjdS)z4The media type of the representation described here.rq)rQr1r(rXrrrra&sz#RepresentationDefinition.media_typec Cstttjd}d|}ttj}d||d}|dur!|S|}d} dt|d d }tj ||tj d s> |S|d t |}|d7}q&) z;Make a random boundary that does not appear in `all_parts`.rz%%0%ddz===============z==Nr Tz^--z(--)?$ascii)flags.) r<reprsysmaxsizerandomZ randrangereescapeencodesearch MULTILINErl) r3Z all_parts_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)r3bufrkeyr6rrr_write_headers=s   z'RepresentationDefinition._write_headersFcCs6|d||d|r|d|ddS)z,Write a multipart boundary to a file object.s--rrNr)r3rrclosingrrr_write_boundaryFs  z(RepresentationDefinition._write_boundaryc Csg}|D]|\}}}t}|rd}dt|t|f}nd}dt|}||dd|fd|fg|rFt|ts@tdt|||n3t|t sStd 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: %szstring payload expected: %sz \r\n|\r|\nNrrz"multipart/form-data; boundary="%s"T)r)ioBytesIOr rr\bytesrrirrrrrrgetvaluerr=r) r3partsZ encoded_partsZ is_binaryr9r6rZctypeZcdisplineslinerZ encoded_partrrr_generate_multipart_formNsT             z1RepresentationDefinition._generate_multipart_formc Ks|}||j}|j||fi|}|j}|dkr'tt|}||fS|dkrWg}t} |D]} | | j | } | | urK| | j dk| j | fq2| |\}}||fS|dkrdt|}||fStd|)zzBind the definition to parameter values, creating a document. :return: A 2-tuple (media_type, document). z!application/x-www-form-urlencodedzmultipart/form-databinaryrYzUnsupported media type: '%s')rQr4r-rCrar rrobjectr)r9rrirr_dumpsr0) r3r@rArPr4rBradocrmissingr&r6rrrrps2    zRepresentationDefinition.bindcCr)z9Turn a representation ID into a RepresentationDefinition.)rGrepresentation_definitionsr)rUrrrrMrz,RepresentationDefinition._definition_factorycCr)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. ZhrefrrXrrrrKrz,RepresentationDefinition._get_definition_url)F)rrr r!rHr4rrrarrrrrprMrKrrrrgrrs    Arc@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)rGvalue_containerr1)r3rr1rrrrHs  zParameter.__init__cCr)zThe name of this parameter.r9rrXrrrr9rzParameter.namecCr)zThe style of this parameter.r'rrXrrrr'rzParameter.stylecCr)zThe XSD type of this parameter.rirrXrrrrirzParameter.typecCr)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. fixedrrXrrrr:s zParameter.fixed_valuecCs|jjdddvS)z6Whether or not a value for this parameter is required.requiredZfalse)1truerrXrrrr>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. )rrrXrrr get_values zParameter.get_valuecsfddjtdDS)z7Return the set of acceptable values for this parameter.csg|]}t|qSr)Option)r* option_tagrXrrr/sz%Parameter.options..r7)r1r2rrXrrXrr;s zParameter.optionscCs&|jtd}|durdSt||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)r1rrr)r3link_tagrrrrs  zParameter.linkcCs|j}|dur 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.)rr0follow)r3rrrrlinked_resources zParameter.linked_resourceN)rrr r!rHrr9r'rir:r>rr;rrrrrrrs(        rc@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