nautobot 2.4.21__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nautobot/extras/plugins/__init__.py

@@ -5,9 +5,10 @@ import inspect
 from logging import getLogger
 
 from django.conf import settings
+from django.conf.urls import include
 from django.core.exceptions import ValidationError
 from django.template.loader import get_template
-from django.urls import get_resolver, URLPattern
+from django.urls import clear_url_caches, get_resolver, path, URLPattern
 from packaging import version
 
 from nautobot.core.apps import (
@@ -17,10 +18,9 @@ from nautobot.core.apps import (
     register_menu_items,
 )
 from nautobot.core.signals import nautobot_database_ready
-from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
+from nautobot.core.utils.module_loading import import_string_optional
 from nautobot.extras.choices import BannerClassChoices
 from nautobot.extras.plugins.exceptions import PluginImproperlyConfigured
-from nautobot.extras.plugins.utils import import_object
 from nautobot.extras.registry import register_datasource_contents, registry
 from nautobot.extras.secrets import register_secrets_provider
 
@@ -105,9 +105,24 @@ class NautobotAppConfig(NautobotConfig):
         """Callback after plugin app is loaded."""
         # We don't call super().ready here because we don't need or use the on-ready behavior of a core Nautobot app
 
+        from nautobot.extras.plugins.urls import BASE_URL_TO_APP_LABEL, plugin_api_patterns, plugin_patterns
+
         # Introspect URL patterns and models to make available to the installed-plugins detail UI view.
-        urlpatterns = import_object(f"{self.__module__}.urls.urlpatterns")
-        api_urlpatterns = import_object(f"{self.__module__}.api.urls.urlpatterns")
+        urlpatterns = import_string_optional(f"{self.__module__}.urls.urlpatterns")
+        api_urlpatterns = import_string_optional(f"{self.__module__}.api.urls.urlpatterns")
+
+        base_url = self.base_url or self.label
+
+        if urlpatterns is not None:
+            plugin_patterns.append(path(f"{base_url}/", include((urlpatterns, self.label))))
+
+        if api_urlpatterns is not None:
+            plugin_api_patterns.append(path(f"{base_url}/", include((api_urlpatterns, f"{self.label}-api"))))
+
+        if any([urlpatterns, api_urlpatterns]):
+            clear_url_caches()
+
+        BASE_URL_TO_APP_LABEL[base_url] = self.label
 
         self.features = {
             "api_urlpatterns": sorted(
@@ -123,36 +138,31 @@ class NautobotAppConfig(NautobotConfig):
         }
 
         # Register banner function (if defined)
-        banner_function = import_object(f"{self.__module__}.{self.banner_function}")
-        if banner_function is not None:
+        if banner_function := import_string_optional(f"{self.__module__}.{self.banner_function}"):
             register_banner_function(banner_function)
             self.features["banner"] = True
 
         # Register model validators (if defined)
-        validators = import_object(f"{self.__module__}.{self.custom_validators}")
-        if validators is not None:
+        if validators := import_string_optional(f"{self.__module__}.{self.custom_validators}"):
             register_custom_validators(validators)
             self.features["custom_validators"] = sorted(set(validator.model for validator in validators))
 
         # Register datasource contents (if defined)
-        datasource_contents = import_object(f"{self.__module__}.{self.datasource_contents}")
-        if datasource_contents is not None:
+        if datasource_contents := import_string_optional(f"{self.__module__}.{self.datasource_contents}"):
             register_datasource_contents(datasource_contents)
             self.features["datasource_contents"] = datasource_contents
 
         # Register GraphQL types (if defined)
-        graphql_types = import_object(f"{self.__module__}.{self.graphql_types}")
-        if graphql_types is not None:
+        if graphql_types := import_string_optional(f"{self.__module__}.{self.graphql_types}"):
             register_graphql_types(graphql_types)
 
         # Import jobs (if present)
         # Note that we do *not* auto-call `register_jobs()` - the App is responsible for doing so when imported.
-        jobs = import_object(f"{self.__module__}.{self.jobs}")
-        if jobs is not None:
+        if jobs := import_string_optional(f"{self.__module__}.{self.jobs}"):
             self.features["jobs"] = jobs
 
         # Import metrics (if present)
-        metrics = import_object(f"{self.__module__}.{self.metrics}")
+        metrics = import_string_optional(f"{self.__module__}.{self.metrics}")
         if metrics is not None and self.name not in settings.METRICS_DISABLED_APPS:
             register_metrics(metrics)
             self.features["metrics"] = []  # Initialize as empty, to be filled by the signal handler
@@ -161,19 +171,16 @@ class NautobotAppConfig(NautobotConfig):
             nautobot_database_ready.connect(signal_callback, sender=self)
 
         # Register plugin navigation menu items (if defined)
-        menu_items = import_object(f"{self.__module__}.{self.menu_items}")
-        if menu_items is not None:
+        if menu_items := import_string_optional(f"{self.__module__}.{self.menu_items}"):
             register_plugin_menu_items(self.verbose_name, menu_items)
             self.features["nav_menu"] = menu_items
 
-        homepage_layout = import_object(f"{self.__module__}.{self.homepage_layout}")
-        if homepage_layout is not None:
+        if homepage_layout := import_string_optional(f"{self.__module__}.{self.homepage_layout}"):
             register_homepage_panels(self.path, self.label, homepage_layout)
             self.features["home_page"] = homepage_layout
 
         # Register template content (if defined)
-        template_extensions = import_object(f"{self.__module__}.{self.template_extensions}")
-        if template_extensions is not None:
+        if template_extensions := import_string_optional(f"{self.__module__}.{self.template_extensions}"):
             register_template_extensions(template_extensions)
             self.features["template_extensions"] = sorted(set(extension.model for extension in template_extensions))
 
@@ -185,15 +192,13 @@ class NautobotAppConfig(NautobotConfig):
             pass
 
         # Register secrets providers (if any)
-        secrets_providers = import_object(f"{self.__module__}.{self.secrets_providers}")
-        if secrets_providers is not None:
+        if secrets_providers := import_string_optional(f"{self.__module__}.{self.secrets_providers}"):
             for secrets_provider in secrets_providers:
                 register_secrets_provider(secrets_provider)
             self.features["secrets_providers"] = secrets_providers
 
         # Register custom filters (if any)
-        filter_extensions = import_object(f"{self.__module__}.{self.filter_extensions}")
-        if filter_extensions is not None:
+        if filter_extensions := import_string_optional(f"{self.__module__}.{self.filter_extensions}"):
             register_filter_extensions(filter_extensions, self.name)
             self.features["filter_extensions"] = {"filterset_fields": [], "filterform_fields": []}
             for filter_extension in filter_extensions:
@@ -207,8 +212,7 @@ class NautobotAppConfig(NautobotConfig):
                     )
 
         # Register override view (if any)
-        override_views = import_object(f"{self.__module__}.{self.override_views}")
-        if override_views is not None:
+        if override_views := import_string_optional(f"{self.__module__}.{self.override_views}"):
             for qualified_view_name, view in override_views.items():
                 view_class_name = view.view_class.__name__ if hasattr(view, "view_class") else view.cls.__name__
                 self.features.setdefault("overridden_views", []).append(
@@ -272,17 +276,11 @@ class NautobotAppConfig(NautobotConfig):
 
     def _register_table_extensions(self):
         """Register tables extensions (if any)."""
-        table_extensions = import_object(f"{self.__module__}.{self.table_extensions}")
-        if table_extensions is not None:
+        if table_extensions := import_string_optional(f"{self.__module__}.{self.table_extensions}"):
             register_table_extensions(table_extensions, self.name)
             self.features["table_extensions"] = get_table_extension_features(table_extensions)
 
 
-@class_deprecated_in_favor_of(NautobotAppConfig)
-class PluginConfig(NautobotAppConfig):
-    pass
-
-
 #
 # Template content injection
 #
@@ -413,11 +411,6 @@ class TemplateExtension:
         raise NotImplementedError
 
 
-@class_deprecated_in_favor_of(TemplateExtension)
-class PluginTemplateExtension(TemplateExtension):
-    pass
-
-
 def register_template_extensions(class_list):
     """
     Register a list of TemplateExtension classes
@@ -444,11 +437,6 @@ class Banner:
         self.banner_class = banner_class
 
 
-@class_deprecated_in_favor_of(Banner)
-class PluginBanner(Banner):
-    pass
-
-
 def register_banner_function(function):
     """
     Register a function that may return a Banner object.
@@ -494,11 +482,6 @@ class FilterExtension:
     filterform_fields = {}
 
 
-@class_deprecated_in_favor_of(FilterExtension)
-class PluginFilterExtension(FilterExtension):
-    pass
-
-
 def register_filter_extensions(filter_extensions, plugin_name):
     """
     Register a list of FilterExtension classes
@@ -789,11 +772,6 @@ class CustomValidator:
         raise NotImplementedError
 
 
-@class_deprecated_in_favor_of(CustomValidator)
-class PluginCustomValidator(CustomValidator):
-    pass
-
-
 def register_custom_validators(class_list):
     """
     Register a list of CustomValidator classes

nautobot/extras/plugins/marketplace_manifest.yml

@@ -112,29 +112,7 @@
   "availability": "Open Source"
   "icon": >-
     data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAACXBIWXMAAAHjAAAB4wGoU74kAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAC9tJREFUeJztmnt8VdWVx79rn3sveRMIAUIABwrRVFCBJCLQ8YGiFTra4uhHp+NYOxoHaxWmdnQqpAlaR6e+PyIiH6ztYPkolJkxVMABH0gH0CCVR1AxSDQJ4ZX3855z1vxxQm5uGzD35obM51N+f51z9t7rddZea++1t6gqf8kw/S1Af+OsAfpbgP7GWQP0twD9Dd+ZYCKFBLCZgeEylBxgIkoGgtXRxQGqgN0IHwJvY9iqBbT3uWx9mQalkCwc7gFuBtIA/BbYDiCQnuDxPtosAPgMBJ3O4ceAVSjP6mI+6zMZ+8IA8hCjEB5DuAkw2enK3GyXzBRl/nofQ+KVlXNtstM93nuPCN9f6+NYs/DLWTaHG4Q1pYb9xwTAQVmF8i/6MBUxlzXWBpBFzAMeA5KuGuty31SH3EylOQjTV/g53iIU3xLkgqHhfPceEa5d6SctQdn6wyDxPthRITz1vxabDhqABuCnWsTSmMobKwNIIQk4vALcMCZVeXyWw6XnuJ3tT2+z+MUWi8evtLltktstjRU7LR7YZLHoUocf5YXmwttfGH660eJQnQC8RiO36ZO0xETuWBhAHmQQAYpRpn032+WJWTZJgVB7XRvkLgswOF7Z8oMgfqt7OkHH85K6VuGDO9tJGRBqa2iHBRt8/Nd+A7CVIN/RR6nprey9ToNSSAJ+3kCZdu9Uh6Wzw5UHWL3PorYVFlzinFJ58ALkP09zqGmFtaXhoiUHYNkcmx9f7ABMJ8B6uZ/E3srfqzQogrCQV4Hp8y9xeHCGE9YedKG6SXhllyHBD/F+WF1qQKEp2IUOkOAHEUj0Q5wFr3xsMesbSnqi4jOd/Hjorx2MwNPbrDzi+Y0Ic1WJ2o17NQVkEQuAJ2483+Wpq212VBh2VAglVcK+I0JFo9DbGWYZyExWJgxV8jKV3BEuk4Yr97zpY41nzPt0Mc9ErUO0BpCFfANhzzmpGpeToWw6aKht9doCPvjmEGVsqlLbLmwuE34yzWHmGJe0BE+p5EA437o2wXHheDO8VWZ4epvFzDEuiQEoqxH2HxPsjtiZnqhcPU557wuhvE5asJigBZRFo0f0U0B4DogrrxPK64SLhinXjneZPtrlgqFKoINyfrEPI0J+jsPAAacmlxrnGWTsIBiX5vDsdotB8bBktg1Aiw27qoQt5YbiTw3/8UeDMYAQj8uTwPVRqRGNB0ghF2HzEQKzs1wemO5w7pDu6Ux60c/AAfDObcFu20+Fb73sp7kdSvK7H7ezSnhki8WWQ53BMkeLKImICdFmAZufYMASuGqsy7jB3Stf0woV9UJuZuRGzhuhfFkv1LZ13z4hXZk5poOuAMq9ETMhCg+QQlJwqJo0XBOqm6CyQRiTqtzwTZc5WS7Z6YpVV0bg4HqqG+GZ7RbXjneZMToyPlsOCW8eMNx7scOwJKFt/PewE4bxcbVQ/Knh9X2GqgYhK01J9MNHh6UJi+FaQGPfGqCAm1BWPXG1zXXnurxUYrFil+Fok7ehGRwPy+IXMLfuqYjofh2eHvQ8BQ3zqO/wiJHJSn6uy60XOry2x3D/Wz4QbtBC1kRCN5ogeDnA5X+lpAzwFi73TXXY9pVh4+fCB5WGqurul7q9waFa5fwMJS/T5dvjvFQons25bEznT7wc+toALrmZA5WRKSHPsQxMH+0yfTSAQ/xmB3ZFTPm0+PllDu2Tug+I5wxUMpKVqka5OFK6kRtAyBp/iqB3ElbHnyFhCFzxiPfc3gAHNkDZW977zF9ATRnsXA5xqXDlY7Dun7wxMx6E5BFQsR22PwduMETzFBifplQ1yLmRqhNRFpBCDJA0KqWHAwLJMOVOOPQuNB6GuSvhoh94bRNvgdkvwLALwZ/g9UNgzlJIzoDSNZB+PvjiesRqVDIAyR0y9hiReoABSB4QYVor/R3YrWC3QU4+7HrZ+35wE8x+Hl6/qUtngYR0r/+G+Z7n9ABdZDJAj4PQmS2KNlRCfFrofevjnpdM/mHoW3E+VO30ps59h2DohB6RNl8zRU45LqLee71dV1MwSm7jroHqj0Pvrg2//xF862ehbxlT4N0ieGEinDgAY67oEenG9k6ZIkpBEU0BfQ1HFtFW3chpVvXd4JZ1MHA0qAO//ZvwtvItsLtLbJh0O1z/KzjxGQwaC2X/0yMWh73lT6sW9KEBOlB24IRk96hnQyUsy/Ge2+qg9gvvrwO8+h2oPeg9v3kv7Hge1IXX/xaGToTEdM9bmo/1iNWBEwLKgQh1icoAH5XVSHZNCwyK775Diy3EAzhtUHWK/cmR3aHn9obwfl3bOmmeWqDjzXCwVkAiX31EHgSFd1yF98tDQ5uC8N+fGO5e5yPvJT+//vg0da8oUfSuxYwVfuav97Hhc0NbF4O8d8h4hRdhc6R0I/cAwzocnLX7jZUzQnl2u2HlHovWoFeyGj9YkVGX0F61HKM2tusdeFgRmtpx6RzrSIDUzIkEa2DlbsPK3YbkANw+2WFejsNar1BqY3gzUnWiqwcsYoPfx6wEy6v4Ts5Qbp7gcM04ZVhSiN6RJmHCEj935TgUXe6chuKf46HNFstKLPbMCzI0MUTzq3pvN/jbPYbSo8LwJOV4sxB0Wa9FfDtSXaKrCCnPBW1mNTjw6+/aXDOu+8CbnqAMioOdVQbv+K/nKKkyDI4PHZ+dxMgU5a4ch/wpDq/uMczf4DuZ+KKqC0a3EHqYdcARV+HJbRZ/+LL7dYEI5Ga67KqWsDn7dWixYXe1kJfpdu74usJVr2649AMLvLlfrotZH40qUXmAKiqLuBF454+HhetX+RmVoszJcpk2WsnJ8IqfAHmZysbP4aPDwtSRPZtuJZWGdoew/ocbhZJK4b1yw+8/E6obxasJguJyczR6QG/L4gUsRcmfOlKpbIDyutDvGpmijB3s1QyKPzHMHOty+ySXtHjtqAqHAmPQ8TJJ0IHjLcLynYZ3vzDMyXKpbfVy/OHGEO2sNGVoArzved4SLeLuqHXolQEWEE8i2yyLC5bNsRmfpuyoED6sNOw7IpTVCo29POFPjYOxg7xzgZwRLrmZyp5qIb/Yh+uyCx+XaAGtUevQ27NBKWQkDlsDPka/ONtmdlZ4QGxsh8fet3ixxOLRKx2yh7i4KrQ74HSw9hnwGzCi7Dtq+NdNFnfnOdw/zSHBH86v+FPDXet8tNtU4jJNH+ZQr+SPyeHoIs4HNlqGEQWXehG6a/D6sl6YutzP5AzljZtPXx6/fpWfDyuFbXcEGZkckk0VXvjQYvF7Fo5LJTBLi9jbW9ljsh3WIvZiMd1xKV30tsWta31UNoQsMCpF+bsLXLZ/JSfP+rvFxs8Nf/hSuPVCJ0z5inrh+7/z8fN3LBzX4xUL5SHGFyTkfhKJ43mEf0j0w7xchzumOKTGQXWjcPFyP8kDlLf+3mZ4Ujjfo03CVb/xUd8mbP/HIOmJSk0rvFRiseQDi+YgoLxMK/fov9MUM5n75IrMQmYhPAOclxSA6851+V62y4lmuHOdj9wRysq5wc6jsro2uGWN5/pLrrUZmgir9xne+NScDKKlKD/WxfRsbxyJrH11SUpuxCKbG1HmA7kAcX5Ii4eKei8NntdxR2j/UaGhHTJT4HgLtJ4ME8IOlKeweC3SfX6P5TwTl6WlkPOwuQ7hCmAKHTfGusFxoARlM/CfuphP+ly2/rgtLsvwU8lSXG7v+LSCau7SF4nsBDUG6JebononQVy67g7s/lAezl6VPWuAM3JXuBsEBg7A194R1wMGH+CHMz8N+iUIKrhB2w3b6fst0yBCTw/dYoZ+8QDbUan7kzLv4MSA/+sOQPsCZ8wAre3uwz5LzgNw3D/3OsfFr6qrAWzV0jifWXgm5Ir9ZemF3IBwB10CrCVIw8+cmY1tp6sLehd9AJIGWKQ8am2ynbALkC7KS7qY1bGUN/YeILwADPmTbz24yqnhT8rMbmhPhtgaIPZpUHkjVoT6jnYIfbMbfICBSLhx2xZruaua1JPxRmhMf8ScU98a5hau/ht1MRa1f9Lg/yf8xa8EzxqgvwXob5w1QH8L0N/4P9UKocwTi+5yAAAAAElFTkSuQmCC
-- "name": "Data Validation Engine"
-  "use_cases":
-  - "Data Management"
-  - "Data Hygiene"
-  - "Enterprise Governance"
-  "requires": []
-  "docs": "https://docs.nautobot.com/projects/data-validation/en/latest/"
-  "headline": >-
-    Guarantee Enterprise Data Governance with proper data hygiene by defining the right business rules for your
-    data.
-  "description": >-
-    Data Validation Engine offers a streamlined no-code user experience to create data validation rules using Regular
-    Expressions and min/mix rules ensuring corporate standards are enforced. It also supports advanced and complex
-    business rule logic by using the Data Validation APIs (with code).
-  "package_name": "nautobot_data_validation_engine"
-  "author": "Network to Code (NTC)"
-  "display":
-    "cloud": true
-    "oss": true
-    "enterprise": true
-  "availability": "Open Source"
-  "icon": >-
-    data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAI5ElEQVR42u2aCWxUVRSGp0M7nWkpVAWkgBox2oLBKARQw6KCG0pBWdSSoCZCxCiBmNAOpS4YMWjUCApGxTVu0JZS1BrqApS4AyoioJK2yI47Arag9T/T/77e3nkzne1BSeYlX6aUduae/96z3rpcySf5JJ/kk3zieyoqKhJOu36WL19uu+gVK1bIqw90A7lgMLgSjAU3gwJwC5gArgPDwAXgTNAZdGjXgpiLghApeO0OhoN7wPPgY/ADOAD+Bv+AhhAcBn+An8F6UAYeAuNBHsU88WLYLKIHd/RlsI2GiKG7wRdgGXgCFII7+LNyCq4H+WAcmEzR5oIloJrv9SdoBPvBR8APBoD04y6EjeG5XPBWLnIPWElDR4LeIAuu4I7G3+lS6XSd/hRnMfgGHAG/g+UUz3dcRDD8XPzzXlDPnZZjfic4D3hCxYOysrKwi9TiRihOYwxZBHbxs8vBQEdFMIw/m+ofA6t5lDs65ZuhAizoAx4Dv1EMOSVuR0TQPrQX/VB8/AFw6vH0Q1OM8vJyeb0cfAUOgtt0N0q0AJKSFtDXp+OoppyoSGxzKiQWfcnscUHC18Q37Av2gbd1Pz/RaViLGdeAQ+ARpwS4kbs/qT0VI0Zg3ghWqQ1K9IcUMPAVtGMBNoC1KjUm+kOkZG0Cb7QnF6isrNRd4DBTsmMC/MfcOx2ByN2OgmAeK84mJwWQo39Uq+kfbEdpcD0D4CGnBZAydDpYyniwxulCKEQRlMJdV4XQTjAVfOJkDChgxzYKZLIUrqNLSEU4jfnYE6qUlR0LV6CE6w+Y7qQUvop9wS5uSBmbIy+Nd1yA67WFnUtX2MIUuRe8A4pYsweaoXB9fRhjpRk6ncZJmfss+FZrhsq5FtUM+U6EAIoccBN4KUQ7XAqeZJc4he3wDWA0Ozrp92+le0n//yL4gHMEvR3+UGuHzZN23ATID7N7Kdy1Yeztn2NQ2kYDIhmIyO7uYH1fynZ7XLiBCMkANcQxASTNzDIbjjb6ei/7emmVB3FOMJYnRo3ExjO2DGUtfwboBFfoYOcegs36vByiVKthiVOF0Hc0xrVy5UrbaC8LDNPGuqKNB6bBdutbtmyZvF5KXE4J8C9FqFYitIdBpXbanFmP5gLiv+9xcLkZTNT9Ui3CqaeuML2ZIhsKPQFq8f9ONRxKgDHsDLcycFXye6eEiAFxGu111ftTTWPdeM0AnUAW8NT5vTbCeB1Ng5LjH2VB0sCoLRH7MmaCDvFcfIjhhkFi7GWgGCwF68AG8CV4HywEk8DZdX5Piv67jtUBVVVVqhGR3PwZ09xhpj0ZhZfw0kMuRM5hNuhEt5E8nmongo3ht4EacBgcAj/x31WgGmwEB0AjqAdPgX51/pb3qZ3lc7QQUv34EFaB4hY/cU7XQGH2Upiv2EOsYtV4jS6AYfxAGnkUbAFzwVCQQxdIA+kgG/QBk8EKirQLzETMyFDvV+/3JlaAMDVAGqvDQcz3UgE+zSaqmk3LejJB/Z5a6A6/R15vBDvAr6AE9LINfsGIIFeDNeAYeAF0sU5CoTcuAY4y8tv6rdaihsrpbh79TLpClhplfzfvIt0IMf4XsBmMkGAW2MEiT0if1o876cq4ICK8zlMSW0wwKsHnopm/q6FlGxce5rHfQeP7RxvMjGzgBfMpwny4Q2rz9z1xVYJ/6XPBRBQdRsB7n8d+RGDXC6PftdpmF1J0BG8yLoyO6RQYQ9FDnArdyfo7biHqWxZ8OwNeSUvOj2Kxc5pcrvtBCbmvSblNHqgDq0HnZmG9MQlwhKltNVvUt8AlZjqLVgxt92sY7XtGvVNifLFlfB64BN9zDytepd5/NmhgfInODWwmQt143f07y+LX2SZ3C9fU2E2DNJ8dzmM6V5W2MRo/AGwCNSBLvsf3zwV7wGs4Ve6oxA2RBt3c/SW8MWpgf7CYlyf9ODRNDVf91c32qQUWU4ChUe2QvfEHwLjA/4kAkiH8gZqhAvwIuidCAP3O8HzOCKsZHxo5rJQRljyPg5l8jyvUENU6/v7AjixlhZdjLa6kKZgojRfqi9KUyHPAQTAobgFC9Ps+XlvfzIltFeeFB1giN9JtRhqVXwZr+xp+rQvgAz0koLUSIZzxhmCam01iHMiPR4DRZpCTr0tLS+0EkaKnK/uFIZwEjVf3CUYA3MCyN80QoABsCTIsQuONQJtPAW6JRYBRFGBauDt4Y7LbZgfIhWWxq6tmKasLcCEFCDYwQuNrW+LMOAowIRYBZE73I1gHuiS4CPKwANqoStbAc7dl0GDwvWFoRMYbhdZd4B9VZMVyOzOD/YCUw9mJEEGiPXv/hWxp86wC6L5WhY0SYR8oBF9HYrzVJ8wKCLAI7GdKjEmATHZ1x/jXYP3jvRLTdmcS+/nJrYqgYBE2gyYK0bbxLe9/Kk/YWpAZaznsYgorYQEkPf48pkG3ze1O23V7kVUG92YTVKHigFUGB4vwNrhBT3URCDyax9/fXApH2RAZQS2Ft7Lvck4oQrzK3v4szgMiHoUFFjTbJ2OsBSyGrm7p31PtREhta+cN4yW1vsMhSZ+4RmWGAZn8G983KUIjb3UqeUrG8KIjhz+bas4LjIX24yJXtxpizMhuESFcYWRvvDCFTdbD2+d0jn9OaLOTqcz1UynGVo7BGlj4bAefUphXWBnmWgIUd9QHGjPYvy9gP8+TkB5LXFE9xm7wOeiRsEFpmHGYm1Phi3nh+TBFkQ5yE6/UhWtDDEIlQC2xhhjN/bx1H9DmvUGw8dvAzpYeI8axWIxiqICYwjJZ7g56sqZIM4OktvAuHGMd4zAjr5Vhfp/VLFlBtLXxGTz2u2n8dZGK6OTf8bR5H1Dr9+lGZPMESFCsZT+fq0rlIGZbqS6fAe8oj/3QhN4ROP3UFrWa6XVg+lrDGmEP02Qx64Z8lrdS4T3DPN/AnZ+nD1ZOCuMtEYJvhbI5yXmN/fxBGqqQ/L6PQkme77u7uHUwPCmfevOY+wN3gjns5/PZ1U1kbX+eqvB0rBR6Mj/NgU4R0eWIK/kkn+STfJJPDM//CEixjMtOrlAAAAAASUVORK5CYII=
+# TODO: remove data_validation_engine from marketplace repo so it doesn't get reintroduced here by accident
 - "name": "Design Builder"
   "use_cases":
   - "Network Design"

nautobot/extras/plugins/tables.py

@@ -20,38 +20,40 @@ class InstalledAppsTable(tables.Table):
             {% if record.home_url %}
                 <a href="{% url record.home_url %}" class="btn btn-primary btn-xs" title="Home">
             {% else %}
-                <a href="" class="btn btn-primary btn-xs disabled" title="No home link provided">
+                <a class="btn btn-primary btn-xs disabled" aria-disabled="true" title="No home link provided">
             {% endif %}
                 <i class="mdi mdi-home"></i>
             </a>
             {% if record.config_url %}
                 <a href="{% url record.config_url %}" class="btn btn-warning btn-xs" title="Configure">
             {% else %}
-                <a href="" class="btn btn-warning btn-xs disabled" title="No configuration link provided">
+                <a class="btn btn-warning btn-xs disabled" aria-disabled="true" title="No configuration link provided">
             {% endif %}
                 <i class="mdi mdi-cog"></i>
             </a>
             {% if record.docs_url %}
                 <a href="{% url record.docs_url %}" class="btn btn-info btn-xs" title="Docs">
             {% else %}
-                <a href="" class="btn btn-info btn-xs disabled" title="No docs provided">
+                <a class="btn btn-info btn-xs disabled" aria-disabled="true" title="No docs provided">
             {% endif %}
                 <i class="mdi mdi-book-open-page-variant"></i>
             </a>
         """,
-        attrs={"td": {"class": "text-right text-nowrap noprint"}},
+        attrs={"td": {"class": "d-print-none text-end text-nowrap nb-w-0"}, "th": {"class": "nb-actionable nb-w-0"}},
         verbose_name="",
     )
 
     class Meta:
         attrs = {
-            "class": "table table-hover table-headings",
+            "class": "table table-hover nb-table-headings",
         }
         default_columns = ("name", "headline", "version", "actions")
 
-    def __init__(self, *args, user=None, **kwargs):
+    def __init__(self, *args, user=None, configurable=False, **kwargs):
         super().__init__(*args, **kwargs)
 
+        self.configurable = configurable
+
         if self.empty_text is None:
             self.empty_text = "No installed Apps found"
 

nautobot/extras/plugins/urls.py

@@ -1,12 +1,9 @@
-from django.apps import apps
-from django.conf import settings
-from django.conf.urls import include
 from django.urls import path
 
-from nautobot.extras.plugins.utils import import_object
-
 from . import views
 
+BASE_URL_TO_APP_LABEL = {}
+
 # Initialize URL base, API, and admin URL patterns for plugins
 apps_patterns = [
     path("installed-apps/", views.InstalledAppsView.as_view(), name="apps_list"),
@@ -30,19 +27,3 @@ plugin_api_patterns = [
     ),
 ]
 plugin_admin_patterns = []
-
-# Register base/API URL patterns for each plugin
-for plugin_path in settings.PLUGINS:
-    plugin_name = plugin_path.split(".")[-1]
-    app = apps.get_app_config(plugin_name)
-    base_url = app.base_url or app.label
-
-    # Check if the plugin specifies any base URLs
-    urlpatterns = import_object(f"{plugin_path}.urls.urlpatterns")
-    if urlpatterns is not None:
-        plugin_patterns.append(path(f"{base_url}/", include((urlpatterns, app.label))))
-
-    # Check if the plugin specifies any API URLs
-    urlpatterns = import_object(f"{plugin_path}.api.urls.urlpatterns")
-    if urlpatterns is not None:
-        plugin_api_patterns.append(path(f"{base_url}/", include((urlpatterns, f"{app.label}-api"))))

nautobot/extras/plugins/utils.py

@@ -4,7 +4,6 @@ Plugin utilities.
 
 import importlib.util
 import logging
-import sys
 
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.module_loading import import_string
@@ -17,37 +16,6 @@ from .exceptions import PluginImproperlyConfigured, PluginNotFound
 logger = logging.getLogger(__name__)
 
 
-def import_object(module_and_object):
-    """
-    Import a specific object from a specific module by name, such as "nautobot.extras.plugins.utils.import_object".
-
-    Returns the imported object, or None if it doesn't exist.
-    """
-    target_module_name, object_name = module_and_object.rsplit(".", 1)
-    module_hierarchy = target_module_name.split(".")
-
-    # Iterate through the module hierarchy, checking for the existence of each successive submodule.
-    # We have to do this rather than jumping directly to calling find_spec(target_module_name)
-    # because find_spec will raise a ModuleNotFoundError if any parent module of target_module_name does not exist.
-    module_name = ""
-    for module_component in module_hierarchy:
-        module_name = f"{module_name}.{module_component}" if module_name else module_component
-        spec = importlib.util.find_spec(module_name)
-        if spec is None:
-            # No such module
-            return None
-
-    # Okay, target_module_name exists. Load it if not already loaded
-    if target_module_name in sys.modules:
-        module = sys.modules[target_module_name]
-    else:
-        module = importlib.util.module_from_spec(spec)
-        sys.modules[target_module_name] = module
-        spec.loader.exec_module(module)
-
-    return getattr(module, object_name, None)
-
-
 def load_plugins(settings):
     """Process plugins and log errors if they can't be loaded."""
     for plugin_name in settings.PLUGINS:
@@ -77,7 +45,7 @@ def load_plugin(plugin_name, settings):
     except AttributeError as err:
         raise PluginImproperlyConfigured(
             f"Plugin {plugin_name} does not provide a 'config' variable. This should be defined in the plugin's "
-            f"__init__.py file and point to the PluginConfig subclass."
+            f"__init__.py file and point to the NautobotAppConfig subclass."
         ) from err
 
     # Validate user-provided configuration settings and assign defaults. Plugin

nautobot/extras/plugins/validators.py

@@ -7,26 +7,26 @@ from nautobot.extras.registry import registry
 from nautobot.extras.utils import FeatureQuery
 
 
-def custom_validator_clean(model_clean_func):
+def custom_validator_clean(model_class):
     """
     Decorator that wraps a models existing clean method to also execute registered plugin custom validators
 
-    :param model_clean_func: The original model clean method which is to be wrapped
+    Args:
+        model_class: The model class whose clean function is to be wrapped
     """
 
+    model_clean_func = model_class.clean
+    model_name = model_class._meta.label_lower
+
     @wraps(model_clean_func)
     def wrapper(model_instance):
         # Run original model clean method
         model_clean_func(model_instance)
 
-        # Run registered plugin custom validators
-        model_name = model_instance._meta.label_lower
-
-        # Note this registry holds instances of PluginCustomValidator registered from plugins
+        # Run App registered custom validators
+        # Note this registry holds instances of CustomValidator registered from plugins
         # which is different than the `custom_validators` model features registry
-        custom_validators = registry["plugin_custom_validators"].get(model_name, [])
-
-        for custom_validator in custom_validators:
+        for custom_validator in registry["plugin_custom_validators"][model_name]:
             # If the class has not overridden the specified method, we can skip it (because we know it
             # will raise NotImplementedError).
             if getattr(custom_validator, "clean") == getattr(CustomValidator, "clean"):
@@ -43,4 +43,4 @@ def wrap_model_clean_methods():
     for app_label, models in FeatureQuery("custom_validators").as_dict():
         for model in models:
             model_class = apps.get_model(app_label=app_label, model_name=model)
-            model_class.clean = custom_validator_clean(model_class.clean)
+            model_class.clean = custom_validator_clean(model_class)

nautobot/extras/plugins/views.py

@@ -86,7 +86,6 @@ class InstalledAppsView(GenericView):
     """
 
     table = InstalledAppsTable
-    breadcrumbs = Breadcrumbs(items={"*": [ViewNameBreadcrumbItem(view_name="apps:apps_list", label="Installed Apps")]})
     view_titles = Titles(titles={"*": "Installed Apps"})
 
     def get(self, request):
@@ -96,7 +95,7 @@ class InstalledAppsView(GenericView):
         for app_config in app_configs:
             if app_data := extract_app_data(app_config, marketplace_data):
                 data.append(app_data)
-        table = self.table(data, user=request.user)
+        table = self.table(data, user=request.user, configurable=True)
 
         paginate = {
             "paginator_class": EnhancedPaginator,
@@ -250,9 +249,6 @@ class MarketplaceView(GenericView):
     View for listing all available Apps.
     """
 
-    breadcrumbs = Breadcrumbs(
-        items={"generic": [ViewNameBreadcrumbItem(view_name="apps:apps_marketplace", label="Apps Marketplace")]}
-    )
     view_titles = Titles(titles={"generic": "Apps Marketplace"})
 
     def get(self, request):

nautobot/extras/querysets.py

@@ -19,10 +19,6 @@ class ConfigContextQuerySet(RestrictedQuerySet):
         # `device_type` for Device; `type` for VirtualMachine
         device_type = getattr(obj, "device_type", None)
 
-        # Virtualization cluster for VirtualMachine
-        cluster = getattr(obj, "cluster", None)
-        cluster_group = getattr(cluster, "cluster_group", None)
-
         device_redundancy_group = getattr(obj, "device_redundancy_group", None)
 
         # Get the group of the assigned tenant, if any
@@ -45,8 +41,6 @@ class ConfigContextQuerySet(RestrictedQuerySet):
             Q(roles=role) | Q(roles=None),
             Q(device_types=device_type) | Q(device_types=None),
             Q(platforms=obj.platform) | Q(platforms=None),
-            Q(cluster_groups=cluster_group) | Q(cluster_groups=None),
-            Q(clusters=cluster) | Q(clusters=None),
             Q(device_redundancy_groups=device_redundancy_group) | Q(device_redundancy_groups=None),
             Q(tenant_groups__in=tenant_groups) | Q(tenant_groups=None),
             Q(tenants=tenant) | Q(tenants=None),
@@ -55,6 +49,16 @@ class ConfigContextQuerySet(RestrictedQuerySet):
         if settings.CONFIG_CONTEXT_DYNAMIC_GROUPS_ENABLED:
             query.append(Q(dynamic_groups__in=obj.dynamic_groups) | Q(dynamic_groups=None))
 
+        # `clusters` for Device, `cluster` for VirtualMachine
+        if obj._meta.model_name == "device":
+            query.append(Q(clusters__in=obj.clusters.all()) | Q(clusters=None))
+            query.append(
+                Q(cluster_groups__in=obj.clusters.values_list("cluster_group", flat=True)) | Q(cluster_groups=None)
+            )
+        else:
+            query.append(Q(clusters=obj.cluster) | Q(clusters=None))
+            query.append(Q(cluster_groups=obj.cluster.cluster_group) | Q(cluster_groups=None))
+
         queryset = (
             self.filter(
                 *query,
@@ -119,8 +123,6 @@ class ConfigContextModelQuerySet(RestrictedQuerySet):
         }
         base_query = Q(
             Q(platforms=OuterRef("platform")) | Q(platforms=None),
-            Q(cluster_groups=OuterRef("cluster__cluster_group")) | Q(cluster_groups=None),
-            Q(clusters=OuterRef("cluster")) | Q(clusters=None),
             Q(tenants=OuterRef("tenant")) | Q(tenants=None),
             Q(tags__pk__in=Subquery(TaggedItem.objects.filter(**tag_query_filters).values_list("tag_id", flat=True)))
             | Q(tags=None),
@@ -138,8 +140,14 @@ class ConfigContextModelQuerySet(RestrictedQuerySet):
                 (Q(device_redundancy_groups=OuterRef("device_redundancy_group")) | Q(device_redundancy_groups=None)),
                 Q.AND,
             )
+            # For devices, handle clusters as ManyToMany relationship
+            base_query.add((Q(clusters=OuterRef("clusters")) | Q(clusters=None)), Q.AND)
+            base_query.add((Q(cluster_groups=OuterRef("clusters__cluster_group")) | Q(cluster_groups=None)), Q.AND)
         else:
             location_query_string = "cluster__location"
+            # For virtual machines, handle cluster as ForeignKey relationship
+            base_query.add((Q(clusters=OuterRef("cluster")) | Q(clusters=None)), Q.AND)
+            base_query.add((Q(cluster_groups=OuterRef("cluster__cluster_group")) | Q(cluster_groups=None)), Q.AND)
 
         location_query = Q(locations=None) | Q(locations=OuterRef(location_query_string))
         for _ in range(Location.objects.max_depth + 1):
@@ -254,17 +262,5 @@ class ScheduledJobExtendedQuerySet(RestrictedQuerySet):
         Return only ScheduledJob instances that are enabled and approved (if approval required)
         """
         return self.filter(
-            Q(enabled=True) & Q(Q(approval_required=True, approved_at__isnull=False) | Q(approval_required=False))
+            Q(enabled=True) & Q(Q(approval_required=True, decision_date__isnull=False) | Q(approval_required=False))
         )
-
-    def approved(self):
-        """
-        Return only ScheduledJob instances that require approval and are approved
-        """
-        return self.filter(approval_required=True, approved_at__isnull=False)
-
-    def needs_approved(self):
-        """
-        Return only ScheduledJob instances that require approval and are not approved
-        """
-        return self.filter(approval_required=True, approved_at__isnull=True).order_by("start_time")

nautobot/extras/signals.py

@@ -22,6 +22,7 @@ import redis.exceptions
 
 from nautobot.core.celery import app, import_jobs
 from nautobot.core.models import BaseModel
+from nautobot.core.utils.cache import construct_cache_key
 from nautobot.core.utils.logging import sanitize
 from nautobot.extras.choices import ButtonClassChoices, JobResultStatusChoices, ObjectChangeActionChoices
 from nautobot.extras.constants import CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
@@ -142,9 +143,11 @@ def invalidate_models_cache(sender, **kwargs):
 
     with contextlib.suppress(redis.exceptions.ConnectionError):
         # TODO: *maybe* target more narrowly, e.g. only clear the cache for specific related content-types?
-        cache.delete_pattern(f"{manager.get_for_model.cache_key_prefix}.*")
+        cache_key = construct_cache_key(manager, method_name="get_for_model", branch_aware=True)
+        cache.delete_pattern(f"{cache_key}(*)")
         if hasattr(manager, "keys_for_model"):
-            cache.delete_pattern(f"{manager.keys_for_model.cache_key_prefix}.*")
+            cache_key = construct_cache_key(manager, method_name="keys_for_model", branch_aware=True)
+            cache.delete_pattern(f"{cache_key}(*)")
 
 
 @receiver(post_delete, sender=CustomField)
@@ -155,9 +158,10 @@ def invalidate_choices_cache(sender, instance, **kwargs):
     """Invalidate the choices cache for CustomFields."""
     with contextlib.suppress(redis.exceptions.ConnectionError):
         if sender is CustomField:
-            cache.delete(instance.choices_cache_key)
+            cache_key = construct_cache_key(instance, method_name="choices", branch_aware=True)
         else:
-            cache.delete(instance.custom_field.choices_cache_key)
+            cache_key = construct_cache_key(instance.custom_field, method_name="choices", branch_aware=True)
+        cache.delete(cache_key)
 
 
 @receiver(post_save, sender=Relationship)
@@ -165,13 +169,14 @@ def invalidate_choices_cache(sender, instance, **kwargs):
 @receiver(post_delete, sender=Relationship)
 def invalidate_relationship_models_cache(sender, **kwargs):
     """Invalidate the related-models caches for Relationships."""
-    for method in (
-        Relationship.objects.get_for_model_source,
-        Relationship.objects.get_for_model_destination,
+    for method_name in (
+        "get_for_model_source",
+        "get_for_model_destination",
     ):
         with contextlib.suppress(redis.exceptions.ConnectionError):
             # TODO: *maybe* target more narrowly, e.g. only clear the cache for specific related content-types?
-            cache.delete_pattern(f"{method.cache_key_prefix}.*")
+            cache_key = construct_cache_key(Relationship.objects, method_name=method_name, branch_aware=True)
+            cache.delete_pattern(f"{cache_key}(*)")
 
 
 @receiver(post_save, sender=CustomField)
@@ -200,6 +205,16 @@ def _handle_changed_object_pre_save(sender, instance, raw=False, **kwargs):
         _cache_obj_data_in_change_context(ObjectChangeActionChoices.ACTION_UPDATE, sender, instance)
 
 
+@receiver(post_save, sender=GitRepository)
+@receiver(post_delete, sender=GitRepository)
+def invalidate_gitrepository_provided_contents_cache(sender, **kwargs):
+    with contextlib.suppress(redis.exceptions.ConnectionError):
+        cache_key = construct_cache_key(
+            GitRepository.objects, method_name="get_for_provided_contents", branch_aware=True
+        )
+        cache.delete_pattern(f"{cache_key}(*)")
+
+
 @receiver(post_save)
 @receiver(m2m_changed)
 def _handle_changed_object(sender, instance, raw=False, **kwargs):