List-like Object Storage

class pyomo.core.kernel.list_container.ListContainer(*args)[source]

Bases: TupleContainer, MutableSequence

A partial implementation of the IHomogeneousContainer interface that provides list-like storage functionality.

Complete implementations need to set the _ctype property at the class level and initialize the remaining ICategorizedObject attributes during object creation. If using __slots__, a slot named “_data” must be included.

Note that this implementation allows nested storage of other ICategorizedObjectContainer implementations that are defined with the same ctype.

__eq__(other): Return self==value.

__hash__ = None

__init__(*args)[source]

__ne__(other): Return self!=value.

__str__(): Convert this object to a string by first attempting to generate its fully qualified name. If the object does not have a name (because it does not have a parent, then a string containing the class name is returned.

classmethod __subclasshook__(C)

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

activate(shallow=True): Activate this container.

property active: The active status of this object.

append(value): S.append(value) – append value to the end of the sequence

child(key)

Get the child object associated with a given storage key for this container.

Raises:	KeyError – if the argument is not a storage key for any children of this container

children(): A generator over the children of this container.

clear() → None -- remove all items from S

clone()

Returns a copy of this object with the parent pointer set to None.

A clone is almost equivalent to deepcopy except that any categorized objects encountered that are not descendents of this object will reference the same object on the clone.

components(active=True)

Generates an efficient traversal of all components stored under this container. Components are categorized objects that are either (1) not containers, or (2) are heterogeneous containers.

Parameters:	active (`True`/`None`) – Controls whether or not to filter the iteration to include only the active part of the storage tree. The default is `True`. Setting this keyword to `None` causes the active status of objects to be ignored.
Returns:	iterator of components in the storage tree

count(value) → integer -- return number of occurrences of value

property ctype: The object’s category type.

deactivate(shallow=True): Deactivate this container.

extend(values): S.extend(iterable) – extend sequence by appending elements from the iterable

getname(fully_qualified=False, name_buffer={}, convert=<class 'str'>, relative_to=None)

Dynamically generates a name for this object.

Parameters:	fully_qualified (bool) – Generate a full name by iterating through all anscestor containers. Default is `False`. convert (function) – A function that converts a storage key into a string representation. Default is the built-in function str. relative_to (object) – When generating a fully qualified name, generate the name relative to this block.
Returns:	If a parent exists, this method returns a string representing the name of the object in the context of its parent; otherwise (if no parent exists), this method returns `None`.

index(value[, start[, stop]]) → integer -- return first index of value.: Raises ValueError if the value is not present.

insert(i, item)[source]: S.insert(index, object) – insert object before index

property local_name: The object’s local name within the context of its parent. Alias for obj.getname(fully_qualified=False).

property name: The object’s fully qualified name. Alias for obj.getname(fully_qualified=True).

property parent: The object’s parent (possibly None).

pop([index]) → item -- remove and return item at index (default last).: Raise IndexError if list is empty or index is out of range.

remove(value): S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()[source]: S.reverse() – reverse IN PLACE

property storage_key: The object’s storage key within its parent