LSSTApplications  17.0+11,17.0+35,17.0+60,17.0+61,17.0+63,17.0+7,17.0-1-g377950a+35,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+30,17.0.1-1-g55520dc+55,17.0.1-1-g5f4ed7e+59,17.0.1-1-g6dd7d69+22,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+63,17.0.1-1-gfc65f5f+56,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+9,17.0.1-12-g112a4bc+3,17.0.1-17-gab9750a3+5,17.0.1-17-gdae4c4a+16,17.0.1-19-g3a24bb2+2,17.0.1-2-g26618f5+35,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-21-g52a398f+5,17.0.1-26-gd98a1d13,17.0.1-3-g7e86b59+45,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+46,17.0.1-31-gb0791f330,17.0.1-4-g59d126d+10,17.0.1-5-g3877d06+2,17.0.1-7-g35889ee+7,17.0.1-7-gc7c8782+20,17.0.1-7-gcb7da53+5,17.0.1-9-gc4bbfb2+10,w.2019.24
LSSTDataManagementBasePackage
Public Member Functions | List of all members
lsst.pipe.base.struct.Struct Class Reference
Inheritance diagram for lsst.pipe.base.struct.Struct:
lsst.ctrl.pool.pool.Cache

Public Member Functions

def __init__ (self, keyArgs)
 
def getDict (self)
 
def mergeItems (self, struct, nameList)
 
def copy (self)
 
def __eq__ (self, other)
 
def __len__ (self)
 
def __repr__ (self)
 

Detailed Description

A container to which you can add fields as attributes.

Parameters
----------
keyArgs
    keyword arguments specifying fields and their values.

Notes
-----
Intended to be used for the return value from `~lsst.pipe.base.Task.run` and other `~lsst.pipe.base.Task`
methods, and useful for any method that returns multiple values.

The intent is to allow accessing returned items by name, instead of unpacking a tuple.
This makes the code much more robust and easier to read. It allows one to change what values are returned
without inducing mysterious failures: adding items is completely safe, and removing or renaming items
causes errors that are caught quickly and reported in a way that is easy to understand.

The primary reason for using Struct instead of dict is that the fields may be accessed as attributes,
e.g. ``aStruct.foo`` instead of ``aDict["foo"]``. Admittedly this only saves a few characters, but it
makes the code significantly more readable.

Struct is preferred over named tuples, because named tuples can be used as ordinary tuples, thus losing
all the safety advantages of Struct. In addition, named tuples are clumsy to define and Structs
are much more mutable (e.g. one can trivially combine Structs and add additional fields).

Examples
--------
>>> myStruct = Struct(
>>>     strVal = 'the value of the field named "strVal"',
>>>     intVal = 35,
>>> )

Definition at line 26 of file struct.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.struct.Struct.__init__ (   self,
  keyArgs 
)

Definition at line 61 of file struct.py.

61  def __init__(self, **keyArgs):
62  for name, val in keyArgs.items():
63  self.__safeAdd(name, val)
64 
def __init__(self, minimum, dataRange, Q)

Member Function Documentation

◆ __eq__()

def lsst.pipe.base.struct.Struct.__eq__ (   self,
  other 
)

Definition at line 133 of file struct.py.

133  def __eq__(self, other):
134  return self.__dict__ == other.__dict__
135 

◆ __len__()

def lsst.pipe.base.struct.Struct.__len__ (   self)

Definition at line 136 of file struct.py.

136  def __len__(self):
137  return len(self.__dict__)
138 

◆ __repr__()

def lsst.pipe.base.struct.Struct.__repr__ (   self)

Definition at line 139 of file struct.py.

139  def __repr__(self):
140  itemList = ["%s=%r" % (name, val) for name, val in self.getDict().items()]
141  return "%s(%s)" % (self.__class__.__name__, "; ".join(itemList))
142 
std::vector< SchemaItem< Flag > > * items

◆ copy()

def lsst.pipe.base.struct.Struct.copy (   self)
Make a one-level-deep copy (values are not copied).

Returns
-------
copy : `Struct`
    One-level-deep copy of this Struct.

Definition at line 123 of file struct.py.

123  def copy(self):
124  """Make a one-level-deep copy (values are not copied).
125 
126  Returns
127  -------
128  copy : `Struct`
129  One-level-deep copy of this Struct.
130  """
131  return Struct(**self.getDict())
132 

◆ getDict()

def lsst.pipe.base.struct.Struct.getDict (   self)
Get a dictionary of fields in this struct.

Returns
-------
structDict : `dict`
    Dictionary with field names as keys and field values as values. The values are shallow copies.

Definition at line 86 of file struct.py.

86  def getDict(self):
87  """Get a dictionary of fields in this struct.
88 
89  Returns
90  -------
91  structDict : `dict`
92  Dictionary with field names as keys and field values as values. The values are shallow copies.
93  """
94  return self.__dict__.copy()
95 

◆ mergeItems()

def lsst.pipe.base.struct.Struct.mergeItems (   self,
  struct,
  nameList 
)
Copy specified fields from another struct, provided they don't already exist.

Parameters
----------
struct : `Struct`
    `Struct` from which to copy.
*nameList : `str`
    All remaining arguments are names of items to copy.

Raises
------
RuntimeError
    Raised if any item in nameList already exists in self (but any items before the conflicting item
    in nameList will have been copied).

Examples
--------
For example::

    foo.copyItems(other, "itemName1", "itemName2")

copies ``other.itemName1`` and ``other.itemName2`` into self.

Definition at line 96 of file struct.py.

96  def mergeItems(self, struct, *nameList):
97  """Copy specified fields from another struct, provided they don't already exist.
98 
99  Parameters
100  ----------
101  struct : `Struct`
102  `Struct` from which to copy.
103  *nameList : `str`
104  All remaining arguments are names of items to copy.
105 
106  Raises
107  ------
108  RuntimeError
109  Raised if any item in nameList already exists in self (but any items before the conflicting item
110  in nameList will have been copied).
111 
112  Examples
113  --------
114  For example::
115 
116  foo.copyItems(other, "itemName1", "itemName2")
117 
118  copies ``other.itemName1`` and ``other.itemName2`` into self.
119  """
120  for name in nameList:
121  self.__safeAdd(name, getattr(struct, name))
122 

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