/usr/lib/python2.6/site-packages/openstack
Edit: /usr/lib/python2.6/site-packages/openstack/resource.pyc (38240B)
Ñò
5
Wc @ s d Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k l Z d d k
l Z d d k
l Z d d k
l
Z
d e f d „ ƒ YZ d Z d
e f d „ ƒ YZ e i e i ƒ d e i f d
„ ƒ Yƒ Z d „ Z d „ Z d S( så
The :class:`~openstack.resource.Resource` class is a base
class that represent a remote resource. Attributes of the resource
are defined by the responses from the server rather than in code so
that we don't have to try and keep up with all possible attributes
and extensions. This may be changed in the future.
The :class:`~openstack.resource.prop` class is a helper for
definiting properties in a resource.
For update management, :class:`~openstack.resource.Resource`
maintains a dirty list so when updating an object only the attributes
that have actually been changed are sent to the server.
There is also some support here for lazy loading that needs improvement.
There are plenty of examples of use of this class in the SDK code.
iÿÿÿÿN( t parse( t
exceptions( t format( t utilst propc B s; e Z d Z d d d d „ Z d „ Z d „ Z d „ Z RS( så A helper for defining properties in a resource.
A prop defines some known attributes within a resource's values.
For example we know a User resource will have a name:
>>> class User(Resource):
... name = prop('name')
...
>>> u = User()
>>> u.name = 'John Doe'
>>> print u['name']
John Doe
User objects can now be accessed via the User().name attribute. The 'name'
value we pass as an attribute is the name of the attribute in the message.
This means that you don't need to use the same name for your attribute as
will be set within the object. For example:
>>> class User(Resource):
... name = prop('userName')
...
>>> u = User()
>>> u.name = 'John Doe'
>>> print u['userName']
John Doe
There is limited validation ability in props.
You can validate the type of values that are set:
>>> class User(Resource):
... name = prop('userName')
... age = prop('age', type=int)
...
>>> u = User()
>>> u.age = 'thirty'
TypeError: Invalid type for attr age
By specifying an alias attribute name, that alias will be read when the
primary attribute name does not appear within the resource:
>>> class User(Resource):
... name = prop('address', alias='location')
...
>>> u = User(location='Far Away')
>>> print u['address']
Far Away
c C s( | | _ | | _ | | _ | | _ d S( N( t namet typet aliast default( t selfR R R R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __init__a s c C s6 | d j o d Sy# | | i } | d j o d SWnD t j
o8 y | | i } Wq| t t f j
o | i SXn X| i o¬ t | | i ƒ o˜ t | i t ƒ oF t | t
i ƒ o | i h | | i i 6ƒ } q.| i | ƒ } q2t | i t
i ƒ o | i i | ƒ } q2| i | ƒ } n | S( N( t NoneR t KeyErrorR t AttributeErrorR R t
isinstancet
issubclasst Resourcet sixt string_typest id_attributeR t Formattert deserialize( R t instancet ownert value( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __get__g s(
c C s | i o t | | i ƒ o® | | i j ož t | i t ƒ oF t | t i ƒ o | i h | | i i 6ƒ } qÈ | i | ƒ } qÌ t | i t i ƒ o | i i
| ƒ } qÌ t | i | ƒ ƒ } n | i | i
j o | i
i | i ƒ n | | | i
>> class Container(Resource):
... name = prop("name")
... object_count = header("x-container-object-count")
...
>>> c = Container({name='pix'})
>>> c.head(session)
>>> print c["headers"]["x-container-object-count"]
4
>>> print c.object_count
4
The first print shows accessing the header value without the property
and the second print shows accessing the header with the property helper.
c C s, | d j o d St | j o | t Sd S( N( R t HEADERS( R R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt _get_headers½ s
c C s( | i | ƒ } t t | ƒ i | | ƒ S( N( R& t superR$ R ( R R R R# ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR Ä s c C sO | i | ƒ } | d j o h } | i t e d/ e d/ d- „ ƒ Z? e d/ e@ d. „ ƒ ZA RS(0 t idR t locationt c C si | d j o h n
| i ƒ | _ | o
t ƒ n t | i i ƒ ƒ | _ | i | i ƒ | | _ d S( s Construct a Resource to interact with a service's REST API.
The Resource class offers two class methods to construct
resource objects, which are preferrable to entering through
this initializer. See :meth:`Resource.new` and
:meth:`Resource.existing`.
:param dict attrs: The attributes to set when constructing
this Resource.
:param bool loaded: ``True`` if this Resource exists on
the server, ``False`` if it does not.
N( R t copyR t sett keyst _dirtyt update_attrst _loaded( R t attrst loaded( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR
ö s
#)c C s# d | i | i i | i | i f S( Ns %s.%s(attrs=%s, loaded=%s)( R! t __class__R R R1 ( R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __repr__ s c C s1 | i o | i S| i o | i S| ƒ i i S( N( t
resource_namet resource_keyR4 R ( t cls( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt get_resource_name
s
c K s | | d t ƒS( s Create a new instance of this resource.
Internally set flags such that it is marked as not present on the
server.
:param dict kwargs: Each of the named arguments will be set as
attributes on the resulting Resource object.
R3 ( t False( R8 t kwargs( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt new s
c K s | | d t ƒS( s Create an instance of an existing remote resource.
It is marked as an exact replication of a resource present on a server.
:param dict kwargs: Each of the named arguments will be set as
attributes on the resulting Resource object.
R3 ( t True( R8 R; ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt existing% s c C sZ t | | ƒ o | St | t i ƒ o | i h | | 6 St d | i | f ƒ ‚ d S( Ns value must be %s instance or %s( R R R R< t
ValueErrorR ( R8 t attributeR ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt
_from_attr0 s c C s | i | i | ƒ S( sš Create an instance from an ID or return an existing instance.
New instances are created with :meth:`~openstack.resource.Resource.new`
:param value: If ``value`` is an instance of this Resource type,
it is returned.
If ``value`` is an ID which an instance of this
Resource type can be created with, one is created
and returned.
:rtype: :class:`~openstack.resource.Resource` or the
appropriate subclass.
:raises: :exc:`ValueError` if ``value`` is not an instance of
this Resource type or a valid ``id``.
( RA R ( R8 R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt from_id= s c C s | i | i | ƒ S( s Create an instance from a name or return an existing instance.
New instances are created with :meth:`~openstack.resource.Resource.new`
:param value: If ``value`` is an instance of this Resource type,
it is returned.
If ``value`` is a name which an instance of this
Resource type can be created with, one is created
and returned.
:rtype: :class:`~openstack.resource.Resource` or the
appropriate subclass.
:raises: :exc:`ValueError` if ``value`` is not an instance of
this Resource type or a valid ``name``.
( RA t name_attribute( R8 R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt from_nameP s c C s | i | S( N( R ( R R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __getitem__g s c C se y | i | } Wn t j
o
t } n X| | j } | o! | | i | <| i i | ƒ n d S( N( R R R= R/ t add( R R R t origt changed( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __setitem__j s
c C s | i | =| i i | ƒ d S( N( R R/ RF ( R R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __delitem__v s
c C s
t | i ƒ S( N( t lenR ( R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __len__z s c C s
t | i ƒ S( N( t iterR ( R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt __iter__} s c C s | i i | i d ƒ S( s‘ The identifier associated with this resource.
The true value of the ``id`` property comes from the
attribute set as :data:`id_attribute`. For example,
a container's name may be the appropirate identifier,
so ``id_attribute = "name"`` would be set on the
:class:`Resource`, and ``Resource.name`` would be
conveniently accessible through ``id``.
N( R t getR R ( R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR) „ s c C s | i | i =d S( N( R R ( R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR) ‘ s c C s | i i | i d ƒ S( s¡ The name associated with this resource.
The true value of the ``name`` property comes from the
attribute set as :data:`name_attribute`.
N( R RO RC R ( R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR • s c C s | | i | i ( R8 Rv Rk Rj RT Rw ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt get_by_idr s c C sD | i | | i d | d | d | ƒ} | i | | ƒ t | _ | S( s¹ Get the remote resource associated with this instance.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param bool include_headers: ``True`` if header data should be
included in the response body,
``False`` if not.
:param dict args: A dictionary of query parameters to be appended to
the compound URL.
:return: This :class:`Resource` instance.
:raises: :exc:`~openstack.exceptions.MethodNotSupported` if
:data:`Resource.allow_retrieve` is not set to ``True``.
Rj R^ RT ( R€ R) RV R= R1 ( R Rv RT R^ Rw ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyRO ‹ s
c C sk | i p t i | d ƒ ‚ n | i | | ƒ } h d d 6} | i | d | i d | ƒ} h | i t 6S( s³ Get a dictionary representing the headers of a remote resource.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param resource_id: This resource's identifier, if needed by
the request.
:param dict path_args: A dictionary of arguments to construct
a compound URL.
See `How path_args are used`_ for details.
:return: A ``dict`` containing the headers.
:raises: :exc:`~openstack.exceptions.MethodNotSupported` if
:data:`Resource.allow_head` is not set to ``True``.
t headR+ t AcceptRp R# ( t
allow_headR Rr Rm R‚ Rt R# R% ( R8 Rv Rk Rj Rl R# RS ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt head_data_by_idŸ s
c C s% | i | | d | ƒ} | i | S( s» Get an object representing the headers of a remote resource.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param resource_id: This resource's identifier, if needed by
the request.
:param dict path_args: A dictionary of arguments to construct
a compound URL.
See `How path_args are used`_ for details.
:return: A :class:`Resource` representing the headers.
:raises: :exc:`~openstack.exceptions.MethodNotSupported` if
:data:`Resource.allow_head` is not set to ``True``.
Rj ( R… R> ( R8 Rv Rk Rj t data( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt
head_by_id¹ s c C s8 | i | | i d | ƒ} | i i | ƒ t | _ | S( sƒ Get the remote resource headers associated with this instance.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:return: This :class:`Resource` instance.
:raises: :exc:`~openstack.exceptions.MethodNotSupported` if
:data:`Resource.allow_head` is not set to ``True``.
Rj ( R… R) R RR R= R1 ( R Rv R† ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR‚ Ì s
c C sa | i p t i | d ƒ ‚ n | i | ƒ } | o | i | j o | | i =n | i t d ƒ } | i o h | | i 6} n | } | i | | ƒ } h | d 6} | o | | t s Rj RT ( RP RZ R/ R‹ R) R R R t AssertionErrorRV R= RQ ( R Rv t dirty_attrsRS t resp_id( ( R s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyRR
s
c C s_ | i p t i | d ƒ ‚ n | i | | ƒ } h d d 6} | i | d | i d | ƒd S( s‡ Delete a remote resource with the given id.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param resource_id: This resource's identifier, if needed by
the request.
:param dict path_args: A dictionary of arguments to construct
a compound URL.
See `How path_args are used`_ for details.
:return: ``None``
:raises: :exc:`~openstack.exceptions.MethodNotSupported` if
:data:`Resource.allow_delete` is not set to ``True``.
t deleteR+ Rƒ Rp R# N( t allow_deleteR Rr Rm R‘ Rt ( R8 Rv Rk Rj Rl R# ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt delete_by_id' s
c C s | i | | i d | ƒd S( sh Delete the remote resource associated with this instance.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:return: ``None``
:raises: :exc:`~openstack.exceptions.MethodNotSupported` if
:data:`Resource.allow_update` is not set to ``True``.
Rj N( R“ R) ( R Rv ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR‘ > s
c
c sR | i p t i | d ƒ ‚ n t } | d j o h n | } | i | ƒ } h d d 6} xï | oç | i | d | i d | d | ƒ} | i ƒ } | i o | | i } n | p
t
} n d } d }
x5 | D]- } | i | } | i }
| d 7} | VqÕ W| p d Sd
| j o | | d
j o d S| | d
<|
| d R) (
R8 Rv Rj t paginatedR• t more_dataRl R# RS t yieldedt
new_markerR† R ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR” J s:
c s» ‡ ‡ f d † } y% ˆ i o ˆ i | ˆ d | ƒSWn t i j
o n Xˆ i | d | ƒ} | | ˆ i ˆ i ƒ } | d j o | S| o d St i d ˆ i ˆ f ƒ ‚ d S( s½ Find a resource by its name or id.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param name_or_id: This resource's identifier, if needed by
the request. The default is ``None``.
:param dict path_args: A dictionary of arguments to construct
a compound URL.
See `How path_args are used`_ for details.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:return: The :class:`Resource` object matching the given name or id
or None if nothing matches.
:raises: :class:`openstack.exceptions.DuplicateResource` if more
than one resource is found for this request.
:raises: :class:`openstack.exceptions.ResourceNotFound` if nothing
is found and ignore_missing is ``False``.
c sÜ d } xÏ | D]Ç } ˆ i | } d \ } } | d j o t | | d ƒ } n | d j o t | | d ƒ } n | ˆ j p
| ˆ j oF | d j o
| } qÔ d } | ˆ i ƒ ˆ f } t i | ƒ ‚ q
q
W| S( Ns+ More than one %s exists with the name '%s'.( NN( R R> t getattrR9 R t DuplicateResource( t resultst the_idt the_namet
the_resultt itemt maybe_resultt id_valuet
name_valuet msg( t
name_or_idR8 ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt
get_one_match¡ s
Rj s No %s found for %sN(
R{ R R t NotFoundExceptionR” R RC R t ResourceNotFoundR ( R8 Rv R© Rj t ignore_missingRª R† t result( ( R© R8 s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt findˆ s
N(B R R! R R7 R6 R™ R RC R$ R* Rh Rt R: Rq R{ Rˆ R’ R˜ R„ R‰ R
R5 t classmethodR9 R< R> RA RB RD RE RI RJ RL RN t propertyR) t deleterR t setterRP RQ RV R0 R` R( Rc t staticmethodRd Rf Rg Rm Rx Rn R€ R RO R… R‡ R‚ R‹ RR R“ R‘ R” R= R¯ ( ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyR Ð sŒ
, % 1 =c C sß | i | j o | Sd } | d j o
g } n x„ | | j ov | i | ƒ | i | j o | S| i | j o) d | i | i f } t i | ƒ ‚ n t i | ƒ | | 7} q5 Wd | i | f } t i | ƒ ‚ d S( s' Wait for the resource to be in a particular status.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param resource: The resource to wait on to reach the status. The resource
must have a status attribute.
:type resource: :class:`~openstack.resource.Resource`
:param status: Desired status of the resource.
:param list failures: Statuses that would indicate the transition
failed such as 'ERROR'.
:param interval: Number of seconds to wait between checks.
:param wait: Maximum number of seconds to wait for transition.
:return: Method returns self on success.
:raises: :class:`~openstack.exceptions.ResourceTimeout` transition
to status failed to occur in wait seconds.
:raises: :class:`~openstack.exceptions.ResourceFailure` resource
transitioned to one of the failure states.
:raises: :class:`~AttributeError` if the resource does not have a status
attribute
i s, Resource %s transitioned to failure state %ss* Timeout waiting for %s to transition to %sN( t statusR RO R) R t ResourceFailuret timet sleept ResourceTimeout( Rv t resourceRµ t failurest intervalt waitt total_sleepR¨ ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt wait_for_statusË s$
c C s} d } xT | | j oF y | i | ƒ Wn t i j
o | SXt i | ƒ | | 7} q Wd | i } t i | ƒ ‚ d S( sF Wait for the resource to be deleted.
:param session: The session to use for making this request.
:type session: :class:`~openstack.session.Session`
:param resource: The resource to wait on to be deleted.
:type resource: :class:`~openstack.resource.Resource`
:param interval: Number of seconds to wait between checks.
:param wait: Maximum number of seconds to wait for the delete.
:return: Method returns self on success.
:raises: :class:`~openstack.exceptions.ResourceTimeout` transition
to status failed to occur in wait seconds.
i s Timeout waiting for %s deleteN( RO R R« R· R¸ R) R¹ ( Rv Rº R¼ R½ R¾ R¨ ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt wait_for_deleteö s
( R" t abct collectionsR, RX R· R t six.moves.urllibR R} t openstackR R R t objectR R% R$ t
add_metaclasst ABCMetat MutableMappingR R¿ RÀ ( ( ( s8 /tmp/pip-build-wCUybK/openstacksdk/openstack/resource.pyt s& u*ÿ ÿ ü +