RomanNum3ral
/
netbox
mirror of https://github.com/netbox-community/netbox.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Closes #22567: Warn that a custom script file name must not shadow an installed Python module (#22804)

This commit is contained in:
Jason Satein 2026-08-04 08:36:11 -07:00 committed by GitHub
parent bb29246033
commit c36e72876f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/customization/custom-scripts.md
View File

@ -23,6 +23,9 @@ Custom scripts are Python code which exists outside the NetBox code base, so the
## Writing Custom Scripts
!!! warning "Choose a unique file name"
A script file's name (without the `.py` extension) becomes its Python module name when the script is loaded. A script file must not share its name with a NetBox application (e.g. `circuits.py` or `dcim.py`) or any other installed Python module: the script will shadow that module in Python's import system and can break unrelated functionality. Choose a unique, descriptive file name, such as `circuit_maintenance.py`.
All custom scripts must inherit from the `extras.scripts.Script` base class. This class provides the functionality necessary to generate forms and log activity.
```python