Libraries common throughout Cinder or just ones that haven’t been categorized very well yet.
RequestContext: context for requests that persist through all of cinder.
Bases: object
Security context and request information.
Represents the user taking a given action within the system.
Return a version of this context with admin flag set.
Cinder base exception handling.
Includes decorator for re-raising Cinder-type exceptions.
SHOULD include dedicated exception logging.
Bases: cinder.exception.NotAuthorized
Bases: cinder.exception.CinderException
Bases: exceptions.Exception
Base Cinder Exception
To correctly use this class, inherit from it and define a ‘message’ property. That message will get printf’d with the keyword arguments provided to the constructor.
Bases: cinder.exception.NotFound
Bases: cinder.exception.NotFound
Bases: webob.exc.WSGIHTTPException
Bases: cinder.exception.Error
Wraps an implementation specific exception.
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.Duplicate
Bases: exceptions.Exception
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.NotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.Invalid
Bases: cinder.exception.NotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.Duplicate
Bases: cinder.exception.CinderException
Bases: cinder.exception.Invalid
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.MigrationNotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.NotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.CinderException
Bases: cinder.exception.CinderException
Bases: cinder.exception.CinderException
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.NotFound
Bases: cinder.exception.NotAuthorized
Bases: exceptions.IOError
Bases: cinder.exception.QuotaNotFound
Bases: cinder.exception.QuotaNotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.QuotaNotFound
Bases: cinder.exception.QuotaNotFound
Bases: cinder.exception.QuotaNotFound
Bases: cinder.exception.NotFound
Bases: cinder.exception.Invalid
Bases: cinder.exception.NotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.SolidFireAPIException
Bases: cinder.exception.CinderException
Bases: cinder.exception.Invalid
Bases: cinder.exception.Invalid
Bases: cinder.exception.CinderException
Bases: cinder.exception.CinderException
Bases: cinder.exception.QuotaError
Bases: cinder.exception.NotFound
Bases: cinder.exception.NotFound
Bases: cinder.exception.VolumeNotFound
Bases: cinder.exception.QuotaError
Bases: cinder.exception.QuotaError
Bases: cinder.exception.CinderException
Bases: cinder.exception.Duplicate
Bases: cinder.exception.NotFound
Bases: cinder.exception.NotFound
Bases: cinder.exception.VolumeTypeNotFound
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.Invalid
Bases: cinder.exception.CinderException
Bases: cinder.exception.NotFound
Bases: cinder.exception.CinderException
Command-line flag library.
Emulates gflags by wrapping cfg.ConfigOpts.
The idea is to move fully to cfg eventually, and this wrapper is a stepping stone.
Bases: exceptions.Exception
Base classes for our unit tests.
Allows overriding of flags for use of fakes, and some black magic for inline callbacks.
Bases: unittest.TestCase
Test case base class for all unit tests.
Assert a list of dicts are equivalent.
Assert two dicts are equivalent.
This is a ‘deep’ match in the sense that it handles nested dictionaries appropriately.
NOTE:
If you don’t care (or don’t know) a given value, you can specify the string DONTCARE as the value. This will cause that dict-item to be skipped.
Python < v2.7 compatibility. Assert ‘a’ in ‘b’
Python < v2.7 compatibility. Assert ‘a’ NOT in ‘b’
Assert a sub_dict is subset of super_dict.
Override flag variables for a test.
Run before each test method to initialize test environment.
Runs after each test method to tear down test environment.
Bases: exceptions.Exception
Bases: object
Decorator that skips a test if condition is true.
Decorator that skips a test if running in fake mode.
Bases: object
Decorator that skips a test.
Bases: object
Decorator that skips a test if condition is not true.
Utilities and helper functions.
Bases: object
A pluggable backend loaded lazily based on some value.
Bases: object
Bases: exceptions.Exception
Exception to break out and stop a LoopingCall.
The poll-function passed to LoopingCall can raise this exception to break out of the loop normally. This is somewhat analogous to StopIteration.
An optional return-value can be included as the argument to the exception; this return-value will be returned by LoopingCall.wait()
Bases: xml.sax.expatreader.ExpatParser
An expat parser which disables DTD’s and entities by default.
Bases: object
Provides a mechanism to facilitate rolling back a series of actions when an exception is raised.
Rollback a series of actions then re-raise the exception.
Note
(sirp) This should only be called within an exception handler.
Convert a string representation of a bool into a bool value
Checks that obj is of type cls, and lets PyLint infer types.
Convert a value or list into a list of dicts
delete a file, but ignore file not found error
Create a directory (and any ancestor directories required)
Parameters: | path – Directory to create |
---|
Helper method to execute command with optional retry.
If you add a run_as_root=True command, don’t forget to add the corresponding filter to etc/cinder/rootwrap.d !
Parameters: |
|
---|---|
Raises: |
|
Returns: | a tuple, (stdout, stderr) from the spawned process, or None if the command fails. |
Open file
see built-in file() documentation for more details
Find a configuration file using the given hint.
Parameters: | config_path – Full or relative path to the config. |
---|---|
Returns: | Full path of the config, if it exists. |
Raises : | cinder.exception.ConfigNotFound |
Recursively flatten a nested dictionary.
Generate the URL to glance.
Generate an Ethernet MAC address.
Generate a random password from the supplied symbol groups.
At least one symbol from each group will be included. Unpredictable results if length is less than the number of symbol groups.
Believed to be reasonably secure (with a reasonable password length!)
Returns a list of items matching the specified path.
Takes an XPath-like expression e.g. prop1/prop2/prop3, and for each item in items, looks up items[prop1][prop2][prop3]. Like XPath, if any of the intermediate results are lists it will treat each list item individually. A ‘None’ in items or any child expressions will be ignored, this function will not throw because of None (anywhere) in items. The returned list will contain no None values.
Generate a hash for the contents of a file.
For our purposes, a UUID is a string in canonical form:
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
Check if the provided string is a valid bool string or not.
valid the address strictly as per format xxx.xxx.xxx.xxx. where xxx is a value between 0 and 255.
This method gives you the most recently completed audit period.
Catches exception, write message to the log, re-raise. This is a common refinement of save_and_reraise that writes a specific message to the log.
Return a path to a particular device.
>>> make_dev_path('xvdc')
/dev/xvdc
>>> make_dev_path('xvdc', 1)
/dev/xvdc1
Return a dict in which the dictionaries keys are mapped to new keys.
If the Flags.monkey_patch set as True, this function patches a decorator for all functions in specified modules. You can set decorators for each modules using FLAGS.monkey_patch_modules. The format is “Module path:Decorator function”. Example: ‘cinder.api.ec2.cloud:’ cinder.openstack.common.notifier.api.notify_decorator’
Parameters of the decorator is as follows. (See cinder.openstack.common.notifier.api.notify_decorator)
name - name of the function function - object of the function
Return two dicts, one with keys the other with everything else.
Read from a file if it has been modified.
Parameters: |
|
---|---|
Returns: | data from file |
Secure helper to read file as root.
Protect code that wants to operate on PATH atomically. Any exception will cause PATH to be removed.
Parse an XML string using minidom safely.
Return a hostname which conforms to RFC-952 and RFC-1123 specs.
Check whether a service is up based on last heartbeat.
Constant-time string comparison.
Params s1: | the first string |
---|---|
Params s2: | the second string |
Returns: | True if the strings are equal. |
This function takes two strings and compares them. It is intended to be used when doing a comparison for authentication purposes to help guard against timing attacks.
Return a dict that only contains a subset of keys.
Temporarily chown a path.
Params owner_uid: | |
---|---|
UID of temporary owner (defaults to current user) |
Temporarily set the attr on a particular object to a given value then revert when finished.
One use of this is to temporarily set the read_deleted flag on a context object:
- with temporary_mutation(context, read_deleted=”yes”):
- do_something_that_needed_deleted_objects()
Decorator that logs how long a particular function took to execute
Local total_seconds implementation for compatibility with python 2.6
A wrapper around execute() to more easily handle warnings and errors.
Returns an (out, err) tuple of strings containing the output of the command’s stdout and stderr. If ‘err’ is not empty then the command can be considered to have failed.
Try to turn a string into utf-8 if possible.
Code is directly from the utf8 function in http://github.com/facebook/tornado/blob/master/tornado/escape.py
Walk class hierarchy, yielding most derived classes first
Escapes a string so it is valid within XML or XHTML.
Utility methods for working with WSGI servers.
Bases: object
Base WSGI application wrapper. Subclasses need to implement __call__.
Used for paste app factories in paste.deploy config files.
Any local configuration (that is, values under the [app:APPNAME] section of the paste config) will be passed into the __init__ method as kwargs.
A hypothetical configuration would look like:
[app:wadl] latest_version = 1.3 paste.app_factory = cinder.api.fancy_api:Wadl.factory
which would result in a call to the Wadl class as
import cinder.api.fancy_api fancy_api.Wadl(latest_version=‘1.3’)
You could of course re-implement the factory method in subclasses, but using the kwarg passing it shouldn’t be necessary.
Bases: cinder.wsgi.Middleware
Helper class for debugging a WSGI application.
Can be inserted into any WSGI application chain to get information about the request and response.
Iterator that prints the contents of a wrapper string.
Bases: object
Used to load WSGI applications from paste configurations.
Return the paste URLMap wrapped WSGI application.
Parameters: | name – Name of the application to load. |
---|---|
Returns: | Paste URLMap object wrapping the requested application. |
Raises : | cinder.exception.PasteAppNotFound |
Bases: cinder.wsgi.Application
Base WSGI middleware.
These classes require an application to be initialized that will be called next. By default the middleware will simply call its wrapped app, or you can override __call__ to customize its behavior.
Used for paste app factories in paste.deploy config files.
Any local configuration (that is, values under the [filter:APPNAME] section of the paste config) will be passed into the __init__ method as kwargs.
A hypothetical configuration would look like:
[filter:analytics] redis_host = 127.0.0.1 paste.filter_factory = cinder.api.analytics:Analytics.factory
which would result in a call to the Analytics class as
import cinder.api.analytics analytics.Analytics(app_from_paste, redis_host=‘127.0.0.1’)
You could of course re-implement the factory method in subclasses, but using the kwarg passing it shouldn’t be necessary.
Called on each request.
If this returns None, the next application down the stack will be executed. If it returns a response then that response will be returned and execution will stop here.
Do whatever you’d like to the response.
Bases: webob.request.Request
Bases: object
WSGI middleware that maps incoming requests to WSGI apps.
Bases: object
Server class to manage a WSGI server, serving a WSGI application.
Start serving a WSGI application.
Parameters: | backlog – Maximum number of queued connections. |
---|---|
Returns: | None |
Raises : | cinder.exception.InvalidInput |
Stop this server.
This is not a very nice action, as currently the method by which a server is stopped is by killing its eventlet.
Returns: | None |
---|
Block, until the server has stopped.
Waits on the server’s eventlet to finish, then returns.
Returns: | None |
---|