Skip to content

Adds hide-if-unset to custom field #12723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 30, 2023
Merged

Adds hide-if-unset to custom field #12723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
49e4704
adds hide-if-unset to custom field #12597
abhi1693 May 25, 2023
d8915b6
moved hide logic from template to python
abhi1693 May 26, 2023
982dabd
fix indentation
abhi1693 May 26, 2023
2ee5b72
Update logic for omit_hidden under get_custom_fields()
jeremystretch May 26, 2023
ca72754
Update docs
jeremystretch May 26, 2023
0aa495d
Account for False values
jeremystretch May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/models/extras/customfield.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,12 @@ Defines how filters are evaluated against custom field values.

Controls how and whether the custom field is displayed within the NetBox user interface.

| Option | Description |
|------------|--------------------------------------|
| Read/write | Display and permit editing (default) |
| Read-only | Display field but disallow editing |
| Hidden | Do not display field in the UI |
| Option | Description |
|-------------------|--------------------------------------------------|
| Read/write | Display and permit editing (default) |
| Read-only | Display field but disallow editing |
| Hidden | Do not display field in the UI |
| Hidden (if unset) | Display in the UI only when a value has been set |

### Default

Expand Down
2 changes: 2 additions & 0 deletions netbox/extras/choices.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,13 @@ class CustomFieldVisibilityChoices(ChoiceSet):
VISIBILITY_READ_WRITE = 'read-write'
VISIBILITY_READ_ONLY = 'read-only'
VISIBILITY_HIDDEN = 'hidden'
VISIBILITY_HIDDEN_IFUNSET = 'hidden-ifunset'

CHOICES = (
(VISIBILITY_READ_WRITE, 'Read/Write'),
(VISIBILITY_READ_ONLY, 'Read-only'),
(VISIBILITY_HIDDEN, 'Hidden'),
(VISIBILITY_HIDDEN_IFUNSET, 'Hidden (if unset)'),
)


Expand Down
12 changes: 9 additions & 3 deletions netbox/netbox/models/features.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,15 @@ def get_custom_fields(self, omit_hidden=False):
data = {}

for field in CustomField.objects.get_for_model(self):
value = self.custom_field_data.get(field.name)

# Skip fields that are hidden if 'omit_hidden' is set
if omit_hidden and field.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_HIDDEN:
continue
if omit_hidden:
if field.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_HIDDEN:
continue
if field.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_HIDDEN_IFUNSET and not value:
continue

value = self.custom_field_data.get(field.name)
data[field] = field.deserialize(value)

return data
Expand All @@ -227,6 +231,8 @@ def get_custom_fields_by_group(self):

for cf in visible_custom_fields:
value = self.custom_field_data.get(cf.name)
if value in (None, []) and cf.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_HIDDEN_IFUNSET:
continue
value = cf.deserialize(value)
groups[cf.group_name][cf] = value

Expand Down