Add django signals functionality to Plugins #7112

New Issue

adam · 2025-12-29T20:19:22+01:00

adam commented

2025-12-29 20:19:22 +01:00

Originally created by @Selfmade-RuLeZ on GitHub (Oct 15, 2022).

NetBox version

v3.3.5

Feature type

New functionality

Proposed functionality

Currently a developer has to copy the ready(self) function from PluginConfig to get signals running.
Developers should be able to use signals just out of the box with a signals.py file in the root of the plugin directory.

I tried to implement it myself and I will create a pull request as it's just two/three lines in __init__.py from extras.plugins.

from importlib import import_module

...

class PluginConfig(AppConfig):

...

    signals = 'signals'

    def ready(self):
        plugin_name = self.name.rsplit('.', 1)[-1]

        # import signals if defined
        import_module(f"{self.__module__}.{self.signals}")

...

Use case

Plugins could react to actions from the main part of NetBox.

Example:
Someone develops a YubiKey plugin and wants to associate a new YubiKey everytime someone adds a new Device.
This could be reached super handy by signals in django.

Database changes

No response

External dependencies

No response

Originally created by @Selfmade-RuLeZ on GitHub (Oct 15, 2022). ### NetBox version v3.3.5 ### Feature type New functionality ### Proposed functionality Currently a developer has to copy the `ready(self)` function from `PluginConfig` to get signals running. Developers should be able to use signals just out of the box with a `signals.py` file in the root of the plugin directory. I tried to implement it myself and I will create a pull request as it's just two/three lines in `__init__.py` from `extras.plugins`. ``` from importlib import import_module ... class PluginConfig(AppConfig): ... signals = 'signals' def ready(self): plugin_name = self.name.rsplit('.', 1)[-1] # import signals if defined import_module(f"{self.__module__}.{self.signals}") ... ``` ### Use case Plugins could react to actions from the main part of NetBox. Example: Someone develops a YubiKey plugin and wants to associate a new YubiKey everytime someone adds a new Device. This could be reached super handy by signals in django. ### Database changes _No response_ ### External dependencies _No response_

adam added the type: feature label 2025-12-29 20:19:22 +01:00

adam closed this issue

2025-12-29 20:19:23 +01:00

adam commented

2025-12-29 20:19:23 +01:00

@DanSheps commented on GitHub (Oct 18, 2022):

Currently a developer has to copy the ready(self) function from PluginConfig to get signals running.

def ready(self):
    super().ready()
    import_module(f"{self.__module__}.{self.signals}")

@DanSheps commented on GitHub (Oct 18, 2022): > Currently a developer has to copy the ready(self) function from PluginConfig to get signals running. ``` def ready(self): super().ready() import_module(f"{self.__module__}.{self.signals}") ```

adam commented

2025-12-29 20:19:24 +01:00

@Selfmade-RuLeZ commented on GitHub (Oct 18, 2022):

Oh, my fault. Sorry about that, was too late on this day and my last python project with inheritance was some time ago.

But to be honest, it would be more convenient in combination with the current documentation, that the Plugin imports the signal by itself the same way it does with the menu items.

I close this as the main purpose of this issue was solved. Thank you @DanSheps 😀

@Selfmade-RuLeZ commented on GitHub (Oct 18, 2022): Oh, my fault. Sorry about that, was too late on this day and my last python project with inheritance was some time ago. But to be honest, it would be more convenient in combination with the current documentation, that the Plugin imports the signal by itself the same way it does with the menu items. I close this as the main purpose of this issue was solved. Thank you @DanSheps 😀

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#7112