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

nautobot/core/apps/__init__.py

@@ -1,29 +1,42 @@
-from abc import ABC, abstractmethod
 from collections import OrderedDict
 import logging
 import os
 
 from constance.apps import ConstanceConfig
 from django.apps import AppConfig, apps as global_apps
-from django.contrib.admin.sites import NotRegistered
 from django.db.models import BigIntegerField, BinaryField, JSONField
 from django.db.models.signals import post_migrate
 from django.urls import reverse
 from django.urls.exceptions import NoReverseMatch
+from django.utils.http import urlencode
 from django.utils.module_loading import import_string
 from graphene.types import generic, String
 
-from nautobot.core.choices import ButtonActionColorChoices, ButtonActionIconChoices
 from nautobot.core.signals import nautobot_database_ready
-from nautobot.core.utils.navigation import get_all_new_ui_ready_routes
+from nautobot.core.ui.base import PermissionsMixin  # noqa: F401
+
+from nautobot.core.ui.homepage import (  # isort: skip  # noqa: F401
+    HomePageBase,
+    HomePageGroup,
+    HomePageItem,
+    HomePagePanel,
+)
+from nautobot.core.ui.nav import (  # isort: skip  # noqa: F401
+    NavMenuAddButton,
+    NavMenuBase,
+    NavMenuButton,
+    NavMenuGroup,
+    NavMenuImportButton,
+    NavMenuItem,
+    NavMenuTab,
+    NAV_CONTEXT_NAMES,
+)
+
 from nautobot.extras.registry import registry
 
 logger = logging.getLogger(__name__)
 registry["nav_menu"] = {"tabs": {}}
-registry["new_ui_nav_menu"] = {}
 registry["homepage_layout"] = {"panels": {}}
-registry["new_ui_ready_routes"] = set()
-NAV_CONTEXT_NAMES = ("Inventory", "Networks", "Security", "Automation", "Platform")
 
 
 class NautobotConfig(AppConfig):
@@ -59,19 +72,6 @@ class NautobotConfig(AppConfig):
         except ImportError:
             pass
 
-        # TODO we should remove this because it is no longer relevant.
-        try:
-            navigation = import_string(f"{self.name}.{self.navigation}")
-            register_new_ui_menu_items(navigation)
-        except ImportError:
-            pass
-
-        try:
-            registry["new_ui_ready_routes"].update(get_all_new_ui_ready_routes())
-        except NotRegistered:
-            # NOTE: Catch this error: The "Tag" model is not registered, which may be related to the admin not registering Tags. Further research is needed on this.
-            pass
-
 
 def create_or_check_entry(grouping, record, key, path):
     """
@@ -96,14 +96,6 @@ def create_or_check_entry(grouping, record, key, path):
             if grouping[key][attr] != value:
                 logger.error("Unable to redefine %s on %s from %s to %s", attr, path, grouping[key][attr], value)
 
-    # TODO: remove?
-    # React-UI specific: recursive population/validation of `data` for NavContext -> NavGrouping -> NavItem records
-    if isinstance(record, (NavContext, NavGrouping)):
-        groups = record.groups if isinstance(record, NavContext) else record.items
-        for item in groups:
-            create_or_check_entry(grouping[key]["data"], item, item.name, f"{path} -> {item.name}")
-            grouping[key]["data"] = dict(sorted(grouping[key]["data"].items(), key=lambda x: x[1]["weight"]))
-
 
 def register_menu_items(tab_list):
     """
@@ -174,6 +166,8 @@ def register_menu_items(tab_list):
                     # Instead of passing the reverse url strings, we pass in the url itself initialized with args and kwargs.
                     try:
                         item.link = reverse(item.link, args=item.args, kwargs=item.kwargs)
+                        if item.query_params:
+                            item.link += f"?{urlencode(item.query_params)}"
                     except NoReverseMatch as e:
                         # Catch the invalid link here and render the link name as an error message in the template
                         logger.debug("%s", e)
@@ -234,11 +228,6 @@ def register_menu_items(tab_list):
         )
 
 
-def register_new_ui_menu_items(context_list):
-    for nav_context in context_list:
-        create_or_check_entry(registry["new_ui_nav_menu"], nav_context, nav_context.name, nav_context.name)
-
-
 def register_homepage_panels(path, label, homepage_layout):
     """
     Register homepage panels using `homepage.py`.
@@ -316,551 +305,6 @@ def register_homepage_panels(path, label, homepage_layout):
     )
 
 
-class HomePageBase(ABC):
-    """Base class for homepage layout classes."""
-
-    @property
-    @abstractmethod
-    def initial_dict(self):  # to be implemented by each subclass
-        return {}
-
-    @property
-    @abstractmethod
-    def fixed_fields(self):  # to be implemented by subclass
-        return ()
-
-
-class NavMenuBase(ABC):  # replaces PermissionsMixin
-    """Base class for navigation classes."""
-
-    @property
-    @abstractmethod
-    def initial_dict(self) -> dict:  # to be implemented by each subclass
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {}
-
-    @property
-    @abstractmethod
-    def fixed_fields(self) -> tuple:  # to be implemented by subclass
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return ()
-
-
-class PermissionsMixin:
-    """Ensure permissions through init."""
-
-    def __init__(self, permissions=None):
-        """Ensure permissions."""
-        if permissions is not None and not isinstance(permissions, (list, tuple)):
-            raise TypeError("Permissions must be passed as a tuple or list.")
-        self.permissions = set(permissions) if permissions else None
-
-
-class HomePagePanel(HomePageBase, PermissionsMixin):
-    """Defines properties that can be used for a panel."""
-
-    items = None
-    template_path = None
-
-    @property
-    def initial_dict(self):
-        return {
-            "custom_template": self.custom_template,
-            "custom_data": self.custom_data,
-            "weight": self.weight,
-            "items": {},
-            "permissions": self.permissions,
-            "template_path": self.template_path,
-        }
-
-    @property
-    def fixed_fields(self):
-        return ()
-
-    def __init__(self, name, permissions=None, custom_data=None, custom_template=None, items=None, weight=1000):
-        """
-        Ensure panel properties.
-
-        Args:
-            name (str): The name of the panel.
-            permissions (list): The permissions required to view this panel.
-            custom_data (dict): Custom data to be passed to the custom template.
-            custom_template (str): Name of custom template.
-            items (list): List of items to be rendered in this panel.
-            weight (int): The weight of this panel.
-        """
-        super().__init__(permissions)
-        self.custom_data = custom_data
-        self.custom_template = custom_template
-        self.name = name
-        self.weight = weight
-
-        if items is not None and custom_template is not None:
-            raise ValueError("Cannot specify items and custom_template at the same time.")
-        if items is not None:
-            if not isinstance(items, (list, tuple)):
-                raise TypeError("Items must be passed as a tuple or list.")
-            elif not all(isinstance(item, (HomePageGroup, HomePageItem)) for item in items):
-                raise TypeError("All items defined in a panel must be an instance of HomePageGroup or HomePageItem")
-            self.items = items
-        else:
-            self.items = []
-
-
-class HomePageGroup(HomePageBase, PermissionsMixin):
-    """Defines properties that can be used for a panel group."""
-
-    items = []
-
-    @property
-    def initial_dict(self):
-        return {
-            "items": {},
-            "permissions": self.permissions,
-            "weight": self.weight,
-        }
-
-    @property
-    def fixed_fields(self):
-        return ()
-
-    def __init__(self, name, permissions=None, items=None, weight=1000):
-        """
-        Ensure group properties.
-
-        Args:
-            name (str): The name of the group.
-            permissions (list): The permissions required to view this group.
-            items (list): List of items to be rendered in this group.
-            weight (int): The weight of this group.
-        """
-        super().__init__(permissions)
-        self.name = name
-        self.weight = weight
-
-        if items is not None:
-            if not isinstance(items, (list, tuple)):
-                raise TypeError("Items must be passed as a tuple or list.")
-            elif not all(isinstance(item, HomePageItem) for item in items):
-                raise TypeError("All items defined in a group must be an instance of HomePageItem")
-            self.items = items
-
-
-class HomePageItem(HomePageBase, PermissionsMixin):
-    """Defines properties that can be used for a panel item."""
-
-    items = []
-    template_path = None
-
-    @property
-    def initial_dict(self):
-        return {
-            "custom_template": self.custom_template,
-            "custom_data": self.custom_data,
-            "description": self.description,
-            "link": self.link,
-            "model": self.model,
-            "permissions": self.permissions,
-            "template_path": self.template_path,
-            "weight": self.weight,
-        }
-
-    @property
-    def fixed_fields(self):
-        return ()
-
-    def __init__(
-        self,
-        name,
-        link=None,
-        model=None,
-        custom_template=None,
-        custom_data=None,
-        description=None,
-        permissions=None,
-        weight=1000,
-    ):
-        """
-        Ensure item properties.
-
-        Args:
-            name (str): The name of the item.
-            link (str): The link to be used for this item.
-            model (str): The model to being used for this item to calculate the total count of objects.
-            custom_template (str): Name of custom template.
-            custom_data (dict): Custom data to be passed to the custom template.
-        """
-        super().__init__(permissions)
-
-        self.name = name
-        self.custom_template = custom_template
-        self.custom_data = custom_data
-        self.description = description
-        self.link = link
-        self.model = model
-        self.weight = weight
-
-        if model is not None and custom_template is not None:
-            raise ValueError("Cannot specify model and custom_template at the same time.")
-
-
-class NavMenuTab(NavMenuBase, PermissionsMixin):
-    """
-    Ths class represents a navigation menu tab. This is built up from a name and a weight value. The name is
-    the display text and the weight defines its position in the navbar.
-
-    Groups are each specified as a list of NavMenuGroup instances.
-    """
-
-    permissions = []
-    groups = []
-
-    @property
-    def initial_dict(self) -> dict:
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {
-            "weight": self.weight,
-            "groups": {},
-            "permissions": set(),
-        }
-
-    @property
-    def fixed_fields(self) -> tuple:
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return ()
-
-    def __init__(self, name, permissions=None, groups=None, weight=1000):
-        """
-        Ensure tab properties.
-
-        Args:
-            name (str): The name of the tab.
-            permissions (list): The permissions required to view this tab.
-            groups (list): List of groups to be rendered in this tab.
-            weight (int): The weight of this tab.
-        """
-        super().__init__(permissions)
-        self.name = name
-        self.weight = weight
-        if groups is not None:
-            if not isinstance(groups, (list, tuple)):
-                raise TypeError("Groups must be passed as a tuple or list.")
-            elif not all(isinstance(group, NavMenuGroup) for group in groups):
-                raise TypeError("All groups defined in a tab must be an instance of NavMenuGroup")
-            self.groups = groups
-
-
-class NavMenuGroup(NavMenuBase, PermissionsMixin):
-    """
-    Ths class represents a navigation menu group. This is built up from a name and a weight value. The name is
-    the display text and the weight defines its position in the navbar.
-
-    Items are each specified as a list of NavMenuItem instances.
-    """
-
-    permissions = []
-    items = []
-
-    @property
-    def initial_dict(self) -> dict:
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {
-            "weight": self.weight,
-            "items": {},
-            "permissions": set(),
-        }
-
-    @property
-    def fixed_fields(self) -> tuple:
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return ()
-
-    def __init__(self, name, items=None, weight=1000):
-        """
-        Ensure group properties.
-
-        Args:
-            name (str): The name of the group.
-            items (list): List of items to be rendered in this group.
-            weight (int): The weight of this group.
-        """
-        self.name = name
-        self.weight = weight
-
-        if items is not None and not isinstance(items, (list, tuple)):
-            raise TypeError("Items must be passed as a tuple or list.")
-        elif not all(isinstance(item, NavMenuItem) for item in items):
-            raise TypeError("All items defined in a group must be an instance of NavMenuItem")
-        self.items = items
-        super().__init__(permissions=self.permissions)
-
-
-class NavMenuItem(NavMenuBase, PermissionsMixin):
-    """
-    This class represents a navigation menu item. This constitutes primary link and its text, but also allows for
-    specifying additional link buttons that appear to the right of the item in the nav menu.
-
-    Links are specified as Django reverse URL strings.
-    Buttons are each specified as a list of NavMenuButton instances.
-    """
-
-    @property
-    def initial_dict(self) -> dict:
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {
-            "name": self.name,
-            "weight": self.weight,
-            "buttons": {},
-            "permissions": self.permissions,
-            "args": [],
-            "kwargs": {},
-        }
-
-    @property
-    def fixed_fields(self) -> tuple:
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return (
-            ("name", self.name),
-            ("permissions", self.permissions),
-        )
-
-    permissions = []
-    buttons = []
-    args = []
-    kwargs = {}
-
-    def __init__(self, link, name, args=None, kwargs=None, permissions=None, buttons=(), weight=1000):
-        """
-        Ensure item properties.
-
-        Args:
-            link (str): The link to be used for this item.
-            name (str): The name of the item.
-            args (list): Arguments that are being passed to the url with reverse() method
-            kwargs (dict): Keyword arguments are are being passed to the url with reverse() method
-            permissions (list): The permissions required to view this item.
-            buttons (list): List of buttons to be rendered in this item.
-            weight (int): The weight of this item.
-        """
-        super().__init__(permissions)
-        self.link = link
-        self.name = name
-        self.weight = weight
-        self.args = args
-        self.kwargs = kwargs
-
-        if not isinstance(buttons, (list, tuple)):
-            raise TypeError("Buttons must be passed as a tuple or list.")
-        elif not all(isinstance(button, NavMenuButton) for button in buttons):
-            raise TypeError("All buttons defined in an item must be an instance or subclass of NavMenuButton")
-        self.buttons = buttons
-
-
-class NavMenuButton(NavMenuBase, PermissionsMixin):
-    """
-    This class represents a button within a NavMenuItem.
-    """
-
-    @property
-    def initial_dict(self) -> dict:
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {
-            "link": self.link,
-            "icon_class": self.icon_class,
-            "button_class": self.button_class,
-            "weight": self.weight,
-            "buttons": {},
-            "permissions": self.permissions,
-        }
-
-    @property
-    def fixed_fields(self) -> tuple:
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return (
-            ("button_class", self.button_class),
-            ("icon_class", self.icon_class),
-            ("link", self.link),
-            ("permissions", self.permissions),
-        )
-
-    def __init__(
-        self,
-        link,
-        title,
-        icon_class,
-        button_class=ButtonActionColorChoices.DEFAULT,
-        permissions=None,
-        weight=1000,
-    ):
-        """
-        Ensure button properties.
-
-        Args:
-            link (str): The link to be used for this button.
-            title (str): The title of the button.
-            icon_class (str): The icon class to be used as the icon for the start of the button.
-            button_class (str): The button class defines to be used to define the style of the button.
-            permissions (list): The permissions required to view this button.
-            weight (int): The weight of this button.
-        """
-        super().__init__(permissions)
-        self.link = link
-        self.title = title
-        self.icon_class = icon_class
-        self.weight = weight
-        self.button_class = button_class
-
-
-class NavMenuAddButton(NavMenuButton):
-    """Add button subclass."""
-
-    def __init__(self, *args, **kwargs):
-        """Ensure button properties."""
-        if "title" not in kwargs:
-            kwargs["title"] = "Add"
-        if "icon_class" not in kwargs:
-            kwargs["icon_class"] = ButtonActionIconChoices.ADD
-        if "button_class" not in kwargs:
-            kwargs["button_class"] = ButtonActionColorChoices.ADD
-        if "weight" not in kwargs:
-            kwargs["weight"] = 100
-        super().__init__(*args, **kwargs)
-
-
-class NavMenuImportButton(NavMenuButton):
-    """Import button subclass."""
-
-    def __init__(self, *args, **kwargs):
-        """Ensure button properties."""
-        if "title" not in kwargs:
-            kwargs["title"] = "Import"
-        if "icon_class" not in kwargs:
-            kwargs["icon_class"] = ButtonActionIconChoices.IMPORT
-        if "button_class" not in kwargs:
-            kwargs["button_class"] = ButtonActionColorChoices.IMPORT
-        if "weight" not in kwargs:
-            kwargs["weight"] = 200
-        super().__init__(*args, **kwargs)
-
-
-class NavContext(NavMenuBase):
-    """Ths class represents a navigation menu tab for new ui.
-
-    Groups are each specified as a list of NavGrouping instances.
-    """
-
-    def __init__(self, name, groups, weight=1000):
-        self.name = name
-        self.groups = groups
-        self.weight = weight
-        self.validate()
-
-    def validate(self):
-        # NavContext name must belong in this group ("Inventory", "Networks", "Security", "Automation", "Platform")
-        if self.name not in NAV_CONTEXT_NAMES:
-            raise TypeError(f"`{self.name}` is an invalid context name, valid choices are: {NAV_CONTEXT_NAMES}")
-
-        if self.groups:
-            groups = self.groups
-            if not isinstance(groups, (list, tuple)):
-                raise TypeError("Groups must be passed as a tuple or list.")
-            elif not all(isinstance(group, NavGrouping) for group in groups):
-                raise TypeError("All groups defined in a NavContext must be an instance of NavGrouping")
-
-    @property
-    def initial_dict(self) -> dict:
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {
-            "weight": self.weight,
-            "data": {},
-        }
-
-    @property
-    def fixed_fields(self) -> tuple:
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return ()
-
-
-class NavGrouping(NavMenuBase, PermissionsMixin):
-    """
-    Ths class represents a navigation menu group for the new ui. This is built up from a name and a weight value. The name is
-    the display text and the weight defines its position in the navigation sidebar.
-
-    Items are each specified as a list of NavItem or NavGrouping instances.
-    """
-
-    def __init__(self, name, items, weight=1000):  # pylint:disable=super-init-not-called  # this is dead code anyway
-        self.name = name
-        self.items = items
-        self.weight = weight
-        self.validate()
-
-    def validate(self):
-        if self.items:
-            items = self.items
-            if items is not None and not isinstance(items, (list, tuple)):
-                raise TypeError("Items must be passed as a tuple or list.")
-
-            if not all(isinstance(item, (NavItem, self.__class__)) for item in items):
-                raise TypeError("All items defined in a NavGrouping must be an instance of NavItem or NavGrouping")
-
-    @property
-    def initial_dict(self) -> dict:
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {
-            "weight": self.weight,
-            "data": {},
-        }
-
-    @property
-    def fixed_fields(self) -> tuple:
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return ()
-
-
-class NavItem(NavMenuBase, PermissionsMixin):
-    """
-    This class represents a navigation menu item for the new ui. This constitutes link and its text.
-
-    Links are specified as Django reverse URL strings.
-    """
-
-    def __init__(  # pylint:disable=super-init-not-called  # this is dead code anyway
-        self, name, link, *args, permissions=None, weight=1000, **kwargs
-    ):
-        self.name = name
-        self.link = link
-        self.permissions = permissions or []
-        self.weight = weight
-        self.args = args
-        self.kwargs = kwargs
-
-    @property
-    def initial_dict(self) -> dict:
-        """Attributes to be stored when adding this item to the nav menu data for the first time."""
-        return {
-            "name": self.name,
-            "weight": self.weight,
-            "permissions": self.permissions,
-            "data": self.url(),
-        }
-
-    @property
-    def fixed_fields(self):
-        """Tuple of (name, attribute) entries describing fields that may not be altered after declaration."""
-        return (
-            ("name", self.name),
-            ("permissions", self.permissions),
-        )
-
-    def url(self):
-        try:
-            return reverse(self.link, args=self.args, kwargs=self.kwargs)
-        except NoReverseMatch as e:
-            logger.error("Error in link construction for %s: %s", self.name, e)
-            return ""
-
-
 def post_migrate_send_nautobot_database_ready(sender, app_config, signal, **kwargs):
     """
     Send the `nautobot_database_ready` signal to all installed core apps and Apps.

nautobot/core/celery/__init__.py

@@ -14,6 +14,7 @@ from django.utils.module_loading import import_string
 from kombu.serialization import register
 from prometheus_client import CollectorRegistry, multiprocess, start_http_server
 
+from nautobot import add_success_logger
 from nautobot.core.celery.control import discard_git_repository, refresh_git_repository  # noqa: F401  # unused-import
 from nautobot.core.celery.encoders import NautobotKombuJSONEncoder
 from nautobot.core.celery.log import NautobotDatabaseHandler
@@ -135,6 +136,18 @@ def add_nautobot_log_handler(logger_instance, log_format=None):
     logger_instance.addHandler(handler)
 
 
+@signals.after_setup_logger.connect
+def setup_nautobot_global_logging(logger, **kwargs):  # pylint: disable=redefined-outer-name
+    """Add SUCCESS log to celery global logger."""
+    logger.success = add_success_logger()
+
+
+@signals.after_setup_task_logger.connect
+def setup_nautobot_task_logging(logger, **kwargs):  # pylint: disable=redefined-outer-name
+    """Add SUCCESS log to celery task logger."""
+    logger.success = add_success_logger()
+
+
 @signals.celeryd_after_setup.connect
 def setup_nautobot_job_logging(sender, instance, conf, **kwargs):
     """Add nautobot database logging handler to celery stdout/stderr redirect logger and celery task logger."""