Attention

You are looking at outdated documentation for version 2.x. A newer version is available.

wsgidav.lock_storage.LockStorageShelve.getLockList

LockStorageShelve.getLockList(path, includeRoot, includeChildren, tokenOnly)

Return a list of direct locks for <path>.

Expired locks are not returned (but may be purged).

path:

Normalized path (utf8 encoded string, no trailing ‘/’)

includeRoot:

False: don’t add <path> lock (only makes sense, when includeChildren is True).

includeChildren:

True: Also check all sub-paths for existing locks.

tokenOnly:

True: only a list of token is returned. This may be implemented more efficiently by some providers.

Returns:List of valid lock dictionaries (may be empty).