Bunch

(class from pyomo.common.collections.bunch)

class pyomo.common.collections.bunch.Bunch(*args, **kw)

Bases: dict

A class that can be used to store a bunch of data dynamically.

This class allows for unspecified attributes to have a default value of None. This borrows the output formatting ideas from the ActiveState Code Container (recipe 496697).

For historical reasons, attributes / keys are stored in the underlying dict unless they begin with an underscore, in which case they are stored as object attributes.

__init__(*args, **kw)

Methods

__init__(*args, **kw)
clear()	Remove all items from the dict.
copy()	Return a shallow copy of the dict.
fromkeys(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()	Return a set-like object providing a view on the dict's items.
keys()	Return a set-like object providing a view on the dict's keys.
pop(k[,d])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem()	Remove and return a (key, value) pair as a 2-tuple.
set_name(name)
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update(d)	The update is specialized for JSON-like data.
values()	Return an object providing a view on the dict's values.

Member Documentation

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

classmethod fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update(d)

The update is specialized for JSON-like data. This recursively replaces dictionaries with Bunch objects.

values()

Return an object providing a view on the dict’s values.