openstack/neutron-lib
Code Issues Proposed changes

Merge "Add docstrings for db.utils"

Browse Source
This commit is contained in:
Jenkins 2016-08-23 20:33:23 +00:00 committed by Gerrit Code Review
commit 68553d8415
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
neutron_lib/db/utils.py
View File

@ -24,8 +24,11 @@ from sqlalchemy.orm import exc
def get_and_validate_sort_keys(sorts, model): def get_and_validate_sort_keys(sorts, model):
"""Extract sort keys from sorts and ensure they are valid for the model. """Extract sort keys from sorts and ensure they are valid for the model.
:param sorts: list of (key, direction) tuples :param sorts: A list of (key, direction) tuples.
:param model: sqlalchemy ORM model class :param model: A sqlalchemy ORM model class.
:returns: A list of the extracted sort keys.
:raises BadRequest: If a sort key attribute references another resource
and cannot be used in the sort.
""" """
sort_keys = [s[0] for s in sorts] sort_keys = [s[0] for s in sorts]
@ -50,8 +53,9 @@ def get_and_validate_sort_keys(sorts, model):
def get_sort_dirs(sorts, page_reverse=False): def get_sort_dirs(sorts, page_reverse=False):
"""Extract sort directions from sorts, possibly reversed. """Extract sort directions from sorts, possibly reversed.
:param sorts: list of (key, direction) tuples :param sorts: A list of (key, direction) tuples.
:param page_reverse: True if sort direction is reversed :param page_reverse: True if sort direction is reversed.
:returns: The list of extracted sort directions optionally reversed.
""" """
if page_reverse: if page_reverse:
return ['desc' if s[1] else 'asc' for s in sorts] return ['desc' if s[1] else 'asc' for s in sorts]
@ -70,7 +74,7 @@ def is_retriable(exception):
"""Determine if the said exception is retriable. """Determine if the said exception is retriable.
:param exception: The exception to check. :param exception: The exception to check.
:return: True if 'exception' is retriable, otherwise False. :returns: True if 'exception' is retriable, otherwise False.
""" """
if _is_nested_instance(exception, if _is_nested_instance(exception,
(db_exc.DBDeadlock, exc.StaleDataError, (db_exc.DBDeadlock, exc.StaleDataError,
@ -86,8 +90,9 @@ def reraise_as_retryrequest(function):
"""Wrap the said function with a RetryRequest upon error. """Wrap the said function with a RetryRequest upon error.
:param function: The function to wrap/decorate. :param function: The function to wrap/decorate.
:return: The 'function' wrapped in a try block that will reraise any :returns: The 'function' wrapped in a try block that will reraise any
Exception's as a RetryRequest. Exception's as a RetryRequest.
:raises RetryRequest: If the wrapped function raises retriable exception.
""" """
@six.wraps(function) @six.wraps(function)
def _wrapped(*args, **kwargs): def _wrapped(*args, **kwargs):