starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-13 22:03:32 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Create custom form field for choice-based filters #1535

New Issue
Closed
opened 2025-12-29 16:32:46 +01:00 by adam · 0 comments
adam commented 2025-12-29 16:32:46 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Feb 6, 2018).

Issue type

[x] Feature request
[ ] Bug report
[ ] Documentation

Environment

  • Python version: 3.5.2
  • NetBox version: 2.2.9

Description

NetBox currently employs custom functions to generate the options for choice-based fields in filter forms. For example, the following is for site status selection:

def site_status_choices():
    status_counts = {}
    for status in Site.objects.values('status').annotate(count=Count('status')).order_by('status'):
        status_counts[status['status']] = status['count']
    return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in SITE_STATUS_CHOICES]

class SiteFilterForm(BootstrapMixin, CustomFieldFilterForm):
    model = Site
    status = forms.MultipleChoiceField(choices=site_status_choices, required=False)
    ...

The logic used to calculate and attach the count of each option is replicated in the same manner for several fields. We should be able to devise a simple custom form field that can be re-used without duplicating this boilerplate code.

Originally created by @jeremystretch on GitHub (Feb 6, 2018). ### Issue type [x] Feature request <!-- An enhancement of existing functionality --> [ ] Bug report <!-- Unexpected or erroneous behavior --> [ ] Documentation <!-- A modification to the documentation --> ### Environment * Python version: 3.5.2 * NetBox version: 2.2.9 ### Description NetBox currently employs custom functions to generate the options for choice-based fields in filter forms. For example, the following is for site status selection: ```python def site_status_choices(): status_counts = {} for status in Site.objects.values('status').annotate(count=Count('status')).order_by('status'): status_counts[status['status']] = status['count'] return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in SITE_STATUS_CHOICES] class SiteFilterForm(BootstrapMixin, CustomFieldFilterForm): model = Site status = forms.MultipleChoiceField(choices=site_status_choices, required=False) ... ``` The logic used to calculate and attach the count of each option is replicated in the same manner for several fields. We should be able to devise a simple custom form field that can be re-used without duplicating this boilerplate code.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 16:32:46 +01:00
adam closed this issue 2025-12-29 16:32:46 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1535
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?