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

Add ability to filter for empty string values in an "OR" fashion #10281

New Issue
Closed
opened 2025-12-29 21:29:22 +01:00 by adam · 3 comments
adam commented 2025-12-29 21:29:22 +01:00
Owner
Copy Link

Originally created by @bctiemann on GitHub (Sep 23, 2024).

Originally assigned to: @bctiemann on GitHub.

NetBox version

v4.1.0

Feature type

New functionality

Proposed functionality

Currently we can filter a field on an empty string value using (for example) type__empty=true, using functionality present in BaseFilterSet.get_additional_lookups. However, this construct only allows us to apply filters with different keys in an "AND" fashion, i.e. type=foo and type__empty=true are treated as separate filter conditions that both must be true. Also this type of filter must be entered into the URL manually, it is not available in the standard FilterForm classes.

Proposal is to create a NullableMultipleChoiceFilter (patterned after the existing NullableCharFieldFilter) which treats '' as one of several possible values for the field, e.g. ['foo', 'bar', ''], any of which returns a result in the filter. This would also make it possible to add an "(unset)" option in the choices presented in a FilterForm, such that the user can select all the applicable values from the dropdown and search them all at once.

Use case

It is cumbersome and obscure to use the bespoke lookups we currently support, such as type__empty, and it lacks flexibility. With this change, a user might select 2 or 3 different values in a multiple-choice filter input in the FilterForm, including the "empty" (unset) value (which would follow the system configurable settings.FILTERS_NULL_CHOICE_VALUE).

Note that this change is narrowly targeted at matching the empty string ''; it does not address any similar treatment of other programmatically generated additional lookups (such as __gt, __iexact, etc). For that reason this might be a low-priority use case or even contribute to a pattern inconsistency. However this also might be thought of as a building block to more rich filter inputs of a similar kind later.

Database changes

N/A

External dependencies

N/A

Originally created by @bctiemann on GitHub (Sep 23, 2024). Originally assigned to: @bctiemann on GitHub. ### NetBox version v4.1.0 ### Feature type New functionality ### Proposed functionality Currently we can filter a field on an empty string value using (for example) `type__empty=true`, using functionality present in `BaseFilterSet.get_additional_lookups`. However, this construct only allows us to apply filters with different keys in an "AND" fashion, i.e. `type=foo` and `type__empty=true` are treated as separate filter conditions that both must be true. Also this type of filter must be entered into the URL manually, it is not available in the standard FilterForm classes. Proposal is to create a `NullableMultipleChoiceFilter` (patterned after the existing `NullableCharFieldFilter`) which treats `''` as one of several possible values for the field, e.g. `['foo', 'bar', '']`, any of which returns a result in the filter. This would also make it possible to add an "(unset)" option in the choices presented in a FilterForm, such that the user can select all the applicable values from the dropdown and search them all at once. ### Use case It is cumbersome and obscure to use the bespoke lookups we currently support, such as `type__empty`, and it lacks flexibility. With this change, a user might select 2 or 3 different values in a multiple-choice filter input in the FilterForm, including the "empty" (unset) value (which would follow the system configurable `settings.FILTERS_NULL_CHOICE_VALUE`). Note that this change is narrowly targeted at matching the empty string `''`; it does not address any similar treatment of other programmatically generated additional lookups (such as `__gt`, `__iexact`, etc). For that reason this might be a low-priority use case or even contribute to a pattern inconsistency. However this also might be thought of as a building block to more rich filter inputs of a similar kind later. ### Database changes N/A ### External dependencies N/A
adam added the type: featurestatus: blockednetboxcomplexity: low labels 2025-12-29 21:29:22 +01:00
adam closed this issue 2025-12-29 21:29:22 +01:00
adam commented 2025-12-29 21:29:23 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 16, 2024):

Marking this as blocked by #17761 temporarily.

@jeremystretch commented on GitHub (Oct 16, 2024): Marking this as blocked by #17761 temporarily.
adam commented 2025-12-29 21:29:23 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 22, 2024):

With the completion of #17761 for the upcoming v4.2 release, I think this work is no longer needed. @bctiemann can you confirm?

@jeremystretch commented on GitHub (Oct 22, 2024): With the completion of #17761 for the upcoming v4.2 release, I think this work is no longer needed. @bctiemann can you confirm?
adam commented 2025-12-29 21:29:24 +01:00
Author
Owner
Copy Link

@bctiemann commented on GitHub (Oct 22, 2024):

I think that's right. I'll close my PR and we can close this too.

@bctiemann commented on GitHub (Oct 22, 2024): I think that's right. I'll close my PR and we can close this too.
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 complexity: low netbox status: blocked type: feature
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#10281
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?