mirror of
https://github.com/netbox-community/netbox.git
synced 2026-03-29 05:42:09 +02:00
103 lines
3.0 KiB
Python
103 lines
3.0 KiB
Python
import random
|
|
import string
|
|
from functools import cached_property
|
|
|
|
__all__ = (
|
|
'FieldSet',
|
|
'InlineFields',
|
|
'M2MAddRemoveFields',
|
|
'ObjectAttribute',
|
|
'TabbedGroups',
|
|
)
|
|
|
|
|
|
class FieldSet:
|
|
"""
|
|
A generic grouping of fields, with an optional name. Each item will be rendered
|
|
on its own row under the provided heading (name), if any. The following types
|
|
may be passed as items:
|
|
|
|
* Field name (string)
|
|
* InlineFields instance
|
|
* TabbedGroups instance
|
|
* ObjectAttribute instance
|
|
|
|
Parameters:
|
|
items: An iterable of items to be rendered (one per row)
|
|
name: The fieldset's name, displayed as a heading (optional)
|
|
"""
|
|
def __init__(self, *items, name=None):
|
|
self.items = items
|
|
self.name = name
|
|
|
|
|
|
class InlineFields:
|
|
"""
|
|
A set of fields rendered inline (side-by-side) with a shared label.
|
|
|
|
Parameters:
|
|
fields: An iterable of form field names
|
|
label: The label text to render for the row (optional)
|
|
"""
|
|
def __init__(self, *fields, label=None):
|
|
self.fields = fields
|
|
self.label = label
|
|
|
|
|
|
class TabbedGroups:
|
|
"""
|
|
Two or more groups of fields (FieldSets) arranged under tabs among which the user can toggle.
|
|
|
|
Parameters:
|
|
fieldsets: An iterable of FieldSet instances, one per tab. Each FieldSet *must* have a
|
|
name assigned, which will be employed as the tab's label.
|
|
"""
|
|
def __init__(self, *fieldsets):
|
|
for fs in fieldsets:
|
|
if not fs.name:
|
|
raise ValueError(f"Grouped fieldset {fs} must have a name.")
|
|
self.groups = fieldsets
|
|
|
|
# Initialize a random ID for the group (for tab selection)
|
|
self.id = ''.join(
|
|
random.choice(string.ascii_lowercase + string.digits) for _ in range(8)
|
|
)
|
|
|
|
@cached_property
|
|
def tabs(self):
|
|
return [
|
|
{
|
|
'id': f'{self.id}_{i}',
|
|
'title': group.name,
|
|
'fields': group.items,
|
|
} for i, group in enumerate(self.groups, start=1)
|
|
]
|
|
|
|
|
|
class M2MAddRemoveFields:
|
|
"""
|
|
Represents an add/remove field pair for a many-to-many relationship. Rather than rendering
|
|
a single multi-select pre-populated with all current values (which can crash the browser for
|
|
large datasets), this renders two fields: one for adding new relations and one for removing
|
|
existing relations.
|
|
|
|
Parameters:
|
|
name: The name of the M2M field on the model (e.g. 'asns'). The form must define
|
|
corresponding 'add_{name}' and 'remove_{name}' fields.
|
|
"""
|
|
def __init__(self, name):
|
|
self.name = name
|
|
|
|
|
|
class ObjectAttribute:
|
|
"""
|
|
Renders the value for a specific attribute on the form's instance. This may be used to
|
|
display a read-only value and convey additional context to the user. If the attribute has
|
|
a `get_absolute_url()` method, it will be rendered as a hyperlink.
|
|
|
|
Parameters:
|
|
name: The name of the attribute to be displayed
|
|
"""
|
|
def __init__(self, name):
|
|
self.name = name
|