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

Fix examples for type of class Meta() #11827

New Issue
Closed
opened 2025-12-29 21:50:22 +01:00 by adam · 1 comment
adam commented 2025-12-29 21:50:22 +01:00
Owner
Copy Link

Originally created by @grische on GitHub (Nov 12, 2025).

Originally assigned to: @grische on GitHub.

Change Type

Correction

Area

Customization

Proposed Changes

The current examples of using class Meta: should be class Meta(Script.Meta): to use the correct type when overriding.

See the error:

"Meta" overrides symbol of same name in class "BaseScript"
  "netbox.scripts.scripts.sample_script.MyScript.Meta" is not assignable to "netbox.extras.scripts.BaseScript.Meta"
  Type "type[netbox.scripts.scripts.sample_script.MyScript.Meta]" is not assignable to type "type[netbox.extras.scripts.BaseScript.Meta]"

from Pylance reportIncompatibleVariableOverride

The suggested change is:

diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md
index 936dfd868..15d6c81f0 100644
--- a/docs/customization/custom-scripts.md
+++ b/docs/customization/custom-scripts.md
@@ -95,7 +95,7 @@ An example fieldset definition is provided below:

 ```python
 class MyScript(Script):
-    class Meta:
+    class Meta(Script.Meta):
         fieldsets = (
             ('First group', ('field1', 'field2', 'field3')),
             ('Second group', ('field4', 'field5')),
@@ -510,7 +510,7 @@ from extras.scripts import *

 class NewBranchScript(Script):

-    class Meta:
+    class Meta(Script.Meta):
         name = "New Branch"
         description = "Provision a new branch site"
         field_order = ['site_name', 'switch_count', 'switch_model']

I have prepared the PR but I noticed that I needed to open an issue first.

Originally created by @grische on GitHub (Nov 12, 2025). Originally assigned to: @grische on GitHub. ### Change Type Correction ### Area Customization ### Proposed Changes The current examples of using `class Meta:` should be `class Meta(Script.Meta):` to use the correct type when overriding. See the error: ``` "Meta" overrides symbol of same name in class "BaseScript" "netbox.scripts.scripts.sample_script.MyScript.Meta" is not assignable to "netbox.extras.scripts.BaseScript.Meta" Type "type[netbox.scripts.scripts.sample_script.MyScript.Meta]" is not assignable to type "type[netbox.extras.scripts.BaseScript.Meta]" ``` from Pylance [reportIncompatibleVariableOverride](https://github.com/microsoft/pylance-release/blob/main/docs/diagnostics/reportIncompatibleVariableOverride.md) The suggested change is: ```diff diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index 936dfd868..15d6c81f0 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -95,7 +95,7 @@ An example fieldset definition is provided below: ```python class MyScript(Script): - class Meta: + class Meta(Script.Meta): fieldsets = ( ('First group', ('field1', 'field2', 'field3')), ('Second group', ('field4', 'field5')), @@ -510,7 +510,7 @@ from extras.scripts import * class NewBranchScript(Script): - class Meta: + class Meta(Script.Meta): name = "New Branch" description = "Provision a new branch site" field_order = ['site_name', 'switch_count', 'switch_model'] ``` I have prepared the PR but I noticed that I needed to open an issue first.
adam added the status: acceptedtype: documentationnetbox labels 2025-12-29 21:50:22 +01:00
adam closed this issue 2025-12-29 21:50:22 +01:00
adam commented 2025-12-29 21:50:22 +01:00
Author
Owner
Copy Link

@grische commented on GitHub (Nov 13, 2025):

@arthanson not sure if you missed my message above, but I have a PR ready, just need to be assigned the issue.

@grische commented on GitHub (Nov 13, 2025): @arthanson not sure if you missed my message above, but I have a PR ready, just need to be assigned the issue.
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 netbox status: accepted 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#11827
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?