Skip to content

PyObjects

The main parent class for grouping your (Tables, Columns, Measures, Partitions, etc.).

Notice the magic methods. __rich_repr__() starts the baseline for displaying your model. It uses the amazing rich python package and builds your display from the self._display. Still building out the magic methods to give PyObjects more flexibility.

Source code in pytabular/object.py 
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
class PyObjects:
    """The main parent class for grouping your (Tables, Columns, Measures, Partitions, etc.).

    Notice the magic methods. `__rich_repr__()` starts the baseline for displaying your model.
    It uses the amazing `rich` python package and
    builds your display from the `self._display`.
    Still building out the magic methods to give `PyObjects` more flexibility.
    """

    def __init__(self, objects: list[PyObject], parent=None) -> None:
        """Initialization of `PyObjects`.

        Takes the objects in something that is iterable.
        Then will build a default `rich` table display.

        Args:
            objects(list[PyObject]): .Net objects.
            parent: Parent Object. Defaults to `None`.
        """
        self._objects = objects
        self.parent = parent
        self._display = Table(title=str(self.__class__.mro()[0]))
        for index, obj in enumerate(self._objects):
            self._display.add_row(str(index), obj.Name)

    def __rich_repr__(self) -> str:
        """See [Rich Repr](https://rich.readthedocs.io/en/stable/pretty.html#rich-repr-protocol)."""
        Console().print(self._display)

    def __getitem__(self, object):
        """Get item from `PyObjects`.

        Checks if item is str or int.
        If string will iterate through and try to find matching name.
        Otherwise, will call into `self._objects[int]` to retrieve item.
        """
        if isinstance(object, str):
            return [pyobject for pyobject in self._objects if object == pyobject.Name][
                -1
            ]
        elif isinstance(object, slice):
            cls = type(self)
            return cls(self._objects[object])
        else:
            return self._objects[object]

    def __iter__(self):
        """Iterate through `PyObjects`."""
        yield from self._objects

    def __len__(self) -> int:
        """Get length of `PyObjects`.

        Returns:
            int: Number of PyObject in PyObjects
        """
        return len(self._objects)

    def __iadd__(self, obj):
        """Add a `PyObject` or `PyObjects` to your current `PyObjects` class.

        This is useful for building out a custom `PyObjects` class to work with.
        """
        if isinstance(obj, Iterable):
            self._objects.__iadd__(obj._objects)
        else:
            self._objects.__iadd__([obj])

        self.__init__(self._objects)
        return self

    def _first_visible_object(self):
        """Does what the method is called. Get's first `object.IsHidden is False`."""
        for object in self:
            if object.IsHidden is False:
                return object
        return None

    def find(self, object_str: str):
        """Finds any or all `PyObject` inside of `PyObjects` that match the `object_str`.

        It is case insensitive.

        Args:
            object_str (str): str to lookup in `PyObjects`

        Returns:
            PyObjects (object.PyObjects): Returns a `PyObjects` class with all `PyObject`
                where the `PyObject.Name` matches `object_str`.
        """
        items = [
            object
            for object in self._objects
            if object_str.lower() in object.Name.lower()
        ]
        return self.__class__.mro()[0](items)

    def get(self, object_str: str, alt_result: str = "") -> str:
        """Gets the object based on str.

        If the object isnt found, then an alternate result
        can be supplied as an argument.

        Args:
            object_str (str): str to lookup object
            alt_result (str): str to return when value isn't found.

        Returns:
            str: Result of the lookup, or the alternate result.
        """
        try:
            return self.__getitem__(object_str)
        except Exception as e:
            Console().print(e)

        return alt_result

__init__(objects, parent=None)

Initialization of PyObjects.

Takes the objects in something that is iterable. Then will build a default rich table display.

Parameters:

Name Type Description Default
objects(list[PyObject])

.Net objects.

 required
parent

Parent Object. Defaults to None.

 None
Source code in pytabular/object.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def __init__(self, objects: list[PyObject], parent=None) -> None:
    """Initialization of `PyObjects`.

    Takes the objects in something that is iterable.
    Then will build a default `rich` table display.

    Args:
        objects(list[PyObject]): .Net objects.
        parent: Parent Object. Defaults to `None`.
    """
    self._objects = objects
    self.parent = parent
    self._display = Table(title=str(self.__class__.mro()[0]))
    for index, obj in enumerate(self._objects):
        self._display.add_row(str(index), obj.Name)

__rich_repr__()

See Rich Repr.

Source code in pytabular/object.py 
85
86
87
def __rich_repr__(self) -> str:
    """See [Rich Repr](https://rich.readthedocs.io/en/stable/pretty.html#rich-repr-protocol)."""
    Console().print(self._display)

__getitem__(object)

Get item from PyObjects.

Checks if item is str or int. If string will iterate through and try to find matching name. Otherwise, will call into self._objects[int] to retrieve item.

Source code in pytabular/object.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def __getitem__(self, object):
    """Get item from `PyObjects`.

    Checks if item is str or int.
    If string will iterate through and try to find matching name.
    Otherwise, will call into `self._objects[int]` to retrieve item.
    """
    if isinstance(object, str):
        return [pyobject for pyobject in self._objects if object == pyobject.Name][
            -1
        ]
    elif isinstance(object, slice):
        cls = type(self)
        return cls(self._objects[object])
    else:
        return self._objects[object]

__iter__()

Iterate through PyObjects.

Source code in pytabular/object.py 
106
107
108
def __iter__(self):
    """Iterate through `PyObjects`."""
    yield from self._objects

__len__()

Get length of PyObjects.

Returns:

Name Type Description
int int

Number of PyObject in PyObjects
Source code in pytabular/object.py 
110
111
112
113
114
115
116
def __len__(self) -> int:
    """Get length of `PyObjects`.

    Returns:
        int: Number of PyObject in PyObjects
    """
    return len(self._objects)

__iadd__(obj)

Add a PyObject or PyObjects to your current PyObjects class.

This is useful for building out a custom PyObjects class to work with.

Source code in pytabular/object.py 
118
119
120
121
122
123
124
125
126
127
128
129
def __iadd__(self, obj):
    """Add a `PyObject` or `PyObjects` to your current `PyObjects` class.

    This is useful for building out a custom `PyObjects` class to work with.
    """
    if isinstance(obj, Iterable):
        self._objects.__iadd__(obj._objects)
    else:
        self._objects.__iadd__([obj])

    self.__init__(self._objects)
    return self

find(object_str)

Finds any or all PyObject inside of PyObjects that match the object_str.

It is case insensitive.

Parameters:

Name Type Description Default
object_str str

str to lookup in PyObjects

 required

Returns:

Name Type Description
PyObjects PyObjects

Returns a PyObjects class with all PyObject where the PyObject.Name matches object_str.
Source code in pytabular/object.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
def find(self, object_str: str):
    """Finds any or all `PyObject` inside of `PyObjects` that match the `object_str`.

    It is case insensitive.

    Args:
        object_str (str): str to lookup in `PyObjects`

    Returns:
        PyObjects (object.PyObjects): Returns a `PyObjects` class with all `PyObject`
            where the `PyObject.Name` matches `object_str`.
    """
    items = [
        object
        for object in self._objects
        if object_str.lower() in object.Name.lower()
    ]
    return self.__class__.mro()[0](items)

get(object_str, alt_result='')

Gets the object based on str.

If the object isnt found, then an alternate result can be supplied as an argument.

Parameters:

Name Type Description Default
object_str str

str to lookup object

 required
alt_result str

str to return when value isn't found.

 ''

Returns:

Name Type Description
str str

Result of the lookup, or the alternate result.
Source code in pytabular/object.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
def get(self, object_str: str, alt_result: str = "") -> str:
    """Gets the object based on str.

    If the object isnt found, then an alternate result
    can be supplied as an argument.

    Args:
        object_str (str): str to lookup object
        alt_result (str): str to return when value isn't found.

    Returns:
        str: Result of the lookup, or the alternate result.
    """
    try:
        return self.__getitem__(object_str)
    except Exception as e:
        Console().print(e)

    return alt_result