openstack
/
swift
Code Issues Proposed changes

Merge "Add a docstring for utils.Namespace"

This commit is contained in:
Zuul 2023-07-21 15:02:25 +00:00 committed by Gerrit Code Review
parent 427f575c4d 46eeea11d4
commit 1f007fd86b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
swift/common/utils/__init__.py
View File

@ -4403,7 +4403,16 @@ class NamespaceOuterBound(object):
@functools.total_ordering
class Namespace(object):
"""
A Namespace encapsulates parameters that define a range of the object
namespace.
:param name: the name of the ``Namespace``.
:param lower: the lower bound of object names contained in the namespace;
the lower bound *is not* included in the namespace.
:param upper: the upper bound of object names contained in the namespace;
the upper bound *is* included in the namespace.
"""
__slots__ = ('_lower', '_upper', 'name')
@functools.total_ordering