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 warning about reserved names for scripts #5999

New Issue
Closed
opened 2025-12-29 19:35:34 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:35:34 +01:00
Owner
Copy Link

Originally created by @hagbarddenstore on GitHub (Jan 25, 2022).

Change Type

Addition

Area

Functionality/features

Proposed Changes

The custom scripts documentation should mention that a script can't be named the same as one of the built-in applications since it might clash in quite odd ways.

Example, if you name your script circuits.py and work on models in the circuits application, whenever you try to save one of those models, you'll get an error An exception occurred: SerializerNotFound: Could not determine serializer for circuits.Circuit with prefix ''.

The fix is to rename the script to something other than circuits.py.

Originally created by @hagbarddenstore on GitHub (Jan 25, 2022). ### Change Type Addition ### Area Functionality/features ### Proposed Changes The custom scripts documentation should mention that a script can't be named the same as one of the built-in applications since it might clash in quite odd ways. Example, if you name your script `circuits.py` and work on models in the `circuits` application, whenever you try to save one of those models, you'll get an error `An exception occurred: SerializerNotFound: Could not determine serializer for circuits.Circuit with prefix ''`. The fix is to rename the script to something other than `circuits.py`.
adam added the type: documentation label 2025-12-29 19:35:34 +01:00
adam closed this issue 2025-12-29 19:35:35 +01:00
adam commented 2025-12-29 19:35:35 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 25, 2022):

The custom scripts documentation should mention that a script can't be named the same as one of the built-in applications since it might clash in quite odd ways.

This is nothing unique to NetBox: Such is the case with any Python module. (For example, you also cannot name your script django.) I appreciate the suggestions, however keeping our documentation limited in scope is crucial to their long-term maintainability, so I'm going to decline.

@jeremystretch commented on GitHub (Jan 25, 2022): > The custom scripts documentation should mention that a script can't be named the same as one of the built-in applications since it might clash in quite odd ways. This is nothing unique to NetBox: Such is the case with _any_ Python module. (For example, you also cannot name your script `django`.) I appreciate the suggestions, however keeping our documentation limited in scope is crucial to their long-term maintainability, so I'm going to decline.
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 type: documentation
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#5999
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?