o
R
` @ s d Z eZg dZddlZddlmZ ddlZddlZddl Z ddl
Z
ddl Z ddl Z zddl
mZ W n eyA ddlmZ Y nw z ddlm mZ W n ey_ ddlm mZ Y nw ddlmZmZ ddlmZm Z ddl m Z d Z d
Z d d Z!d
d Z"dd Z#G dd de$Z%G dd de%Z&G dd de%Z'G dd de(Z)G dd dZ*G dd d e)Z+G d d d e+Z,G d d d e)Z-G d!d" d"e)e*Z.G d#d$ d$e*Z/G d%d& d&e+e*Z0G d'd( d(e)Z1G d)d* d*e)Z2G d+d, d,e+Z3G d-d. d.e)Z4G d/d0 d0e)Z5dS )1a Navigate 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 WADLError N)quote) urlencode)URImerge)
_make_unicode
_string_types) iso_strptimez xmlns:mapz http://www.w3.org/2001/XMLSchemac C s d| S )z)Scope a tag name with the WADL namespace.z&{http://research.sun.com/wadl/2006/10} tag_namer r 5/usr/lib/python3/dist-packages/wadllib/application.pywadl_tagH s r c C s dt | S )z#Turn a tag name into an XPath path.z./)r r r r r
wadl_xpathM s r c G s$ i }| D ] }|dur| | q|S )z s
z-HasParametersMixin.params..)r/
ValueErrortagfindallr )selfr0 r/
param_tagsr r. r paramsy s
zHasParametersMixin.paramsTc K s
t ||}i }|D ]h}|j}|jdur/||v r*|| |jkr*td|| ||jf |j||< dd |jD }t|dkrU||v rU|| |vrUtd|| |d|f |rd|jrd||vrdtd| ||v rq|| ||< ||= q t|dkrtd d
| |S ) a Make 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'c S g | ]}|j qS r )value)r, optionr r r r1 z.r z=Invalid value '%s' for parameter '%s': valid values are: "%s"z", "z$No value for required parameter '%s'z Unrecognized parameter(s): '%s'z', ') r name fixed_valuer2 optionslenjoin is_requiredkeys) r5 r7 param_valuesenforce_completenesskw_param_valuesvalidated_valuesr( r< r> r r r validate_param_values sD
z(HasParametersMixin.validate_param_valuesN)T)r r! r" r# r7 rG r r r r r' v s
r' c @ s0 e Zd ZdZdd Zdd Zdd Zdd Zd
S ) WADLResolvableDefinitionz=A base class for objects whose definitions may be references.c C s 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)r5 rK r r r __init__
z!WADLResolvableDefinition.__init__c C s^ | j dur| j S | }|du r| | _ | S | j|}| |}|du r*td| || _ |S )a Return 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")rJ _get_definition_urlrK
lookup_xml_id_definition_factoryKeyError)r5
object_urlxml_id
definitionr r r resolve_definition s
z+WADLResolvableDefinition.resolve_definitionc C t )zxTransform an XML ID into a wadllib wrapper object.
Which kind of object it is depends on the subclass.
NotImplementedErrorr5 idr r r rQ z,WADLResolvableDefinition._definition_factoryc C rW )zmFind the URL that identifies an external reference.
How to do this depends on the subclass.
rX r5 r r r rO r\ z,WADLResolvableDefinition._get_definition_urlN)r r! r" r# rL rV rQ rO r r r r rI s " rI c s e Zd ZdZ d' fdd Zedd Zedd Zed
d Z d(d
dZ dd Z
d)ddZ d*ddZ d*ddZ
edd Zd*ddZdd Zd d Zd d Zd!d" Zd*d#d$Zd%d& Z ZS )+r z/A resource, possibly bound to a representation.NTc s t t| | || _t|tr| j|j| _n|| _d| _ |dur<|dkr6|r2t
t || _ n
|| _ nt
d| || _|durU|durL|| _dS | | j| _dS 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)superr rL _url
isinstancer rK get_resource_typer3 representationjsonloadsr r%
media_typerepresentation_definition get_representation_definition)r5 rK url
resource_typerc rf representation_needs_processingrg __class__r r rL s2
zResource.__init__c C s | j S )z Return the URL to this resource.)r` r] r r r ri , s z Resource.urlc C sb | j du rdS | j jd}|dur|S | j jd}|dur/t| jj }t|d | S dS )z@Return the URL to the type definition for this resource, if any.Ntyper[ #)r3 r* r+ r rK
markup_url ensureSlashstr)r5 ri type_idbaser r r type_url1 s
zResource.type_urlc C s | j jd S )z Return the ID of this resource.r[ )r3 r* r] r r r r[ C z Resource.idr^ c C s t | j| j| j||||S )a Bind 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 rK ri r3 )r5 rc rf rk rg r r r bindH s
z
Resource.bindc C sD | dj}|D ]}| j}|jd|kr| S qtd| )z tag's 'type' attribute will contain the URL to the
that defines them.
rn r3 r* r+ r] r r r rO z Resource._get_definition_urlc C s> | j dur| j }| S |dur| |}| S td)a3 Get 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.)rc rg rV rh r )r5 rf rU r r r r s
z(Resource._find_representation_definitionc c s* | j}|tdD ]}|V q
dS )z+Iterate over this resource's tags.r N)rV r3 r4 r )r5 rU r r r r r * s
zResource._method_tag_iter)NNTN)r^ TN)NNNNrH )r r! r" r# rL propertyri ru r[ rw rh rz r r r r r r rQ rO r r
__classcell__r r rl r r s> 4
!
0
#r c @ sn e Zd ZdZdd Zedd Zedd Zedd Zed
d Z dd
dZ
dddZ dddZ d S )r z*A wrapper around an XML tag.
c C s || _ | j j| _|| _dS )zaInitialize with a tag.
:param method_tag: An ElementTree tag.
N)r/ rK r3 )r5 r/ r r r r rL 4 s
zMethod.__init__c C s t | | jtdS )z@Return the definition of a request that invokes the WADL method.request)RequestDefinitionr3 findr r] r r r r = s zMethod.requestc C s t | j| jtdS )z9Return the definition of the response to the WADL method.r{ )r r/ r3 r r r] r r r r{ B s zMethod.responsec C r )z)The XML ID of the WADL method definition.r[ r r] r r r r[ H z Method.idc C s | j jd S )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.
r< r3 r* r+ r r] r r r r< M s z Method.nameNc K s | j j|fi |S )4Return the request URL to use to invoke this method.)r build_url)r5 rC rE r r r build_request_urlV zMethod.build_request_urlc K s | j j||fi |S )zBuild a representation to be sent when invoking this method.
:return: A 2-tuple of (media_type, representation).
)r rc )r5 rf rC rE r r r build_representationZ s
zMethod.build_representationc C s d}|dur| j |}|du rdS |dur:t|dkr:| j }|du r%dS z
||j|d W n
ty9 Y dS w |du sDt|dkrFdS |durO||S | j jD ]}z||| j |d W dS tym Y qSw dS )a Returns 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)
r rh r? rG r r2 r representationsr7 r/ )r5 rf query_valuesrepresentation_valuesrc r r r r r c sH
zMethod.is_described_byrH NN)NNN)
r r! r" r# rL r r r{ r[ r< r r r r r r r r 1 s$
r c @ sN e Zd ZdZdd Zedd Zedd Zdd d
Zdd d Z dd
dZ
dS )r zBA wrapper around the description of the request invoking a method.c C s$ || _ | j j| _| 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/ rK r3 )r5 r request_tagr r r rL s
zRequestDefinition.__init__c C s | dgS )z,Return the query parameters for this method.queryr7 r] r r r r rv z RequestDefinition.query_paramsc c s. | j tdD ] }t| j| j|V q d S )Nrc )r3 r4 r r rK r/ )r5 rU r r r r s
z!RequestDefinition.representationsNc C s* | j D ]}|du s|j|kr| S qdS )z1Return the appropriate representation definition.N)r rf r5 rf rc r r r rh s
z/RequestDefinition.get_representation_definitionc K s0 | |}|du rtd| |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)rh TypeErrorrw )r5 rf rC rE rU r r r rc s
z RequestDefinition.representationc K sX | j | j|fi |}| jj}t|dkr*d|v r d}nd}||tt| 7 }|S )r r ?&)rG r r/ ri r? r
sorteditems)r5 rC rE rF ri appendr r r r s zRequestDefinition.build_urlrH r ) r r! r" r# rL r r r rh rc r r r r r r s
r c @ sB e Zd ZdZdddZdd Zdd Zd d
Zd d Zd
d Z dS )r z;A wrapper around the description of a response to a method.Nc C s |j | _ || _|| _|| _dS )zgInitialize with a tag.
:param response_tag: An ElementTree tag.
N)rK r/ r3 headers)r5 r/ response_tagr r r r rL s
zResponseDefinition.__init__c c s4 t d}| j|D ] }t| jj| j|V q dS )zGet an iterator over the representation definitions.
These are the representations returned in response to an
invocation of this method.
rc N)r r3 r4 r r/ rK )r5 pathr} r r r __iter__ s zResponseDefinition.__iter__c C s t | j| j|S )zBind the response to a set of HTTP headers.
A WADL response can have associated header parameters, but no
other kind.
)r r/ r3 )r5 r r r r rw s zResponseDefinition.bindc C sH | j tdD ]}|jd|kr!|jddkr!t| | S qdS )z,Find a header parameter within the response.r( r< r) headerN)r3 r4 r r* r+ r )r5 r r- r r r r s z ResponseDefinition.get_parameterc C s8 | j du r 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.r r )r r r) rY r+ r< )r5 r r r r r s
z&ResponseDefinition.get_parameter_valuec C s. | j du rdS | D ] }|j|kr| S q dS )z8Get one of the possible representations of the response.N)r3 rf r r r r rh s
z0ResponseDefinition.get_representation_definitionrH )
r r! r" r# rL r rw r r rh r r r r r s
r c sz e Zd ZdZ fddZ fddZdd Zedd Zd
d Z d d
Z
dddZ dd Z dd Z
dd Zdd Z ZS )r z2A definition of the structure of a representation.c s t t| | || _|| _d S rH )r_ r rL r/ r3 )r5 rK r/ r} rl r r rL s
z!RepresentationDefinition.__init__c s t t| ddg|S )Nr r )r_ r r7 r5 r/ rl r r r7 s
z RepresentationDefinition.paramsc C s dd | |D S )z#Return the names of all parameters.c S r8 r )r< )r, r( r r r r1 $ r; z.r r r r r r " r z(RepresentationDefinition.parameter_namesc C s | jjd S )z4The media type of the representation described here.ry )rV r3 r* r] r r r rf & s z#RepresentationDefinition.media_typec C s t ttjd }d| }ttj}d|| d }|du r!|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`.r z%%0%ddz===============z==Nr Tz^--z(--)?$ascii)flags.) r? reprsysmaxsizerandom randrangereescapeencodesearch MULTILINErr ) r5 all_parts_width_fmttokenboundarybcounterpatternr r r _make_boundary+ s z'RepresentationDefinition._make_boundaryc C sP |D ] \}}| |d | d | |d | d q| d dS )z$Write MIME headers to a file object.UTF-8s :
Nwriter )r5 bufr keyr9 r r r _write_headers= s
z'RepresentationDefinition._write_headersFc C s6 | d | |d |r| d | d dS )z,Write a multipart boundary to a file object.s --r r Nr )r5 r r closingr r r _write_boundaryF s
z(RepresentationDefinition._write_boundaryc
C s g }|D ]|\}}}t }|r d}dt|t|f }nd}dt| }| |dd|fd|fg |rFt|ts@tdt| || n3t|t sStd t| t
d
|} | d d D ]}
||
d
|d q_|| d d
|
| q| d|} t }dt| }| |dd|fg |D ]} | || || |d q| j|| dd || fS )aV Generate 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|\nNr r z"multipart/form-data; boundary="%s"T)r )ioBytesIOr r ra bytesr rn r r r r r r getvaluer r@ r )
r5 parts
encoded_parts is_binaryr< r9 r ctypecdisplinesliner encoded_partr r r _generate_multipart_formN sT
z1RepresentationDefinition._generate_multipart_formc K s | }|| j}| j||fi |}| j}|dkr'tt| }||fS |dkrWg }t } |D ]}
| |
j
| } | | urK| |
j dk|
j
| f q2|
|\}}||fS |dkrdt|}||fS td| )zzBind the definition to parameter values, creating a document.
:return: A 2-tuple (media_type, document).
z!application/x-www-form-urlencodedzmultipart/form-databinaryr^ z Unsupported media type: '%s')rV r7 r/ rG rf r
r r objectr+ r< r rn r rd dumpsr2 ) r5 rC rE rU r7 rF rf docr missingr( r9 r r r rw s2
z RepresentationDefinition.bindc C r )z9Turn a representation ID into a RepresentationDefinition.)rK representation_definitionsr+ rZ r r r rQ r z,RepresentationDefinition._definition_factoryc C r )a Find 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.
hrefr r] r r r rO r z,RepresentationDefinition._get_definition_url)F)r r! r" r# rL r7 r r rf r r r r rw rQ rO r r r rl r r s
Ar c @ s e Zd ZdZdd Zedd Zedd Zedd Zed
d Z ed d
Z
dd Z edd Z edd Z
edd ZdS )r z5One of the parameters of a representation definition.c C s |j | _ || _|| _dS )a Initialize 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)rK value_containerr3 )r5 r r3 r r r rL s
zParameter.__init__c C r )zThe name of this parameter.r< r r] r r r r< r zParameter.namec C r )z The style of this parameter.r) r r] r r r r) r zParameter.stylec C r )z The XSD type of this parameter.rn r r] r r r rn r zParameter.typec C r )a9 The 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.
fixedr r] r r r r= s zParameter.fixed_valuec C s | j jdd dv S )z6Whether or not a value for this parameter is required.requiredfalse)1truer r] r r r rA s zParameter.is_requiredc C s | 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 r r] r r r get_value s zParameter.get_valuec s fdd j tdD S )z7Return the set of acceptable values for this parameter.c s g | ]}t |qS r )Option)r,
option_tagr] r r r1 s z%Parameter.options..r: )r3 r4 r r] r r] r r> s
zParameter.optionsc C s& | j td}|du rdS t| |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)r3 r r r )r5 link_tagr r r r s
zParameter.linkc C s | j }|du r td|jS )a Follow 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.)r r2 follow)r5 r r r r linked_resource s
zParameter.linked_resourceN)r r! r" r# rL r r< r) rn r= rA r r> r r
r r r r r s(
r c @ s$ e Zd ZdZdd Zedd ZdS )r z0One of a set of possible values for a parameter.c C s || _ || _dS )z}Initialize the option.
:param parameter: A Parameter.
:param link_tag: An ElementTree