openstack/deb-python-openstacksdk
Code Issues Proposed changes

move examples to code use preference docs

Browse Source 
Change-Id: I5a7e52940a005a7c28fdcd30e3ada884f235b6d2
This commit is contained in:
Terry Howe
2014-11-01 08:47:58 -06:00
parent 94e83e34a3
commit 0a4946d645
2 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/source/user_preference.rst
View File

@@ -7,35 +7,3 @@ UserPreference Object
.. autoclass:: openstack.user_preference.UserPreference
:members:
Examples
--------
The :class:`~openstack.user_preference.UserPreference` class is constructed
with no arguments.
Set Methods
~~~~~~~~~~~
The user preferences are set based on the service type. Service type would
normally be something like 'compute', 'identity', 'object-store', etc.::
from openstack import user_preference
pref = user_preference.UserPreference()
pref.set_name('compute', 'matrix')
pref.set_region(pref.ALL, 'zion')
pref.set_version('identity', 'v3')
pref.set_visibility('object-store', 'internal')
for service in pref.get_services():
print str(pref.get_preference(service.service_type))
The resulting preference print out would look something like::
service_type=compute,region=zion,service_name=matrix
service_type=network,region=zion
service_type=database,region=zion
service_type=image,region=zion
service_type=metering,region=zion
service_type=orchestration,region=zion
service_type=object-store,visibility=internal,region=zion
service_type=identity,region=zion,version=v3

32
openstack/user_preference.py
View File

@@ -17,6 +17,38 @@ are currently supported are service name, region, version and visibility.
The :class:`~openstack.user_preference.UserPreference` and the
:class:`~openstack.connection.Connection` classes are the most important
user facing classes.
Examples
--------
The :class:`~openstack.user_preference.UserPreference` class is constructed
with no arguments.
Set Methods
~~~~~~~~~~~
The user preferences are set based on the service type. Service type would
normally be something like 'compute', 'identity', 'object-store', etc.::
from openstack import user_preference
pref = user_preference.UserPreference()
pref.set_name('compute', 'matrix')
pref.set_region(pref.ALL, 'zion')
pref.set_version('identity', 'v3')
pref.set_visibility('object-store', 'internal')
for service in pref.get_services():
print str(pref.get_preference(service.service_type))
The resulting preference print out would look something like::
service_type=compute,region=zion,service_name=matrix
service_type=network,region=zion
service_type=database,region=zion
service_type=image,region=zion
service_type=metering,region=zion
service_type=orchestration,region=zion
service_type=object-store,visibility=internal,region=zion
service_type=identity,region=zion,version=v3
"""
import six