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

Custom Script StringVar is not JSON serializable #9736

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

Originally created by @willikubny on GitHub (May 24, 2024).

Deployment Type

Self-hosted

NetBox Version

v4.0.3

Python Version

3.11

Steps to Reproduce

With a StringVar or TextVar as input variable in a NetBox custom script the script is working through the UI, but fails to view through the REST API browser or get/execute with the REST API.

If the StringVar is removed from the NetBox custom script, then the REST API works fine again.

Expected Behavior

StringVar or TextVar in NetBox custom script should be serialized correctly.

Observed Behavior

<class 'TypeError'>

Object of type StringVar is not JSON serializable

Python version: 3.11.6
NetBox version: 4.0.3
Plugins:
netbox_device_support_plugin: 1.0.5
netbox_napalm_plugin: 0.2.0

Originally created by @willikubny on GitHub (May 24, 2024). ### Deployment Type Self-hosted ### NetBox Version v4.0.3 ### Python Version 3.11 ### Steps to Reproduce With a StringVar or TextVar as input variable in a NetBox custom script the script is working through the UI, but fails to view through the REST API browser or get/execute with the REST API. If the StringVar is removed from the NetBox custom script, then the REST API works fine again. ### Expected Behavior StringVar or TextVar in NetBox custom script should be serialized correctly. ### Observed Behavior <class 'TypeError'> Object of type StringVar is not JSON serializable Python version: 3.11.6 NetBox version: 4.0.3 Plugins: netbox_device_support_plugin: 1.0.5 netbox_napalm_plugin: 0.2.0
adam closed this issue 2025-12-29 21:21:53 +01:00
adam commented 2025-12-29 21:21:53 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 24, 2024):

Thank you for opening a bug report. Unfortunately, the information you have provided is not sufficient for someone else to attempt to reproduce the reported behavior. Remember, each bug report must include detailed steps that someone else can follow on a clean, empty NetBox installation to reproduce the exact problem you're experiencing. These instructions should include the creation of any involved objects, any configuration changes, and complete accounting of the actions being taken. Also be sure that your report does not reference data on the public NetBox demo, as that is subject to change at any time by an outside party and cannot be relied upon for bug reports.

@jeremystretch commented on GitHub (May 24, 2024): Thank you for opening a bug report. Unfortunately, the information you have provided is not sufficient for someone else to attempt to reproduce the reported behavior. Remember, each bug report must include detailed steps that someone else can follow on a clean, empty NetBox installation to reproduce the exact problem you're experiencing. These instructions should include the creation of any involved objects, any configuration changes, and complete accounting of the actions being taken. Also be sure that your report does not reference data on the public NetBox demo, as that is subject to change at any time by an outside party and cannot be relied upon for bug reports.
adam commented 2025-12-29 21:21:54 +01:00
Author
Owner
Copy Link

@willikubny commented on GitHub (May 24, 2024):

Sorry for opening a wrong bug. I found my mistake...

I've named the input StringVar variable "description" and that caused the issue. After naming the variable ap_description it's working.

Thank you anyway for your fast response.
Keep up the good work as NetBox is a great product.

@willikubny commented on GitHub (May 24, 2024): Sorry for opening a wrong bug. I found my mistake... I've named the input StringVar variable "description" and that caused the issue. After naming the variable ap_description it's working. Thank you anyway for your fast response. Keep up the good work as NetBox is a great product.
adam commented 2025-12-29 21:21:54 +01:00
Author
Owner
Copy Link

@llamafilm commented on GitHub (Jul 1, 2024):

I just found this same issue! Took me awhile to figure this out. I would say this is a bug. To reproduce, create a custom script with the following contents. It runs fine in the UI, but /api/extras/scripts throws the exception as the OP described. Renaming the description variable makes it work.

Another effect of this issue is that when creating an Event Rule, the custom script dropdown list is empty.

from extras.scripts import Script, StringVar

class AddDevice(Script):

    class Meta:
        name = "Add Device"

    description = StringVar()

    def run(self, data, commit):
        self.log_debug(data)
        return
@llamafilm commented on GitHub (Jul 1, 2024): I just found this same issue! Took me awhile to figure this out. I would say this is a bug. To reproduce, create a custom script with the following contents. It runs fine in the UI, but /api/extras/scripts throws the exception as the OP described. Renaming the `description` variable makes it work. Another effect of this issue is that when creating an Event Rule, the custom script dropdown list is empty. ```py from extras.scripts import Script, StringVar class AddDevice(Script): class Meta: name = "Add Device" description = StringVar() def run(self, data, commit): self.log_debug(data) return ```
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
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#9736
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?