Skip to content

# `nautobot.apps.tables`

Utilities for apps to implement data tables.

## `nautobot.apps.tables.BaseTable`

Bases: `tables.Table`

Default table for object lists

:param user: Personalize table display for the given user (optional). Has no effect if AnonymousUser is passed.

Source code in `nautobot/utilities/tables.py`

     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     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
    class BaseTable(tables.Table):
        """
        Default table for object lists

        :param user: Personalize table display for the given user (optional). Has no effect if AnonymousUser is passed.
        """

        class Meta:
            attrs = {
                "class": "table table-hover table-headings",
            }

        def __init__(self, *args, user=None, **kwargs):
            from nautobot.dcim.tables.template_code import MPTT_LINK_WITHOUT_NESTING  # Avoid Circular Import

            # Add custom field columns
            obj_type = ContentType.objects.get_for_model(self._meta.model)

            for cf in CustomField.objects.filter(content_types=obj_type):
                name = f"cf_{cf.slug}"
                self.base_columns[name] = CustomFieldColumn(cf)

            for cpf in ComputedField.objects.filter(content_type=obj_type):
                self.base_columns[f"cpf_{cpf.slug}"] = ComputedFieldColumn(cpf)

            for relationship in Relationship.objects.filter(source_type=obj_type):
                if not relationship.symmetric:
                    self.base_columns[f"cr_{relationship.slug}_src"] = RelationshipColumn(
                        relationship, side=RelationshipSideChoices.SIDE_SOURCE
                    )
                else:
                    self.base_columns[f"cr_{relationship.slug}_peer"] = RelationshipColumn(
                        relationship, side=RelationshipSideChoices.SIDE_PEER
                    )

            for relationship in Relationship.objects.filter(destination_type=obj_type):
                if not relationship.symmetric:
                    self.base_columns[f"cr_{relationship.slug}_dst"] = RelationshipColumn(
                        relationship, side=RelationshipSideChoices.SIDE_DESTINATION
                    )
                # symmetric relationships are already handled above in the source_type case

            model = getattr(self.Meta, "model", None)
            # Disable ordering on these TreeNode Models Table because TreeNode do not support sorting
            if model and issubclass(model, TreeNode):
                kwargs["orderable"] = False

            # Init table
            super().__init__(*args, **kwargs)

            # The name nesting is removed when sorting on the UI because it results in rows appearing as children of the wrong parent rows.
            if model and issubclass(model, MPTTModel) and self.order_by:
                self.columns["name"].column.template_code = MPTT_LINK_WITHOUT_NESTING

            # Set default empty_text if none was provided
            if self.empty_text is None:
                self.empty_text = f"No {self._meta.model._meta.verbose_name_plural} found"

            # Hide non-default columns
            default_columns = list(getattr(self.Meta, "default_columns", []))
            extra_columns = [c[0] for c in kwargs.get("extra_columns", [])]  # extra_columns is a list of tuples
            if default_columns:
                for column in self.columns:
                    if column.name not in default_columns and column.name not in extra_columns:
                        # Hide the column if it is non-default *and* not manually specified as an extra column
                        self.columns.hide(column.name)

            # Apply custom column ordering for user
            if user is not None and not isinstance(user, AnonymousUser):
                columns = user.get_config(f"tables.{self.__class__.__name__}.columns")
                if columns:
                    pk = self.base_columns.pop("pk", None)
                    actions = self.base_columns.pop("actions", None)

                    for name, column in self.base_columns.items():
                        if name in columns:
                            self.columns.show(name)
                        else:
                            self.columns.hide(name)
                    self.sequence = [c for c in columns if c in self.base_columns]

                    # Always include PK and actions column, if defined on the table
                    if pk:
                        self.base_columns["pk"] = pk
                        self.sequence.insert(0, "pk")
                    if actions:
                        self.base_columns["actions"] = actions
                        self.sequence.append("actions")

            # Dynamically update the table's QuerySet to ensure related fields are pre-fetched
            if isinstance(self.data, TableQuerysetData):
                # v2 TODO(jathan): Replace prefetch_related with select_related
                prefetch_fields = []
                for column in self.columns:
                    if column.visible:
                        model = getattr(self.Meta, "model")
                        accessor = column.accessor
                        prefetch_path = []
                        for field_name in accessor.split(accessor.SEPARATOR):
                            try:
                                field = model._meta.get_field(field_name)
                            except FieldDoesNotExist:
                                break
                            if isinstance(field, RelatedField):
                                # Follow ForeignKeys to the related model
                                prefetch_path.append(field_name)
                                model = field.remote_field.model
                            elif isinstance(field, GenericForeignKey):
                                # Can't prefetch beyond a GenericForeignKey
                                prefetch_path.append(field_name)
                                break
                        if prefetch_path:
                            prefetch_fields.append("__".join(prefetch_path))
                self.data.data = self.data.data.prefetch_related(None).prefetch_related(*prefetch_fields)

        @property
        def configurable_columns(self):
            selected_columns = [
                (name, self.columns[name].verbose_name) for name in self.sequence if name not in ["pk", "actions"]
            ]
            available_columns = [
                (name, column.verbose_name)
                for name, column in self.columns.items()
                if name not in self.sequence and name not in ["pk", "actions"]
            ]
            return selected_columns + available_columns

        @property
        def visible_columns(self):
            return [name for name in self.sequence if self.columns[name].visible]

## `nautobot.apps.tables.BooleanColumn`

Bases: `tables.Column`

Custom implementation of BooleanColumn to render a nicely-formatted checkmark or X icon instead of a Unicode character.

Source code in `nautobot/utilities/tables.py`

    177
    178
    179
    180
    181
    182
    183
    184
    class BooleanColumn(tables.Column):
        """
        Custom implementation of BooleanColumn to render a nicely-formatted checkmark or X icon instead of a Unicode
        character.
        """

        def render(self, value):
            return render_boolean(value)

## `nautobot.apps.tables.ButtonsColumn`

Bases: `tables.TemplateColumn`

Render edit, delete, and changelog buttons for an object.

:param model: Model class to use for calculating URL view names :param prepend_template: Additional template content to render in the column (optional) :param return_url_extra: String to append to the return URL (e.g. for specifying a tab) (optional)

Source code in `nautobot/utilities/tables.py`

    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    class ButtonsColumn(tables.TemplateColumn):
        """
        Render edit, delete, and changelog buttons for an object.

        :param model: Model class to use for calculating URL view names
        :param prepend_template: Additional template content to render in the column (optional)
        :param return_url_extra: String to append to the return URL (e.g. for specifying a tab) (optional)
        """

        buttons = ("changelog", "edit", "delete")
        attrs = {"td": {"class": "text-right text-nowrap noprint"}}
        # Note that braces are escaped to allow for string formatting prior to template rendering
        template_code = """
        {{% if "changelog" in buttons %}}
            <a href="{{% url '{changelog_route}' {pk_field}=record.{pk_field} %}}" class="btn btn-default btn-xs" title="Change log">
                <i class="mdi mdi-history"></i>
            </a>
        {{% endif %}}
        {{% if "edit" in buttons and perms.{app_label}.change_{model_name} %}}
            <a href="{{% url '{edit_route}' {pk_field}=record.{pk_field} %}}?return_url={{{{ request.path }}}}{{{{ return_url_extra }}}}" class="btn btn-xs btn-warning" title="Edit">
                <i class="mdi mdi-pencil"></i>
            </a>
        {{% endif %}}
        {{% if "delete" in buttons and perms.{app_label}.delete_{model_name} %}}
            <a href="{{% url '{delete_route}' {pk_field}=record.{pk_field} %}}?return_url={{{{ request.path }}}}{{{{ return_url_extra }}}}" class="btn btn-xs btn-danger" title="Delete">
                <i class="mdi mdi-trash-can-outline"></i>
            </a>
        {{% endif %}}
        """

        def __init__(
            self,
            model,
            *args,
            pk_field="pk",
            buttons=None,
            prepend_template=None,
            return_url_extra="",
            **kwargs,
        ):
            if prepend_template:
                prepend_template = prepend_template.replace("{", "{{")
                prepend_template = prepend_template.replace("}", "}}")
                self.template_code = prepend_template + self.template_code

            app_label = model._meta.app_label
            changelog_route = get_route_for_model(model, "changelog")
            edit_route = get_route_for_model(model, "edit")
            delete_route = get_route_for_model(model, "delete")

            template_code = self.template_code.format(
                app_label=app_label,
                model_name=model._meta.model_name,
                changelog_route=changelog_route,
                edit_route=edit_route,
                delete_route=delete_route,
                pk_field=pk_field,
                buttons=buttons,
            )

            super().__init__(template_code=template_code, *args, **kwargs)

            self.extra_context.update(
                {
                    "buttons": buttons or self.buttons,
                    "return_url_extra": return_url_extra,
                }
            )

        def header(self):  # pylint: disable=invalid-overridden-method
            return ""

## `nautobot.apps.tables.ColoredLabelColumn`

Bases: `tables.TemplateColumn`

Render a colored label (e.g. for DeviceRoles).

Source code in `nautobot/utilities/tables.py`

    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    class ColoredLabelColumn(tables.TemplateColumn):
        """
        Render a colored label (e.g. for DeviceRoles).
        """

        template_code = """
        {% load helpers %}
        {% if value %}<label class="label" style="color: {{ value.color|fgcolor }}; background-color: #{{ value.color }}">{{ value }}</label>{% else %}&mdash;{% endif %}
        """

        def __init__(self, *args, **kwargs):
            super().__init__(template_code=self.template_code, *args, **kwargs)

## `nautobot.apps.tables.ContentTypesColumn`

Bases: `tables.ManyToManyColumn`

Display a list of `content_types` m2m assigned to an object.

Default sorting of content-types is by pk. This sorting comes at a per-row performance hit to querysets for table views. If this becomes an issue, set `sort_items=False`.

:param sort_items: Whether to sort by `(app_label, name)`. (default: True) :param truncate_words: Number of words at which to truncate, or `None` to disable. (default: None)

Source code in `nautobot/utilities/tables.py`

    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    class ContentTypesColumn(tables.ManyToManyColumn):
        """
        Display a list of `content_types` m2m assigned to an object.

        Default sorting of content-types is by pk. This sorting comes at a per-row
        performance hit to querysets for table views. If this becomes an issue,
        set `sort_items=False`.

        :param sort_items: Whether to sort by `(app_label, name)`. (default: True)
        :param truncate_words:
            Number of words at which to truncate, or `None` to disable. (default: None)
        """

        def __init__(self, sort_items=True, truncate_words=None, *args, **kwargs):
            super().__init__(*args, **kwargs)
            self.sort_items = sort_items
            self.truncate_words = truncate_words

        def filter(self, qs):
            """Overload filter to optionally sort items."""
            if self.sort_items:
                qs = qs.order_by("app_label", "model")
            return qs.all()

        def render(self, value):
            """Overload render to optionally truncate words."""
            value = super().render(value)
            if self.truncate_words is not None:
                trunc = Truncator(value)
                value = trunc.words(self.truncate_words)
            return value

### `filter(qs)`

Overload filter to optionally sort items.

Source code in `nautobot/utilities/tables.py`

    357
    358
    359
    360
    361
    def filter(self, qs):
        """Overload filter to optionally sort items."""
        if self.sort_items:
            qs = qs.order_by("app_label", "model")
        return qs.all()

### `render(value)`

Overload render to optionally truncate words.

Source code in `nautobot/utilities/tables.py`

    363
    364
    365
    366
    367
    368
    369
    def render(self, value):
        """Overload render to optionally truncate words."""
        value = super().render(value)
        if self.truncate_words is not None:
            trunc = Truncator(value)
            value = trunc.words(self.truncate_words)
        return value

## `nautobot.apps.tables.StatusTableMixin`

Bases: `BaseTable`

Mixin to add a `status` field to a table.

Source code in `nautobot/extras/tables.py`

    962
    963
    964
    965
    class StatusTableMixin(BaseTable):
        """Mixin to add a `status` field to a table."""

        status = ColoredLabelColumn()

## `nautobot.apps.tables.TagColumn`

Bases: `tables.TemplateColumn`

Display a list of tags assigned to the object.

Source code in `nautobot/utilities/tables.py`

    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    class TagColumn(tables.TemplateColumn):
        """
        Display a list of tags assigned to the object.
        """

        template_code = """
        {% for tag in value.all %}
            {% include 'utilities/templatetags/tag.html' %}
        {% empty %}
            <span class="text-muted">&mdash;</span>
        {% endfor %}
        """

        def __init__(self, url_name=None):
            super().__init__(template_code=self.template_code, extra_context={"url_name": url_name})

## `nautobot.apps.tables.ToggleColumn`

Bases: `tables.CheckBoxColumn`

Extend CheckBoxColumn to add a "toggle all" checkbox in the column header.

Source code in `nautobot/utilities/tables.py`

    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    class ToggleColumn(tables.CheckBoxColumn):
        """
        Extend CheckBoxColumn to add a "toggle all" checkbox in the column header.
        """

        def __init__(self, *args, **kwargs):
            default = kwargs.pop("default", "")
            visible = kwargs.pop("visible", False)
            if "attrs" not in kwargs:
                kwargs["attrs"] = {"td": {"class": "min-width"}}
            super().__init__(*args, default=default, visible=visible, **kwargs)

        @property
        def header(self):
            return mark_safe('<input type="checkbox" class="toggle" title="Toggle all" />')  # noqa: S308