openstack/swift
Code Issues Proposed changes

Add a docstring for utils.Namespace

Browse Source 
The Related-Change extracted some attributes of the ShardRange class
into a new Namespace superclass. This patch adds a docstring for
Namespace.

Change-Id: I5a79c4a6da6e62698403bb0a5ef566355b5c850e
Related-Change: If98af569f99aa1ac79b9485ce9028fdd8d22576b
This commit is contained in:
Alistair Coles 2023-07-21 09:10:33 +01:00
parent bdbe8ce9f8
commit 46eeea11d4
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