python.sugar.iovtype Namespace Reference

Classes
class	IOVType

Functions
def	restore_iov_type (name, fields, bases, content, empty, _memoized={})
def	make_iov_type (name, variables, bases=(IOVType,), _memoized={})
def	define_iov_type (func)
def	RANGEIOV_VAL ()

Variables
	__name__
	_has_channel
	_has_insertion_time
	_emptycls

Function Documentation

define_iov_type()

def python.sugar.iovtype.define_iov_type

(

func

)

A decorator which creates a lightweight iov type.

Definition at line 142 of file iovtype.py.

def define_iov_type(func):
    """
    A decorator which creates a lightweight iov type.
    """
    co_code = func.__code__ if hasattr(func, "__code__") else func.func_code
    name = func.__name__
    variables = co_code.co_varnames
    
    return make_iov_type(name, variables)
 
@define_iov_type

make_iov_type()

def python.sugar.iovtype.make_iov_type	(		name,
			variables,
			bases = (IOVType,),
			_memoized = {}
	)

Create an IOV type and its empty type

Definition at line 114 of file iovtype.py.

def make_iov_type(name, variables, bases=(IOVType,), _memoized={}):
    """
    Create an IOV type and its empty type
    """
    args = name, tuple(variables), bases
    if args in _memoized:
        return _memoized[args]
    
    has_insertion_time = "insertion_time" in variables
    has_channel = "channel" in variables
    all_fields = " ".join(["since", "until"] + list(variables))
    
    class cls(namedtuple(name, all_fields)):
        "Named tuple to store IoV types"
    
    cls.__name__ = name
    cls.__bases__ += bases
    cls._has_channel = has_channel
    cls._has_insertion_time = has_insertion_time
    
    cls._emptycls = type(name + "_EMPTY", (cls,), dict(
        _is_empty=True,
        __bool__ = lambda self: False,
    ))   
    
    _memoized[args] = cls
    return cls
 

RANGEIOV_VAL()

def python.sugar.iovtype.RANGEIOV_VAL

(

)

Definition at line 153 of file iovtype.py.

def RANGEIOV_VAL():
    "Just store a since, until"

restore_iov_type()

def python.sugar.iovtype.restore_iov_type	(		name,
			fields,
			bases,
			content,
			empty,
			_memoized = {}
	)

This would be better as a class method, but it's not possible to pickle 
those, hence why this exists.
_memoized is used to store the type to avoid a function call to rebuild the
type un-necessarily

Definition at line 9 of file iovtype.py.

def restore_iov_type(name, fields, bases, content, empty, _memoized={}):
    """
    This would be better as a class method, but it's not possible to pickle 
    those, hence why this exists.
    _memoized is used to store the type to avoid a function call to rebuild the
    type un-necessarily
    """
    args = name, fields, bases, empty
    if args not in _memoized: 
        # Don't take the last argument
        iov_type = make_iov_type(*args[:-1])
        _memoized[args] = iov_type._emptycls if empty else iov_type 
    return _memoized[args]._make(content)
        

Variable Documentation

__name__

python.sugar.iovtype.__name__

private

Definition at line 129 of file iovtype.py.

_emptycls

python.sugar.iovtype._emptycls

private

Definition at line 134 of file iovtype.py.

_has_channel

python.sugar.iovtype._has_channel

private

Definition at line 131 of file iovtype.py.

_has_insertion_time

python.sugar.iovtype._has_insertion_time

private

Definition at line 132 of file iovtype.py.