SUAVE.Core.DataOrdered.DataOrdered Class Reference

Inheritance diagram for SUAVE.Core.DataOrdered.DataOrdered:

Public Member Functions
def	append (self, value, key=None)
def	__defaults__ (self)
def	__getitem__ (self, k)
def	__new__ (cls, *args, **kwarg)
def	hasattr (self, k)
def	__init__ (self, *args, **kwarg)
def	__iter__ (self)
def	__str__ (self, indent='')
def	get_bases (self)
def	typestring (self)
def	dataname (self)
def	deep_set (self, keys, val)
def	deep_get (self, keys)
def	update (self, other)
def	__delattr__ (self, key)
def	__eq__ (self, other)
def	__len__ (self)
def	__iter_basic__ (self)
def	__reduce__ (self)
def	__setattr__ (self, key, value)
def	__setitem__ (self, k, v)
def	clear (self)
def	get (self, k, d=None)
def	has_key (self, k)
def	keys (self)
def	values (self)
def	items (self)
def	iterkeys (self)
def	itervalues (self)
def	iteritems (self)

Detailed Description

An extension of the Python dict which allows for both tag and '.' usage.
    This is an ordered dictionary. So indexing it will produce deterministic results.
   
    Assumptions:
    N/A
    
    Source:
    N/A

Constructor & Destructor Documentation

__init__()

def SUAVE.Core.DataOrdered.DataOrdered.__init__	(		self,
		*	args,
		**	kwarg
	)

Initializes a new Data() class
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

Reimplemented in SUAVE.Core.ContainerOrdered.ContainerOrdered.

Member Function Documentation

__defaults__()

def SUAVE.Core.DataOrdered.DataOrdered.__defaults__

(

self

)

A stub for all classes that come later
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

Reimplemented in SUAVE.Core.ContainerOrdered.ContainerOrdered.

__delattr__()

def SUAVE.Core.DataOrdered.DataOrdered.__delattr__	(		self,
			key
	)

An override of the standard __delattr_ in Python. This deletes whatever is called by k
    
    Assumptions:
    This one tries to treat k as an object, if that fails it treats it as a key.
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__eq__()

def SUAVE.Core.DataOrdered.DataOrdered.__eq__	(		self,
			other
	)

This is overrides the Python function for checking for equality
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__getitem__()

def SUAVE.Core.DataOrdered.DataOrdered.__getitem__	(		self,
			k
	)

Retrieves an attribute set by a key k
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__iter__()

def SUAVE.Core.DataOrdered.DataOrdered.__iter__

(

self

)

Returns all the iterable values. Can be used in a for loop.
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__iter_basic__()

def SUAVE.Core.DataOrdered.DataOrdered.__iter_basic__

(

self

)

Returns all the iterable values. Can be used in a for loop.
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__len__()

def SUAVE.Core.DataOrdered.DataOrdered.__len__

(

self

)

This is overrides the Python function for checking length
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__new__()

def SUAVE.Core.DataOrdered.DataOrdered.__new__	(		cls,
		*	args,
		**	kwarg
	)

Creates a new Data() class
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__reduce__()

def SUAVE.Core.DataOrdered.DataOrdered.__reduce__

(

self

)

Reduction function used for making configs
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__setattr__()

def SUAVE.Core.DataOrdered.DataOrdered.__setattr__	(		self,
			key,
			value
	)

An override of the standard __setattr_ in Python.
    
    Assumptions:
    This one tries to treat k as an object, if that fails it treats it as a key.
    
    Source:
    N/A
    
    Inputs:
    key        [key]
    value        [value]
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__setitem__()

def SUAVE.Core.DataOrdered.DataOrdered.__setitem__	(		self,
			k,
			v
	)

An override of the standard __setattr_ in Python.
    
    Assumptions:
    This one tries to treat k as an object, if that fails it treats it as a key.
    
    Source:
    N/A
    
    Inputs:
    k        [key]
    v        [value]
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

__str__()

def SUAVE.Core.DataOrdered.DataOrdered.__str__	(		self,
			indent = ''
	)

This function is used for printing the class. This starts the first line of printing.
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

append()

def SUAVE.Core.DataOrdered.DataOrdered.append	(		self,
			value,
			key = None
	)

Adds new values to the classes. Can also change an already appended key
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    value
    key
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

clear()

def SUAVE.Core.DataOrdered.DataOrdered.clear

(

self

)

Empties a dictionary
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

dataname()

def SUAVE.Core.DataOrdered.DataOrdered.dataname

(

self

)

This function is used for printing the class
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

deep_get()

def SUAVE.Core.DataOrdered.DataOrdered.deep_get	(		self,
			keys
	)

Regresses through a list of keys to pull a specific value out
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    keys  - The keys to iterate over
    
    Outputs:
    value - The value to be retrieved
    
    Properties Used:
    N/A    

deep_set()

def SUAVE.Core.DataOrdered.DataOrdered.deep_set	(		self,
			keys,
			val
	)

Regresses through a list of keys the same value in various places in a dictionary.
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    keys  - The keys to iterate over
    val   - The value to be set
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

get()

def SUAVE.Core.DataOrdered.DataOrdered.get	(		self,
			k,
			d = None
	)

Returns the values from k
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    k
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

get_bases()

def SUAVE.Core.DataOrdered.DataOrdered.get_bases

(

self

)

Finds the higher classes that may be built off of data
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    klasses
    
    Properties Used:
    N/A    

has_key()

def SUAVE.Core.DataOrdered.DataOrdered.has_key	(		self,
			k
	)

Checks if the dictionary has the key, k
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    k
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

items()

def SUAVE.Core.DataOrdered.DataOrdered.items

(

self

)

Returns all the items inside the data class
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    values
    
    Properties Used:
    N/A    

iteritems()

def SUAVE.Core.DataOrdered.DataOrdered.iteritems

(

self

)

All items that may be iterated over
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

iterkeys()

def SUAVE.Core.DataOrdered.DataOrdered.iterkeys

(

self

)

Returns all the keys which may be iterated over
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

itervalues()

def SUAVE.Core.DataOrdered.DataOrdered.itervalues

(

self

)

Finds all the values that can be iterated over.
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

keys()

def SUAVE.Core.DataOrdered.DataOrdered.keys

(

self

)

Returns a list of keys
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

typestring()

def SUAVE.Core.DataOrdered.DataOrdered.typestring

(

self

)

This function makes the .key.key structure in string form of Data()
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

update()

def SUAVE.Core.DataOrdered.DataOrdered.update	(		self,
			other
	)

Updates the internal values of a dictionary with given data
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    other
    
    Outputs:
    N/A
    
    Properties Used:
    N/A    

values()

def SUAVE.Core.DataOrdered.DataOrdered.values

(

self

)

Returns all values inside the Data() class.
    
    Assumptions:
    N/A
    
    Source:
    N/A
    
    Inputs:
    N/A
    
    Outputs:
    values
    
    Properties Used:
    N/A    

---

The documentation for this class was generated from the following file:

• /Users/emiliobotero/Dropbox/SUAVE/SUAVE/trunk/SUAVE/Core/DataOrdered.py