NetBoxModelCSVForm required does not allow optional parameters #6530

New Issue

adam · 2025-12-29T19:42:01+01:00

adam commented

2025-12-29 19:42:01 +01:00

Originally created by @dainok on GitHub (Jun 3, 2022).

NetBox version

v3.2.3

Python version

3.8

Steps to Reproduce

I'm developing a NetBox plugin, with CSV import feature. I realized that using NetBoxModelCSVForm I have two options:

Using required=true makes the field mandatory (blank value not allowed)
Using required=false makes the filed forbidden (the value cannot be filled).
The CSV Import cannot be used to fill optional values (used by some objects).
Before trying to figure out how to patch it, I would like to know what is the best approach.

Mine is:

introduce a new attribute (optional, default is false)
if required and optional are true, the attribute can be filed, and a blank value is accepted
if required is true and optional is false, the attribute is mandatory and a blank value is not accepted
if required is false, optional is ignored, the attribute is ignored (it's not even mentioned in the HTML page).

Steps to reproduce:

Create a form using NetBoxModelCSVForm
create a field named optional and set required=false
try to import using a blank optional value

Expected Behavior

Data should be imported with blank values.

Observed Behavior

The post return the following error: Row 1: Expected 1 columns but found 4

Originally created by @dainok on GitHub (Jun 3, 2022). ### NetBox version v3.2.3 ### Python version 3.8 ### Steps to Reproduce I'm developing a NetBox plugin, with CSV import feature. I realized that using NetBoxModelCSVForm I have two options: 1. Using required=true makes the field mandatory (blank value not allowed) 2. Using required=false makes the filed forbidden (the value cannot be filled). The CSV Import cannot be used to fill optional values (used by some objects). Before trying to figure out how to patch it, I would like to know what is the best approach. Mine is: 1. introduce a new attribute (optional, default is false) 2. if required and optional are true, the attribute can be filed, and a blank value is accepted 3. if required is true and optional is false, the attribute is mandatory and a blank value is not accepted 4. if required is false, optional is ignored, the attribute is ignored (it's not even mentioned in the HTML page). Steps to reproduce: 1. Create a form using NetBoxModelCSVForm 6. create a field named optional and set required=false 7. try to import using a blank optional value ### Expected Behavior Data should be imported with blank values. ### Observed Behavior The post return the following error: Row 1: Expected 1 columns but found 4

adam closed this issue

2025-12-29 19:42:01 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#6530