Function bindCompoundData

src/IECorePython/CompoundDataBinding.cpp:498–541

};

void bindCompoundData()
{
	RunTimeTypedClass<CompoundDataBase>();

	RunTimeTypedClass<CompoundData>(
		"This class behaves like the native python dict, except that it only accepts objects derived from Data class.\n"
		"The copy constructor accepts another instance of this class or a python dict containing Data objects\n"
		"it has the most important dict methods: has_key, items, keys, values, get, pop, etc.\n"
		)
		.def( init<>() )
		.def( "__init__", make_constructor( &CompoundDataFunctions::dataMapConstructor ), "Copy constructor: accepts a python dict containing Data objects." )
		.def( "__getitem__", &CompoundDataFunctions::getItem, "indexing operator.\nAccepts only string keys." )
		.def( "__setitem__", &CompoundDataFunctions::setItem, "index assignment operator.\nWorks exactly like on python dicts but only accepts Data objects as the new value." )
		.def( "__delitem__", &CompoundDataFunctions::delItem, "index deletion operator.\nWorks exactly like on python dicts." )
		.def( "__len__", &CompoundDataFunctions::len, "Length operator." )
		.def( "__contains__", &CompoundDataFunctions::has_key, "In operator.\nWorks exactly like on python dicts." )
		.def( "size", &CompoundDataFunctions::len, "m.size()\nReturns the number of elements on m. Same result as the len operator." )
		.def( "__cmp__", &CompoundDataFunctions::invalidOperator, "Raises an exception. CompoundData does not support comparison operators." )
		.def( "__repr__", &CompoundDataFunctions::repr )
		// python map methods.
		.def( "clear", &CompoundDataFunctions::clear, "m.clear()\nRemoves all items from m." )
		.def( "has_key", &CompoundDataFunctions::has_key, "m.has_key(k)\nReturns True if m has key k; otherwise, returns False." )
		.def( "items", &CompoundDataFunctions::items, "m.items()\nReturns a list of (key, value) pairs." )
		.def( "keys", &CompoundDataFunctions::keys, "m.keys()\nReturns a list of key values." )
		.def( "update", &CompoundDataFunctions::update, "m.update(b)\nAdds all objects from b to m. b can be a CompoundData or a python dict." )
		.def( "values", &CompoundDataFunctions::values, "m.values()\nReturns a list of all values in m." )
		.def( "get", &CompoundDataFunctions::get, "m.get(k [, v])\nReturns m[k] if found; otherwise, returns v.",
			(
				boost::python::arg( "self" ),
				boost::python::arg( "key" ),
				boost::python::arg( "defaultValue" ) = object()
			)
		)
		.def( "setdefault", &CompoundDataFunctions::setdefault, "m.setdefault(k [, v])\nReturns m[k] if found; otherwise, returns v and sets m[k] = v." )
		.def( "setdefault", &CompoundDataFunctions::setdefault2 )
		.def( "pop", &CompoundDataFunctions::pop, "m.pop(k [,default])\nReturns m[k] if found and removes it from m; otherwise, returns default if supplied or raises KeyError if not." )
		.def( "pop", &CompoundDataFunctions::pop2 )
		.def( "popitem", &CompoundDataFunctions::popitem, "m.popitem()\nRemvoes a random (key,value) pair from m and returns it as a tuple." )
		.def( "hasBase", &CompoundData::hasBase ).staticmethod( "hasBase" )
	;

	CompoundDataFromPythonDict();

}

} // namespace IECorePython