NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-26 09:16:10 -06:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Avoid catching ImportErrors when loading plugin resources

Browse Source
This commit is contained in:
jeremystretch 2023-01-24 17:13:25 -05:00
parent a702a29c6f
commit 20afe926f6
1 changed files with 36 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
netbox/extras/plugins/__init__.py
View File

@ -1,4 +1,5 @@
import collections import collections
from importlib.util import find_spec
from django.apps import AppConfig from django.apps import AppConfig
from django.conf import settings from django.conf import settings
@ -21,6 +22,15 @@ registry['plugins'] = {
'template_extensions': collections.defaultdict(list), 'template_extensions': collections.defaultdict(list),
} }
DEFAULT_RESOURCE_PATHS = {
'search_indexes': 'search.indexes',
'graphql_schema': 'graphql.schema',
'menu': 'navigation.menu',
'menu_items': 'navigation.menu_items',
'template_extensions': 'template_content.template_extensions',
'user_preferences': 'preferences.preferences',
}
# #
# Plugin AppConfig class # Plugin AppConfig class
@ -58,58 +68,50 @@ class PluginConfig(AppConfig):
# Django apps to append to INSTALLED_APPS when plugin requires them. # Django apps to append to INSTALLED_APPS when plugin requires them.
django_apps = [] django_apps = []
# Default integration paths. Plugin authors can override these to customize the paths to # Optional plugin resources
# integrated components. search_indexes = None
search_indexes = 'search.indexes' graphql_schema = None
graphql_schema = 'graphql.schema' menu = None
menu = 'navigation.menu' menu_items = None
menu_items = 'navigation.menu_items' template_extensions = None
template_extensions = 'template_content.template_extensions' user_preferences = None
user_preferences = 'preferences.preferences'
def _load_resource(self, name):
# Import from the configured path, if defined.
if getattr(self, name):
return import_string(f"{self.__module__}.{self.name}")
# Fall back to the resource's default path. Return None if the module has not been provided.
default_path = DEFAULT_RESOURCE_PATHS[name]
default_module = f'{self.__module__}.{default_path}'.rsplit('.', 1)[0]
if find_spec(default_module):
setattr(self, name, default_path)
return import_string(f"{self.__module__}.{default_path}")
def ready(self): def ready(self):
plugin_name = self.name.rsplit('.', 1)[-1] plugin_name = self.name.rsplit('.', 1)[-1]
# Register search extensions (if defined) # Register search extensions (if defined)
try: search_indexes = self._load_resource('search_indexes') or []
search_indexes = import_string(f"{self.__module__}.{self.search_indexes}")
for idx in search_indexes: for idx in search_indexes:
register_search(idx) register_search(idx)
except ImportError:
pass
# Register template content (if defined) # Register template content (if defined)
try: if template_extensions := self._load_resource('template_extensions'):
template_extensions = import_string(f"{self.__module__}.{self.template_extensions}")
register_template_extensions(template_extensions) register_template_extensions(template_extensions)
except ImportError:
pass
# Register navigation menu and/or menu items (if defined) # Register navigation menu and/or menu items (if defined)
try: if menu := self._load_resource('menu'):
menu = import_string(f"{self.__module__}.{self.menu}")
register_menu(menu) register_menu(menu)
except ImportError: if menu_items := self._load_resource('menu_items'):
pass
try:
menu_items = import_string(f"{self.__module__}.{self.menu_items}")
register_menu_items(self.verbose_name, menu_items) register_menu_items(self.verbose_name, menu_items)
except ImportError:
pass
# Register GraphQL schema (if defined) # Register GraphQL schema (if defined)
try: if graphql_schema := self._load_resource('graphql_schema'):
graphql_schema = import_string(f"{self.__module__}.{self.graphql_schema}")
register_graphql_schema(graphql_schema) register_graphql_schema(graphql_schema)
except ImportError:
pass
# Register user preferences (if defined) # Register user preferences (if defined)
try: if user_preferences := self._load_resource('user_preferences'):
user_preferences = import_string(f"{self.__module__}.{self.user_preferences}")
register_user_preferences(plugin_name, user_preferences) register_user_preferences(plugin_name, user_preferences)
except ImportError:
pass
@classmethod @classmethod
def validate(cls, user_config, netbox_version): def validate(cls, user_config, netbox_version):