Skip to content

_containers

Full documentation pages are generated for docstring reference only and may contain symbols imported from other modules. Imported symbols are not distinguished from locally defined symbols and will appear in any module that they are imported into. For better information on where symbols should be imported from, review the sourcecode on the github.

FoSpy.blocks._containers

SimpleWrapper

Wrapper for attaching methods and attributes to simple data types that don't support it. Most method or attribute calls are passed through to the wrapped value, but some methods or private attributes are attached when setting a SimpleWrapper as attribute for a SingleBlock or ListBlock.

Source code in FoSpy/blocks/_containers.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class SimpleWrapper:
    """
    Wrapper for attaching methods and attributes to simple data types that don't
    support it. Most method or attribute calls are passed through to the wrapped
    value, but some methods or private attributes are attached when setting a
    `SimpleWrapper` as attribute for a `SingleBlock` or `ListBlock`.
    """
    def __init__(self, value):
        self._value = value

    def __iter__(self):
        return self._value.__iter__()

    def __str__(self):
        return str(self._value)

    def __repr__(self):
        return repr(self._value)

    def __eq__(self, other):
        return self._value == other

    def __call__(self):
        return self._value

    def __getattr__(self, name):
        return getattr(self._value, name)

    def __getitem__(self, key):
        return self._value.__getitem__(key)

    def __setitem__(self, key, val):
        return self._value.__setitem__(key, val)

    def __int__(self):
        return int(self._value)

    def __float__(self):
        return float(self._value)

_value instance-attribute 

_value = value

__call__ 

__call__()
Source code in FoSpy/blocks/_containers.py 
23
24
def __call__(self):
    return self._value

__eq__ 

__eq__(other)
Source code in FoSpy/blocks/_containers.py 
20
21
def __eq__(self, other):
    return self._value == other

__float__ 

__float__()
Source code in FoSpy/blocks/_containers.py 
38
39
def __float__(self):
    return float(self._value)

__getattr__ 

__getattr__(name)
Source code in FoSpy/blocks/_containers.py 
26
27
def __getattr__(self, name):
    return getattr(self._value, name)

__getitem__ 

__getitem__(key)
Source code in FoSpy/blocks/_containers.py 
29
30
def __getitem__(self, key):
    return self._value.__getitem__(key)

__init__ 

__init__(value)
Source code in FoSpy/blocks/_containers.py 
8
9
def __init__(self, value):
    self._value = value

__int__ 

__int__()
Source code in FoSpy/blocks/_containers.py 
35
36
def __int__(self):
    return int(self._value)

__iter__ 

__iter__()
Source code in FoSpy/blocks/_containers.py 
11
12
def __iter__(self):
    return self._value.__iter__()

__repr__ 

__repr__()
Source code in FoSpy/blocks/_containers.py 
17
18
def __repr__(self):
    return repr(self._value)

__setitem__ 

__setitem__(key, val)
Source code in FoSpy/blocks/_containers.py 
32
33
def __setitem__(self, key, val):
    return self._value.__setitem__(key, val)

__str__ 

__str__()
Source code in FoSpy/blocks/_containers.py 
14
15
def __str__(self):
    return str(self._value)

SubContainer

A simple container for storing hidden or unexpected attributes of a SingleBlock

Values are only assigned directly to SingleBlock attributes if they are an expected property. Otherwise they are assigned to a SubContainer at SingleBlock.ext. Also used for SingleBlock._meta.

Example Usage: 

class SingleBlock:
    ... 
    def __setattr__(self, name, value):
        ... 
        if name not in expected:
            return setattr(self.ext, name, value)

Source code in FoSpy/blocks/_containers.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class SubContainer:
    """
    A simple container for storing hidden or unexpected attributes of a
    `SingleBlock`

    Values are only assigned directly to `SingleBlock` attributes if they are an
    expected property. Otherwise they are assigned to a `SubContainer` at
    `SingleBlock.ext`. Also used for `SingleBlock._meta`.

    Example Usage:
    ```
    class SingleBlock:
        ... 
        def __setattr__(self, name, value):
            ... 
            if name not in expected:
                return setattr(self.ext, name, value)
    ```
    """
    def __init__(self):
        pass
    def __iter__(self):
        return iter(self.__dict__)

__init__ 

__init__()
Source code in FoSpy/blocks/_containers.py 
61
62
def __init__(self):
    pass

__iter__ 

__iter__()
Source code in FoSpy/blocks/_containers.py 
63
64
def __iter__(self):
    return iter(self.__dict__)