viscid.bucket module

class viscid.bucket.Bucket(ordered=False)

Bases: object

This is basically a glorified dict

It’s a convenient dict-like object if you want lots of keys for a given value.

Note

You can add non-hashable items, but this is poorly tested. When adding / removing non-hashable items (items, not handles) the comparison is done using the object’s id. This is fundamentally different than using an object’s __hash__, but it should be fairly transparent.

contains_handle(handle)

contains_item(item)

get_primary_handles()

Return a list of the first handles for all items

handle_string(prefix='')

return string representation of handles and items

items()

items_as_list()

keys()

print_tree(prefix='')

remove_all_items()

unload all items

remove_item(item)

remove_item_by_handle(handle)

remove item by handle, raises KeyError if handle is not found

remove_reference(item, _ref_count=1)

set_item(handles, item, index_handle=True, _add_ref=False)

if index_handle is true then the index of item will be included as a handle making the bucket indexable like a list

values()