conffwk.dal.DalBase Class Reference

Inheritance diagram for conffwk.dal.DalBase:

Collaboration diagram for conffwk.dal.DalBase:

Public Member Functions
	__init__ (self, id, **kwargs)
	__reset_identity__ (self)
	className (self)
	isDalType (self, val)
	oksTypes (self)
	fullName (self)
	copy (self, other)
	rename (self, new_name)
	__repr__ (self)
	__str__ (self)
	__eq__ (self, other)
	__ne__ (self, other)
	__gt__ (self, other)
	__lt__ (self, other)
	__ge__ (self, other)
	__le__ (self, other)
	__hash__ (self)
	__getall__ (self, comp=None)
	get (self, className, idVal=None, lookBaseClasses=False)
	__getattr__ (self, par)
	setattr_nocheck (self, par, val)
	__setattr__ (self, par, val)

Static Public Member Functions
	updated ()
	reset_updated_list ()

Public Attributes
	id = new_name:

Static Protected Attributes
	_updated = set()

Private Attributes
	__class__
list	__touched__ = []
str	__fullname__ = '%s@%s' % (self.id, self.className())
	__hashvalue__ = hash(self.__fullname__)

Detailed Description

This class is used to represent any DAL object in the system. 

Definition at line 88 of file dal.py.

Constructor & Destructor Documentation

__init__()

conffwk.dal.DalBase.__init__	(		self,
			id,
		**	kwargs )

Constructs an object by setting its id (UID in OKS jargon) at least.

This method will initialize an object of the DalBase type, by setting
its internal properties (with schema cross-checking where it is
possible). The user should at least set the object's id, which at this
moment is not checked for uniqueness.

Keyword arguments:

id -- This is the unique identifier (per database) that the user wants
to assign to this object. This identifier will be used as the OKS
identifier when and if this object is ever serialized in an OKS
database.

**kwargs -- This is a set of attributes and relationships that must
exist in the associated DAL class that inherits from this base.

Definition at line 106 of file dal.py.

    def __init__(self, id, **kwargs):
        """Constructs an object by setting its id (UID in OKS jargon) at least.
 
        This method will initialize an object of the DalBase type, by setting
        its internal properties (with schema cross-checking where it is
        possible). The user should at least set the object's id, which at this
        moment is not checked for uniqueness.
 
        Keyword arguments:
 
        id -- This is the unique identifier (per database) that the user wants
        to assign to this object. This identifier will be used as the OKS
        identifier when and if this object is ever serialized in an OKS
        database.
 
        **kwargs -- This is a set of attributes and relationships that must
        exist in the associated DAL class that inherits from this base.
        """
        from . import dalproperty
        prop = property(dalproperty._return_attribute('id', self, id),
                        dalproperty._assign_attribute('id'))
        setattr(self.__class__, 'id', prop)
        self.__reset_identity__()
 
        self.__touched__ = []  # optimization
        for k, v in kwargs.items():
            setattr(self, k, v)
 

Member Function Documentation

__eq__()

conffwk.dal.DalBase.__eq__	(		self,
			other )

True is the 2 objects have the same class and ID.

Definition at line 244 of file dal.py.

    def __eq__(self, other):
        """True is the 2 objects have the same class and ID."""
        return self.__hashvalue__ == hash(other)
 

__ge__()

conffwk.dal.DalBase.__ge__	(		self,
			other )

True if the object is greater or equal than the other
alphabetically.

Definition at line 264 of file dal.py.

    def __ge__(self, other):
        """True if the object is greater or equal than the other
        alphabetically.
        """
        return (self > other) or (self == other)
 

__getall__()

conffwk.dal.DalBase.__getall__	(		self,
			comp = None )

Get all relations, includding a link to myself

Definition at line 278 of file dal.py.

    def __getall__(self, comp=None):
        """Get all relations, includding a link to myself"""
        top = False
        if not comp:
            top = True
            comp = {}
 
        if self.__fullname__ in comp:
            return
 
        comp[self.__fullname__] = self
        for r in list(self.__schema__['relation'].keys()):
 
            if not getattr(self, r):
                continue
 
            if isinstance(getattr(self, r), list):
                for k in getattr(self, r):
                    k.__getall__(comp)
            else:
                getattr(self, r).__getall__(comp)
 
        if top:
            return comp
 

__getattr__()

conffwk.dal.DalBase.__getattr__	(		self,
			par )

Returns a given attribute or relationship.

This method returns an attribute or relationship from the current
object, or throws an AttributeError if no such thing exists. It sets
the field touched, so it does not get called twice.

Definition at line 360 of file dal.py.

    def __getattr__(self, par):
        """Returns a given attribute or relationship.
 
        This method returns an attribute or relationship from the current
        object, or throws an AttributeError if no such thing exists. It sets
        the field touched, so it does not get called twice.
        """
 
        if par in self.__schema__['attribute']:
            if self.__schema__['attribute'][par]['init-value']:
                setattr(self, par, self.__schema__[
                        'attribute'][par]['init-value'])
            else:
                if self.__schema__['attribute'][par]['multivalue']:
                    setattr(self, par, [])
                else:
                    return None  # in this case, does not set anything
            return getattr(self, par)
 
        elif par in self.__schema__['relation']:
            if self.__schema__['relation'][par]['multivalue']:
                setattr(self, par, [])
            else:
                return None
            return getattr(self, par)
 
        raise AttributeError("'%s' object has no attribute/relation '%s'" %
                             (self.className(), par))
 

__gt__()

conffwk.dal.DalBase.__gt__	(		self,
			other )

True if the object is greater than the other alphabetically.

Definition at line 252 of file dal.py.

    def __gt__(self, other):
        """True if the object is greater than the other alphabetically."""
        if self.className() == other.className():
            return self.id > other.id
        return self.className() > other.className()
 

__hash__()

conffwk.dal.DalBase.__hash__

(

self

)

This method is meant to be used to allow DAL objects as map keys.

Definition at line 274 of file dal.py.

    def __hash__(self):
        """This method is meant to be used to allow DAL objects as map keys."""
        return self.__hashvalue__
 

__le__()

conffwk.dal.DalBase.__le__	(		self,
			other )

Returns True if the class is smaller or equal than the other. 

Definition at line 270 of file dal.py.

    def __le__(self, other):
        """Returns True if the class is smaller or equal than the other. """
        return (self < other) or (self == other)
 

__lt__()

conffwk.dal.DalBase.__lt__	(		self,
			other )

True if the class is smaller than the other.  

Definition at line 258 of file dal.py.

    def __lt__(self, other):
        """True if the class is smaller than the other.  """
        if self.className() == other.className():
            return self.id < other.id
        return (self.className() < other.className())
 

__ne__()

conffwk.dal.DalBase.__ne__	(		self,
			other )

True if the 2 objects *not* have the same class and ID.

Definition at line 248 of file dal.py.

    def __ne__(self, other):
        """True if the 2 objects *not* have the same class and ID."""
        return self.__hashvalue__ != hash(other)
 

__repr__()

conffwk.dal.DalBase.__repr__

(

self

)

Returns a nice representation of this object.

Definition at line 203 of file dal.py.

    def __repr__(self):
        """Returns a nice representation of this object."""
        return "<%s>" % (self.__fullname__)
 

__reset_identity__()

conffwk.dal.DalBase.__reset_identity__

(

self

)

Definition at line 134 of file dal.py.

    def __reset_identity__(self):
        self.__fullname__ = '%s@%s' % (self.id, self.className())
        self.__hashvalue__ = hash(self.__fullname__)
 

__setattr__()

conffwk.dal.DalBase.__setattr__	(		self,
			par,
			val )

Sets an object attribute or relationship.

This method overrides the default setattr method, so it can apply
existence and type verification on class attributes. If the attribute
to be set starts with '__', or the passed value is None,
no verification is performed. If the value to set an attribute is a
list, the type verification is performed in every component of that
list.

N.B.: This method takes a reference to the object being passed. It does
not copy the value, so, if you do a.b = c, and then you apply changes
to 'c', these changes will be also applied to 'a.b'.

Parameters:

par -- The name of the parameter (attribute or relationship)

val -- The value that will be attributed to 'par'.

Raises AttributeError if the parameter does not exist.

Raises ValueError if the value you passed cannot be coerced to a
compatible OKS python type for the attribute or relationship you are
trying to set.

Definition at line 397 of file dal.py.

    def __setattr__(self, par, val):
        """Sets an object attribute or relationship.
 
        This method overrides the default setattr method, so it can apply
        existence and type verification on class attributes. If the attribute
        to be set starts with '__', or the passed value is None,
        no verification is performed. If the value to set an attribute is a
        list, the type verification is performed in every component of that
        list.
 
        N.B.: This method takes a reference to the object being passed. It does
        not copy the value, so, if you do a.b = c, and then you apply changes
        to 'c', these changes will be also applied to 'a.b'.
 
        Parameters:
 
        par -- The name of the parameter (attribute or relationship)
 
        val -- The value that will be attributed to 'par'.
 
        Raises AttributeError if the parameter does not exist.
 
        Raises ValueError if the value you passed cannot be coerced to a
        compatible OKS python type for the attribute or relationship you are
        trying to set.
        """
        from .schema import coerce, check_relation, check_cardinality
        from . import dalproperty
 
        # no checks for control parameters
        if par[0:2] == '__':
            self.__dict__[par] = val
            return
 
        # and for the id it is special
        if par == 'id':
            if isinstance(val, str):
                prop = getattr(self.__class__, par)
                prop.__set__(self, val)
                self.__reset_identity__()
                return
            else:
                raise ValueError(
                    'The "id" attribute of a DAL object must be a string')
 
        if par in list(self.__schema__['attribute'].keys()):
 
            # If val is None, skip checks
            if val is None:
                self.__dict__[par] = val
 
            try:
                if val is not None:
                    check_cardinality(val, self.__schema__['attribute'][par])
                    if self.__schema__['attribute'][par]['multivalue']:
                        result = \
                            [coerce(v, self.__schema__['attribute'][par])
                             for v in val]
                    else:
                        result = coerce(val, self.__schema__['attribute'][par])
                else:
                    result = val
 
                try:
                    prop = getattr(self.__class__, par)
 
                except AttributeError:
 
                    prop = property(dalproperty._return_attribute(par),
                                    dalproperty._assign_attribute(par))
                    setattr(self.__class__, par, prop)
 
                prop.__set__(self, result)
 
            except ValueError as e:
                raise ValueError('Problems setting attribute "%s" '
                                 'at object %s: %s' %
                                 (par, self.fullName(), str(e)))
 
        elif par in list(self.__schema__['relation'].keys()):
 
            try:
                # If val is None, skip checks
                if val is not None:
                    check_cardinality(val, self.__schema__['relation'][par])
 
                    tmpval = \
                        val if self.__schema__[
                            'relation'][par]['multivalue'] else [val]
                    for v in tmpval:
                        check_relation(v, self.__schema__['relation'][par])
 
                try:
                    prop = getattr(self.__class__, par)
 
                except AttributeError:
 
                    multi = self.__schema__['relation'][par]['multivalue']
                    prop = property(
                        dalproperty._return_relation(par, multi=multi),
                        dalproperty._assign_relation(par))
                    setattr(self.__class__, par, prop)
 
                prop.__set__(self, val)
                self.__touched__.append(par)
 
            except ValueError as e:
                raise ValueError('Problems setting relation "%s" at '
                                 'object %s: %s' %
                                 (par, self.fullName(), str(e)))
 
        else:
            raise AttributeError('Parameter "%s" is not ' % par +
                                 'part of class "%s" or any of its '
                                 'parent classes' %
                                 (self.className()))
 
 

__str__()

conffwk.dal.DalBase.__str__

(

self

)

Returns human readable information about the object.

Definition at line 207 of file dal.py.

    def __str__(self):
        """Returns human readable information about the object."""
 
        retval = "%s(id='%s'" % (self.className(), self.id)
 
        for a, v in self.__schema__['attribute'].items():
            retval += ',\n  %s = ' % a
            if hasattr(self, a):
                retval += str(getattr(self, a))
            else:
                retval += 'None'
                if v['init-value']:
                    retval += ", # defaults to '%s'" % v['init-value']
                else:
                    if v['not-null']:
                        retval += ', # MUST be set, there is not default!'
 
        for r, v in self.__schema__['relation'].items():
            retval += ',\n  %s = ' % r
            rel = None
            if hasattr(self, r):
                rel = getattr(self, r)
 
            if rel is None:
                retval += "<unset>"
            elif isinstance(rel, list):
                retval += str([repr(k) for k in getattr(self, r)])
                retval += ']'
            else:
                retval += repr(getattr(self, r))
 
        if retval[-2:] == ',\n':
            retval = retval[:-2]
        retval += ')'
 
        return retval
 

className()

conffwk.dal.DalBase.className

(

self

)

Definition at line 138 of file dal.py.

    def className(self):
        return self.__class__.pyclassName()
 

copy()

conffwk.dal.DalBase.copy	(		self,
			other )

Copies attributes and relationships from the other component.

This will copy whatever relevant attributes and relationships from
another component into myself. The implemented algorithm starts by
iterating on my own schema and looking for the counter part on the
other class's schema, only matching values are copied. This is useful
to copy values from base class objects or templated class objects.

Arguments:

other -- This is the other dal object you are trying to copy.

Definition at line 153 of file dal.py.

    def copy(self, other):
        """Copies attributes and relationships from the other component.
 
        This will copy whatever relevant attributes and relationships from
        another component into myself. The implemented algorithm starts by
        iterating on my own schema and looking for the counter part on the
        other class's schema, only matching values are copied. This is useful
        to copy values from base class objects or templated class objects.
 
        Arguments:
 
        other -- This is the other dal object you are trying to copy.
        """
        for k, v in self.__schema__['attribute'].items():
            if k not in other.__schema__['attribute']:
                continue
            setattr(self, k, getattr(other, k))
        for k, v in self.__schema__['relation'].items():
            if k not in other.__schema__['relation']:
                continue
            obj = getattr(other, k)
            try:
                setattr(self, k, list(obj))
            except TypeError:
                setattr(self, k, obj)
 

fullName()

conffwk.dal.DalBase.fullName

(

self

)

Definition at line 150 of file dal.py.

    def fullName(self):
        return self.__fullname__
 

get()

conffwk.dal.DalBase.get	(		self,
			className,
			idVal = None,
			lookBaseClasses = False )

Get components in the object based on class name and/or id.

This method runs trough the components of its relationships and
returns a sorted list (sorting based on class name and object ID)
containing references to all components that match the search criteria.

Keyword Parameters (may be named):

className -- The name of the class to look for. Should be a string

idVal -- The id of the object to look for. If not set (or set to None),
the search will be based only on the class name. If set, it must be
either a string or an object that defines a match() method (such as a
regular expression).

lookBaseClasses -- If True and parameter to be search is a class, the
method will look also through the base classes names, so if value =
Application, for instance the method will return all objects of class
Application or that inherit from the Application class.

Returns a list with all the components that matched the search
criteria, if idVal is not set or is a type that defines a match()
method such as a regular expression. Otherwise (if it is a string)
returns a single object, if any is found following the criterias for
className and a exact idVal match.

Definition at line 303 of file dal.py.

    def get(self, className, idVal=None, lookBaseClasses=False):
        """Get components in the object based on class name and/or id.
 
        This method runs trough the components of its relationships and
        returns a sorted list (sorting based on class name and object ID)
        containing references to all components that match the search criteria.
 
        Keyword Parameters (may be named):
 
        className -- The name of the class to look for. Should be a string
 
        idVal -- The id of the object to look for. If not set (or set to None),
        the search will be based only on the class name. If set, it must be
        either a string or an object that defines a match() method (such as a
        regular expression).
 
        lookBaseClasses -- If True and parameter to be search is a class, the
        method will look also through the base classes names, so if value =
        Application, for instance the method will return all objects of class
        Application or that inherit from the Application class.
 
        Returns a list with all the components that matched the search
        criteria, if idVal is not set or is a type that defines a match()
        method such as a regular expression. Otherwise (if it is a string)
        returns a single object, if any is found following the criterias for
        className and a exact idVal match.
        """
        retval = []
 
        cmp_class = __strcmp__
        if hasattr(className, 'match'):
            cmp_class = __recmp__
 
        for v in self.__getall__().values():
            if cmp_class(className, v.__class__.__name__) or \
                    (lookBaseClasses and v.isDalType(className)):
                if idVal:
                    if type(idVal) == str:
                        if idVal == v.id:
                            return v
                        else:
                            continue
 
                    # if idVal is set and is not a string,
                    # we just go brute force...
                    if idVal.match(v.id):
                        retval.append(v)
                else:
                    # if idVal is not set and we are sure the class matched,
                    # just append
                    retval.append(v)
 
        if isinstance(idVal, str):
            raise KeyError('Did not find %s@%s under %s' %
                           (idVal, className, self.fullName()))
        return retval
 

isDalType()

conffwk.dal.DalBase.isDalType	(		self,
			val )

Definition at line 141 of file dal.py.

    def isDalType(self, val):
        cmp = __strcmp__
        if hasattr(val, 'match'):
            cmp = __recmp__
        return True in [cmp(val, k) for k in self.__class__.__okstypes__]
 

oksTypes()

conffwk.dal.DalBase.oksTypes

(

self

)

Definition at line 147 of file dal.py.

    def oksTypes(self):
        return self.__class__.pyoksTypes()
 

rename()

conffwk.dal.DalBase.rename	(		self,
			new_name )

Rename the DAL object to a new name.

This will store the old name in a hidden attribute and when
Configuration.update_dal() is called we use it to check
if there is an existing object with that name in the database.

If yes, we call the underlying ConfigObject.rename() method
transparently. If the old name does not exist in the database,
nothing special is done.

This is the only 'official' way to rename an object on the
DAL level. Just changing the 'id' attribute will not have
the same effect.

Definition at line 179 of file dal.py.

    def rename(self, new_name):
        """
        Rename the DAL object to a new name.
 
        This will store the old name in a hidden attribute and when
        Configuration.update_dal() is called we use it to check
        if there is an existing object with that name in the database.
 
        If yes, we call the underlying ConfigObject.rename() method
        transparently. If the old name does not exist in the database,
        nothing special is done.
 
        This is the only 'official' way to rename an object on the
        DAL level. Just changing the 'id' attribute will not have
        the same effect.
        """
        if self.id == new_name:
            return
 
        if not hasattr(self, '__old_id'):
            setattr(self, '__old_id', getattr(self, 'id'))
 
        self.id = new_name
 

reset_updated_list()

conffwk.dal.DalBase.reset_updated_list ( )

static

Reset the set keeping track of modified DAL objects

Definition at line 101 of file dal.py.

    def reset_updated_list():
        """Reset the set keeping track of modified DAL objects
        """
        DalBase._updated.clear()
 

setattr_nocheck()

conffwk.dal.DalBase.setattr_nocheck	(		self,
			par,
			val )

Sets an attribute by-passing the built-in type check.

Definition at line 389 of file dal.py.

    def setattr_nocheck(self, par, val):
        """Sets an attribute by-passing the built-in type check."""
 
        self.__dict__[par] = val
        if par in list(self.__schema__['relation'].keys()):
            self.__touched__.append(par)
        return val
 

updated()

conffwk.dal.DalBase.updated ( )

static

Returns a set of DAL objects that were modified in this DB session

Definition at line 95 of file dal.py.

    def updated():
        """Returns a set of DAL objects that were modified in this DB session
        """
        return set(DalBase._updated)
 

Member Data Documentation

__class__

conffwk.dal.DalBase.__class__

private

Definition at line 127 of file dal.py.

__fullname__

conffwk.dal.DalBase.__fullname__ = '%s@%s' % (self.id, self.className())

private

Definition at line 135 of file dal.py.

__hashvalue__

conffwk.dal.DalBase.__hashvalue__ = hash(self.__fullname__)

private

Definition at line 136 of file dal.py.

__touched__

list conffwk.dal.DalBase.__touched__ = []

private

Definition at line 130 of file dal.py.

_updated

conffwk.dal.DalBase._updated = set()

staticprotected

Definition at line 92 of file dal.py.

id

conffwk.dal.DalBase.id = new_name:

Definition at line 195 of file dal.py.

---

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

• /github/workspace/dunedaq/sourcecode/conffwk/python/conffwk/dal.py