openstack/swift
Code Issues Proposed changes

Merge "Fixed inconsistencies in docstrings"

Browse Source
This commit is contained in:
Jenkins 2016-07-11 21:23:29 +00:00 committed by Gerrit Code Review
commit 1ba56c64e9
5 changed files with 24 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
swift/common/constraints.py
View File

@ -180,12 +180,12 @@ def check_object_creation(req, object_name):
:param req: HTTP request object
:param object_name: name of object to be created
:returns HTTPRequestEntityTooLarge: the object is too large
:returns HTTPLengthRequired: missing content-length header and not
:returns: HTTPRequestEntityTooLarge -- the object is too large
:returns: HTTPLengthRequired -- missing content-length header and not
a chunked request
:returns HTTPBadRequest: missing or bad content-type header, or
:returns: HTTPBadRequest -- missing or bad content-type header, or
bad metadata
:returns HTTPNotImplemented: unsupported transfer-encoding header value
:returns: HTTPNotImplemented -- unsupported transfer-encoding header value
"""
try:
ml = req.message_length()

15
swift/common/internal_client.py
View File

@ -153,8 +153,7 @@ class InternalClient(object):
def make_request(
self, method, path, headers, acceptable_statuses, body_file=None):
"""
Makes a request to Swift with retries.
"""Makes a request to Swift with retries.
:param method: HTTP method of request.
:param path: Path of request.
@ -367,8 +366,7 @@ class InternalClient(object):
def get_account_metadata(
self, account, metadata_prefix='', acceptable_statuses=(2,)):
"""
Gets account metadata.
"""Gets account metadata.
:param account: Account on which to get the metadata.
:param metadata_prefix: Used to filter values from the headers
@ -418,8 +416,7 @@ class InternalClient(object):
# container methods
def container_exists(self, account, container):
"""
Checks to see if a container exists.
"""Checks to see if a container exists.
:param account: The container's account.
:param container: Container to check.
@ -479,8 +476,7 @@ class InternalClient(object):
def get_container_metadata(
self, account, container, metadata_prefix='',
acceptable_statuses=(2,)):
"""
Gets container metadata.
"""Gets container metadata.
:param account: The container's account.
:param container: Container to get metadata on.
@ -580,8 +576,7 @@ class InternalClient(object):
def get_object_metadata(
self, account, container, obj, metadata_prefix='',
acceptable_statuses=(2,), headers=None):
"""
Gets object metadata.
"""Gets object metadata.
:param account: The object's account.
:param container: The object's container.

3
swift/common/utils.py
View File

@ -1874,8 +1874,7 @@ def capture_stdio(logger, **kwargs):
def parse_options(parser=None, once=False, test_args=None):
"""
Parse standard swift server/daemon options with optparse.OptionParser.
"""Parse standard swift server/daemon options with optparse.OptionParser.
:param parser: OptionParser to use. If not sent one will be created.
:param once: Boolean indicating the "once" option is available