nautobot 2.3.16__py3-none-any.whl → 2.4.0b1__py3-none-any.whl

nautobot/extras/navigation.py

@@ -1,7 +1,4 @@
 from nautobot.core.apps import (
-    NavContext,
-    NavGrouping,
-    NavItem,
     NavMenuAddButton,
     NavMenuGroup,
     NavMenuItem,
@@ -217,6 +214,22 @@ menu_items = (
                             ),
                         ),
                     ),
+                    NavMenuItem(
+                        link="extras:jobqueue_list",
+                        name="Job Queues",
+                        weight=700,
+                        permissions=[
+                            "extras.view_jobqueue",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="extras:jobqueue_add",
+                                permissions=[
+                                    "extras.add_jobqueue",
+                                ],
+                            ),
+                        ),
+                    ),
                 ),
             ),
         ),
@@ -504,269 +517,14 @@ menu_items = (
                 weight=100,
                 items=(
                     NavMenuItem(
-                        link="apps:apps_list",
-                        name="Installed Apps",
-                        weight=100,
-                    ),
-                ),
-            ),
-        ),
-    ),
-)
-
-
-navigation = (
-    NavContext(
-        name="Inventory",
-        groups=(
-            NavGrouping(
-                name="Devices",
-                weight=100,
-                items=(
-                    NavItem(
-                        name="Dynamic Groups",
-                        weight=900,
-                        link="extras:dynamicgroup_list",
-                        permissions=["extras.view_dynamicgroup"],
-                    ),
-                ),
-            ),
-        ),
-    ),
-    NavContext(
-        name="Networks",
-        groups=(
-            NavGrouping(
-                name="Config Contexts",
-                weight=500,
-                items=(
-                    NavItem(
-                        name="Config Contexts",
-                        weight=100,
-                        link="extras:configcontext_list",
-                        permissions=["extras.view_configcontext"],
-                    ),
-                    NavItem(
-                        name="Config Context Schemas",
-                        weight=100,
-                        link="extras:configcontextschema_list",
-                        permissions=["extras.view_configcontextschema"],
-                    ),
-                ),
-            ),
-        ),
-    ),
-    NavContext(
-        name="Security",
-        groups=(
-            NavGrouping(
-                name="Secrets",
-                weight=500,
-                items=(
-                    NavItem(
-                        name="Secrets",
+                        link="apps:apps_marketplace",
+                        name="Apps Marketplace",
                         weight=100,
-                        link="extras:secret_list",
-                        permissions=["extras.view_secret"],
                     ),
-                    NavItem(
-                        name="Secret Groups",
-                        weight=200,
-                        link="extras:secretsgroup_list",
-                        permissions=["extras.view_secretsgroup"],
-                    ),
-                ),
-            ),
-        ),
-    ),
-    NavContext(
-        name="Automation",
-        groups=(
-            NavGrouping(
-                name="Jobs",
-                weight=100,
-                items=(
-                    NavItem(
-                        link="extras:job_list",
-                        name="Jobs",
-                        weight=100,
-                        permissions=[
-                            "extras.view_job",
-                        ],
-                    ),
-                    NavItem(
-                        link="extras:scheduledjob_approval_queue_list",
-                        name="Job Approval Queue",
-                        weight=200,
-                        permissions=[
-                            "extras.view_job",
-                        ],
-                    ),
-                    NavItem(
-                        link="extras:scheduledjob_list",
-                        name="Scheduled Jobs",
-                        weight=300,
-                        permissions=[
-                            "extras.view_job",
-                            "extras.view_scheduledjob",
-                        ],
-                    ),
-                    NavItem(
-                        link="extras:jobresult_list",
-                        name="Job Results",
-                        weight=400,
-                        permissions=[
-                            "extras.view_jobresult",
-                        ],
-                    ),
-                    NavItem(
-                        link="extras:jobhook_list",
-                        name="Job Hooks",
-                        weight=500,
-                        permissions=[
-                            "extras.view_jobhook",
-                        ],
-                    ),
-                    NavItem(
-                        link="extras:jobbutton_list",
-                        name="Job Buttons",
-                        weight=600,
-                        permissions=[
-                            "extras.view_jobbutton",
-                        ],
-                    ),
-                ),
-            ),
-            NavGrouping(
-                name="Extensibility",
-                weight=9999,  # always last
-                items=(
-                    NavItem(
-                        link="extras:webhook_list",
-                        name="Webhooks",
-                        weight=100,
-                        permissions=["extras.view_webhook"],
-                    ),
-                    NavItem(
-                        name="GraphQL Queries",
-                        weight=200,
-                        link="extras:graphqlquery_list",
-                        permissions=["extras.view_graphqlquery"],
-                    ),
-                    NavItem(
-                        name="Export Templates",
-                        weight=300,
-                        link="extras:exporttemplate_list",
-                        permissions=["extras.view_exporttemplate"],
-                    ),
-                ),
-            ),
-        ),
-    ),
-    NavContext(
-        name="Platform",
-        groups=(
-            NavGrouping(
-                name="Platform",
-                weight=100,
-                items=(
-                    NavItem(
-                        name="Installed Apps",
-                        weight=100,
+                    NavMenuItem(
                         link="apps:apps_list",
-                    ),
-                    NavItem(
-                        name="Git Repositories",
-                        weight=200,
-                        link="extras:gitrepository_list",
-                        permissions=["extras.view_gitrepository"],
-                    ),
-                ),
-            ),
-            NavGrouping(
-                name="Governance",
-                weight=200,
-                items=(
-                    NavItem(
-                        name="Change Log",
-                        weight=100,
-                        link="extras:objectchange_list",
-                        permissions=["extras.view_objectchange"],
-                    ),
-                ),
-            ),
-            NavGrouping(
-                name="Reference Data",
-                weight=300,
-                items=(
-                    NavItem(
-                        name="Tags",
-                        weight=100,
-                        link="extras:tag_list",
-                        permissions=["extras.view_tag"],
-                    ),
-                    NavItem(
-                        name="Statuses",
-                        weight=200,
-                        link="extras:status_list",
-                        permissions=["extras.view_status"],
-                    ),
-                    NavItem(
-                        name="Roles",
-                        weight=300,
-                        link="extras:role_list",
-                        permissions=["extras.view_role"],
-                    ),
-                ),
-            ),
-            NavGrouping(
-                name="Data Management",
-                weight=400,
-                items=(
-                    NavItem(
-                        name="Relationships",
-                        weight=100,
-                        link="extras:relationship_list",
-                        permissions=["extras.view_relationship"],
-                    ),
-                    NavItem(
-                        name="Computed Fields",
+                        name="Installed Apps",
                         weight=200,
-                        link="extras:computedfield_list",
-                        permissions=["extras.view_computedfield"],
-                    ),
-                    NavItem(
-                        name="Custom Fields",
-                        weight=300,
-                        link="extras:customfield_list",
-                        permissions=["extras.view_customfield"],
-                    ),
-                    NavItem(
-                        name="Custom Links",
-                        weight=400,
-                        link="extras:customlink_list",
-                        permissions=["extras.view_customlink"],
-                    ),
-                    NavItem(
-                        name="Notes",
-                        weight=500,
-                        # TODO figure out what link we should put here
-                        # This NavItem is required for the breadCrumb on NotesDetailView to render.
-                        # However `extras:note_list` is not a reverse url lookup that does not exist.
-                        link="extras:note_list",
-                        permissions=["extras.view_note"],
-                    ),
-                ),
-            ),
-            NavGrouping(
-                name="Users",
-                weight=500,
-                items=(
-                    NavItem(
-                        link="extras:savedview_list",
-                        name="Saved Views",
-                        weight=100,
-                        permissions=["extras.view_savedviews"],
                     ),
                 ),
             ),

nautobot/extras/plugins/__init__.py

@@ -287,21 +287,34 @@ class PluginConfig(NautobotAppConfig):
 
 class TemplateExtension:
     """
-    This class is used to register plugin content to be injected into core Nautobot templates. It contains methods
-    that are overridden by plugin authors to return template content.
+    This class is used to register App content to be injected into core Nautobot templates.
 
-    The `model` attribute on the class defines the which model detail page this class renders content for. It
-    should be set as a string in the form `<app_label>.<model_name>`. `render()` provides the following context data:
+    It contains methods and attributes that may be overridden by App authors to return template content.
 
-    * object - The object being viewed
-    * request - The current request
-    * settings - Global Nautobot settings
-    * config - Plugin-specific configuration parameters
+    The `model` attribute on the class defines the which model detail/list pages this class renders content for.
+    It should be set as a string in the form `<app_label>.<model_name>`.
     """
 
-    model = None
+    model: str = None
+    """The model (as a string in the form `<app_label>.<model>`) that this TemplateExtension subclass applies to."""
+    object_detail_buttons = None
+    """List of Button instances to add to the specified model's detail view."""
+    object_detail_tabs = None
+    """List of Tab instances to add to the specified model's detail view."""
+    object_detail_panels = None
+    """List of Panel instances to add to the specified model's detail view."""
 
     def __init__(self, context):
+        """
+        Called automatically to instantiate a TemplateExtension with render context before calling `left_page()`, etc.
+
+        The provided context typically includes the following keys:
+
+        * object - The object being viewed
+        * request - The current request
+        * settings - Global Nautobot settings
+        * config - App-specific configuration parameters
+        """
         self.context = context
 
     def render(self, template_name, extra_context=None):
@@ -318,30 +331,49 @@ class TemplateExtension:
 
     def left_page(self):
         """
-        Content that will be rendered on the left of the detail page view. Content should be returned as an
-        HTML string. Note that content does not need to be marked as safe because this is automatically handled.
+        (Deprecated) Provide content that will be rendered on the left of the detail page view.
+
+        In Nautobot v2.4.0 and later, Apps can (should) instead register `Panel` instances in `object_detail_panels`,
+        instead of implementing a `.left_page()` method.
+
+        Content should be returned as an HTML string.
+        Note that content does not need to be marked as safe because this is automatically handled.
         """
         raise NotImplementedError
 
     def right_page(self):
         """
-        Content that will be rendered on the right of the detail page view. Content should be returned as an
-        HTML string. Note that content does not need to be marked as safe because this is automatically handled.
+        (Deprecated) Provide content that will be rendered on the right of the detail page view.
+
+        In Nautobot v2.4.0 and later, Apps can (should) instead register `Panel` instances in `object_detail_panels`,
+        instead of implementing a `.right_page()` method.
+
+        Content should be returned as an HTML string.
+        Note that content does not need to be marked as safe because this is automatically handled.
         """
         raise NotImplementedError
 
     def full_width_page(self):
         """
-        Content that will be rendered within the full width of the detail page view. Content should be returned as an
-        HTML string. Note that content does not need to be marked as safe because this is automatically handled.
+        (Deprecated) Provide content that will be rendered within the full width of the detail page view.
+
+        In Nautobot v2.4.0 and later, Apps can (should) instead register `Panel` instances in `object_detail_panels`,
+        instead of implementing a `.full_width_page()` method.
+
+        Content should be returned as an HTML string.
+        Note that content does not need to be marked as safe because this is automatically handled.
         """
         raise NotImplementedError
 
     def buttons(self):
         """
-        Buttons that will be rendered and added to the existing list of buttons on the detail page view. Content
-        should be returned as an HTML string. Note that content does not need to be marked as safe because this is
-        automatically handled.
+        (Deprecated) Provide content that will be added to the existing list of buttons on the detail page view.
+
+        In Nautobot v2.4.0 and later, Apps can (should) instead register `Button` instances in `object_detail_buttons`,
+        instead of implementing a `.buttons()` method.
+
+        Content should be returned as an HTML string.
+        Note that content does not need to be marked as safe because this is automatically handled.
         """
         raise NotImplementedError
 
@@ -355,7 +387,10 @@ class TemplateExtension:
 
     def detail_tabs(self):
         """
-        Tabs that will be rendered and added to the existing list of tabs on the detail page view.
+        (Deprecated) Provide a dict of tabs and associated views that will be added to the detail page view.
+
+        In Nautobot v2.4.0 and later, Apps can (should) instead implement the `object_detail_tabs` attribute instead.
+
         Tabs will be ordered by their position in the list.
 
         Content should be returned as a list of dicts in the following format:
@@ -519,7 +554,6 @@ class TableExtension:
     """
 
     model = None
-    suffix = None
     table_columns = {}
     add_to_default_columns = ()
     remove_from_default_columns = ()
@@ -595,7 +629,7 @@ def _add_columns_into_model_table(table_extension, app_name):
         logger.error(error)
         return
 
-    table = get_table_for_model(table_extension.model, suffix=table_extension.suffix)
+    table = get_table_for_model(table_extension.model)
     for name, column in table_extension.table_columns.items():
         _validate_table_column_name_is_prefixed_with_app_name(name, app_name)
         _add_column_to_table_base_columns(table, name, column, app_name)
@@ -630,28 +664,18 @@ def _modify_default_table_columns(table_extension, app_name):
     """Add or remove columns from the table default columns."""
     from nautobot.core.utils.lookup import get_table_for_model
 
-    table = get_table_for_model(table_extension.model, suffix=table_extension.suffix)
+    table = get_table_for_model(table_extension.model)
     message = (
         f"{app_name}: Cannot {{action}} column `{{column_name}}` {{preposition}} the default columns for `{table}`."
     )
 
     for column_name in table_extension.add_to_default_columns:
-        if not getattr(table.Meta, "default_columns", None):
-            logger.warning(
-                f"{app_name}: Table `{table}` does not have a `default_columns` attribute. Cannot add column: {column_name}."
-            )
-            continue
         if column_name in table.base_columns:
             table.Meta.default_columns = (*table.Meta.default_columns, column_name)
         else:
             logger.debug(message.format(action="add", column_name=column_name, preposition="to"))
 
     for column_name in table_extension.remove_from_default_columns:
-        if not getattr(table.Meta, "default_columns", None):
-            logger.warning(
-                f"{app_name}: Table `{table}` does not have a `default_columns` attribute. Cannot remove column: {column_name}."
-            )
-            continue
         if column_name in table.Meta.default_columns:
             table.Meta.default_columns = tuple(name for name in table.Meta.default_columns if name != column_name)
         else: