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

get_field_value() does not recognize null field values on bound forms #10955

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

Originally created by @jeremystretch on GitHub (Mar 27, 2025).

Originally assigned to: @jeremystretch on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.2.6

Python Version

3.10

Steps to Reproduce

This was uncovered while using the get_field_value() utility function for dynamic form rendering. A simple proof is provided below.

from django import forms
from dcim.models import Site
from utilities.forms.utils import get_field_value

class MyForm(forms.Form):
    site = forms.ModelChoiceField(
        queryset=Site.objects.all(),
        required=False
    )

form = MyForm({'site': None}, initial={'site': 1})
get_field_value(form, 'site')

Expected Behavior

The function should always return the value of the field in a bound form.

Observed Behavior

When a null value is specified on a bound form, the function defers to the field's initial value:

>>> form = MyForm({'site': 2}, initial={'site': 1})
>>> get_field_value(form, 'site')
2
>>> form = MyForm({'site': None}, initial={'site': 1})
>>> get_field_value(form, 'site')
1
Originally created by @jeremystretch on GitHub (Mar 27, 2025). Originally assigned to: @jeremystretch on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.2.6 ### Python Version 3.10 ### Steps to Reproduce This was uncovered while using the [`get_field_value()`](https://github.com/netbox-community/netbox/blob/e1e514251e825fadfcc87a191502a931fa9edb5b/netbox/utilities/forms/utils.py#L132) utility function for dynamic form rendering. A simple proof is provided below. ```python from django import forms from dcim.models import Site from utilities.forms.utils import get_field_value class MyForm(forms.Form): site = forms.ModelChoiceField( queryset=Site.objects.all(), required=False ) form = MyForm({'site': None}, initial={'site': 1}) get_field_value(form, 'site') ``` ### Expected Behavior The function should always return the value of the field in a bound form. ### Observed Behavior When a null value is specified on a bound form, the function defers to the field's initial value: ```python >>> form = MyForm({'site': 2}, initial={'site': 1}) >>> get_field_value(form, 'site') 2 >>> form = MyForm({'site': None}, initial={'site': 1}) >>> get_field_value(form, 'site') 1 ```
adam added the type: bugstatus: acceptedseverity: medium labels 2025-12-29 21:38:22 +01:00
adam closed this issue 2025-12-29 21:38:22 +01:00
adam commented 2025-12-29 21:38:23 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Mar 27, 2025):

Just a quick thought: Could this be a case where plugins might rely on this behavior? If so, perhaps it would be safer to target the fix for v4.3 to minimize any potential disruptions.

@pheus commented on GitHub (Mar 27, 2025): Just a quick thought: Could this be a case where plugins might rely on this behavior? If so, perhaps it would be safer to target the fix for v4.3 to minimize any potential disruptions.
adam commented 2025-12-29 21:38:23 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 27, 2025):

Bug fixes always go in patch releases, as the intent is to correct unexpected behavior.

@jeremystretch commented on GitHub (Mar 27, 2025): Bug fixes always go in patch releases, as the intent is to correct unexpected behavior.
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 severity: medium status: accepted type: bug
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#10955
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?