nautobot 3.0.0rc1__py3-none-any.whl → 3.0.1__py3-none-any.whl

nautobot/apps/forms.py

@@ -69,6 +69,11 @@ from nautobot.core.forms.widgets import (
     TimePicker,
 )
 from nautobot.data_validation.form_mixin import DataValidationModelFormMixin
+from nautobot.dcim.form_mixins import (
+    LocatableModelBulkEditFormMixin,
+    LocatableModelFilterFormMixin,
+    LocatableModelFormMixin,
+)
 from nautobot.extras.forms import (
     CustomFieldModelBulkEditFormMixin,
     CustomFieldModelCSVForm,
@@ -142,6 +147,9 @@ __all__ = (
     "JSONArrayFormField",
     "JSONField",
     "LaxURLField",
+    "LocatableModelBulkEditFormMixin",
+    "LocatableModelFilterFormMixin",
+    "LocatableModelFormMixin",
     "MACAddressField",
     "MultiMatchModelMultipleChoiceField",
     "MultiValueCharField",

nautobot/apps/templatetags.py

@@ -0,0 +1,231 @@
+"""Template tags for Nautobot."""
+
+from nautobot.core.templatetags.buttons import (
+    action_url,
+    add_button,
+    clone_button,
+    consolidate_bulk_action_buttons,
+    consolidate_detail_view_action_buttons,
+    delete_button,
+    edit_button,
+    export_button,
+    import_button,
+    job_export_url,
+    job_import_button,
+    job_import_url,
+    render_tag_attrs,
+)
+from nautobot.core.templatetags.form_helpers import (
+    render_custom_fields,
+    render_field,
+    render_form,
+    render_relationships,
+    widget_type,
+)
+from nautobot.core.templatetags.helpers import (
+    add_html_id,
+    as_range,
+    badge,
+    bettertitle,
+    custom_branding_or_static,
+    dbm,
+    divide,
+    django_querystring,
+    do_captureas,
+    dynamic_group_assignment_modal,
+    fgcolor,
+    filter_form_drawer,
+    format_timezone,
+    get_attr,
+    get_docs_url,
+    get_item,
+    has_one_or_more_perms,
+    has_perms,
+    humanize_speed,
+    hyperlinked_email,
+    hyperlinked_field,
+    hyperlinked_object,
+    hyperlinked_object_target_new_tab,
+    hyperlinked_object_with_color,
+    hyperlinked_phone_number,
+    label_list,
+    legacy_querystring,
+    meta,
+    meters_to_feet,
+    modal_form_as_dialog,
+    percentage,
+    placeholder,
+    pre_tag,
+    queryset_to_pks,
+    querystring,
+    quote_string,
+    render_address,
+    render_ancestor_hierarchy,
+    render_boolean,
+    render_button_class,
+    render_content_types,
+    render_job_run_link,
+    render_json,
+    render_m2m,
+    render_markdown,
+    render_uptime,
+    render_yaml,
+    saved_view_modal,
+    saved_view_title,
+    settings_or_config,
+    slugify,
+    split,
+    support_message,
+    table_config_button,
+    table_config_form,
+    tag,
+    tree_hierarchy_ui_representation,
+    tzoffset,
+    utilization_graph,
+    utilization_graph_raw_data,
+    validated_api_viewname,
+    validated_viewname,
+    versioned_static,
+    viewname,
+)
+from nautobot.core.templatetags.perms import (
+    can_add,
+    can_change,
+    can_delete,
+    can_view,
+)
+from nautobot.core.templatetags.ui_framework import (
+    render_breadcrumbs,
+    render_components,
+    render_detail_view_extra_buttons,
+    render_tabs_labels,
+    render_title,
+)
+from nautobot.extras.templatetags.computed_fields import (
+    computed_fields,
+    has_computed_fields,
+)
+from nautobot.extras.templatetags.custom_links import (
+    custom_links,
+)
+from nautobot.extras.templatetags.job_buttons import (
+    job_buttons,
+)
+from nautobot.extras.templatetags.log_levels import (
+    log_level,
+)
+from nautobot.extras.templatetags.plugins import (
+    plugin_banners,
+    plugin_buttons,
+    plugin_full_width_page,
+    plugin_left_page,
+    plugin_object_detail_tab_content,
+    plugin_object_detail_tabs,
+    plugin_right_page,
+)
+
+__all__ = (
+    "action_url",
+    "add_button",
+    "add_html_id",
+    "as_range",
+    "badge",
+    "bettertitle",
+    "can_add",
+    "can_change",
+    "can_delete",
+    "can_view",
+    "clone_button",
+    "computed_fields",
+    "consolidate_bulk_action_buttons",
+    "consolidate_detail_view_action_buttons",
+    "custom_branding_or_static",
+    "custom_links",
+    "dbm",
+    "delete_button",
+    "divide",
+    "django_querystring",
+    "do_captureas",
+    "dynamic_group_assignment_modal",
+    "edit_button",
+    "export_button",
+    "fgcolor",
+    "filter_form_drawer",
+    "format_timezone",
+    "get_attr",
+    "get_docs_url",
+    "get_item",
+    "has_computed_fields",
+    "has_one_or_more_perms",
+    "has_perms",
+    "humanize_speed",
+    "hyperlinked_email",
+    "hyperlinked_field",
+    "hyperlinked_object",
+    "hyperlinked_object_target_new_tab",
+    "hyperlinked_object_with_color",
+    "hyperlinked_phone_number",
+    "import_button",
+    "job_buttons",
+    "job_export_url",
+    "job_import_button",
+    "job_import_url",
+    "label_list",
+    "legacy_querystring",
+    "log_level",
+    "meta",
+    "meters_to_feet",
+    "modal_form_as_dialog",
+    "percentage",
+    "placeholder",
+    "plugin_banners",
+    "plugin_buttons",
+    "plugin_full_width_page",
+    "plugin_left_page",
+    "plugin_object_detail_tab_content",
+    "plugin_object_detail_tabs",
+    "plugin_right_page",
+    "pre_tag",
+    "queryset_to_pks",
+    "querystring",
+    "quote_string",
+    "render_address",
+    "render_ancestor_hierarchy",
+    "render_boolean",
+    "render_breadcrumbs",
+    "render_button_class",
+    "render_components",
+    "render_content_types",
+    "render_custom_fields",
+    "render_detail_view_extra_buttons",
+    "render_field",
+    "render_form",
+    "render_job_run_link",
+    "render_json",
+    "render_m2m",
+    "render_markdown",
+    "render_relationships",
+    "render_tabs_labels",
+    "render_tag_attrs",
+    "render_title",
+    "render_uptime",
+    "render_yaml",
+    "saved_view_modal",
+    "saved_view_title",
+    "settings_or_config",
+    "slugify",
+    "split",
+    "support_message",
+    "table_config_button",
+    "table_config_form",
+    "tag",
+    "tree_hierarchy_ui_representation",
+    "tzoffset",
+    "utilization_graph",
+    "utilization_graph_raw_data",
+    "validated_api_viewname",
+    "validated_viewname",
+    "versioned_static",
+    "viewname",
+    "widget_type",
+)

nautobot/apps/testing.py

@@ -9,7 +9,13 @@ from nautobot.core.testing import (
 from nautobot.core.testing.api import APITestCase, APITransactionTestCase, APIViewTestCases
 from nautobot.core.testing.filters import FilterTestCases
 from nautobot.core.testing.forms import FormTestCases
-from nautobot.core.testing.integration import SeleniumTestCase
+from nautobot.core.testing.integration import (
+    BulkOperationsMixin,
+    BulkOperationsTestCases,
+    ObjectDetailsMixin,
+    ObjectsListMixin,
+    SeleniumTestCase,
+)
 from nautobot.core.testing.migrations import NautobotDataMigrationTest
 from nautobot.core.testing.mixins import NautobotTestCaseMixin, NautobotTestClient
 from nautobot.core.testing.models import ModelTestCases
@@ -29,6 +35,8 @@ __all__ = (
     "APITestCase",
     "APITransactionTestCase",
     "APIViewTestCases",
+    "BulkOperationsMixin",
+    "BulkOperationsTestCases",
     "FilterTestCases",
     "FormTestCases",
     "ModelTestCase",
@@ -37,6 +45,8 @@ __all__ = (
     "NautobotDataMigrationTest",
     "NautobotTestCaseMixin",
     "NautobotTestClient",
+    "ObjectDetailsMixin",
+    "ObjectsListMixin",
     "OpenAPISchemaTestCases",
     "SeleniumTestCase",
     "TestCase",

nautobot/apps/ui.py

@@ -13,6 +13,13 @@ from nautobot.core.ui.breadcrumbs import (
     ModelBreadcrumbItem,
     ViewNameBreadcrumbItem,
 )
+from nautobot.core.ui.bulk_buttons import (
+    BaseBulkButton,
+    BulkDeleteButton,
+    BulkDisconnectButton,
+    BulkEditButton,
+    BulkRenameButton,
+)
 from nautobot.core.ui.choices import (
     EChartsThemeColors,
     EChartsTypeChoices,
@@ -49,6 +56,7 @@ from nautobot.core.ui.object_detail import (
     DistinctViewTab,
     DropdownButton,
     EChartsPanel,
+    FormButton,
     GroupedKeyValueTablePanel,
     KeyValueTablePanel,
     ObjectDetailContent,
@@ -61,7 +69,11 @@ from nautobot.core.ui.object_detail import (
     TextPanel,
 )
 from nautobot.core.ui.titles import Titles
-from nautobot.core.ui.utils import render_component_template
+from nautobot.core.ui.utils import (
+    flatten_context,
+    get_absolute_url,
+    render_component_template,
+)
 from nautobot.extras.choices import BannerClassChoices
 from nautobot.extras.plugins import Banner, TemplateExtension
 
@@ -71,8 +83,13 @@ __all__ = (
     "Banner",
     "BannerClassChoices",
     "BaseBreadcrumbItem",
+    "BaseBulkButton",
     "BaseTextPanel",
     "Breadcrumbs",
+    "BulkDeleteButton",
+    "BulkDisconnectButton",
+    "BulkEditButton",
+    "BulkRenameButton",
     "Button",
     "ButtonColorChoices",
     "Component",
@@ -83,6 +100,7 @@ __all__ = (
     "EChartsPanel",
     "EChartsThemeColors",
     "EChartsTypeChoices",
+    "FormButton",
     "GroupedKeyValueTablePanel",
     "HomePageBase",
     "HomePageGroup",
@@ -116,6 +134,8 @@ __all__ = (
     "Titles",
     "ViewNameBreadcrumbItem",
     "context_object_attr",
+    "flatten_context",
+    "get_absolute_url",
     "queryset_to_nested_dict_keys_as_series",
     "queryset_to_nested_dict_records_as_series",
     "render_component_template",

nautobot/apps/utils.py

@@ -16,7 +16,12 @@ from nautobot.core.utils.data import (
     to_meters,
     validate_jinja2,
 )
-from nautobot.core.utils.deprecation import class_deprecated, class_deprecated_in_favor_of
+from nautobot.core.utils.deprecation import (
+    class_deprecated,
+    class_deprecated_in_favor_of,
+    method_deprecated,
+    method_deprecated_in_favor_of,
+)
 from nautobot.core.utils.filtering import (
     build_lookup_label,
     get_all_lookup_expr_for_field,
@@ -29,14 +34,17 @@ from nautobot.core.utils.logging import sanitize
 from nautobot.core.utils.lookup import (
     get_breadcrumbs_for_model,
     get_changes_for_model,
+    get_created_and_last_updated_usernames_for_model,
     get_detail_view_components_context_for_model,
     get_filterset_for_model,
     get_form_for_model,
+    get_model_for_view_name,
     get_model_from_name,
     get_object_detail_content_for_model,
     get_related_class_for_model,
     get_related_field_for_models,
     get_route_for_model,
+    get_table_class_string_from_view_name,
     get_table_for_model,
     get_url_for_url_pattern,
     get_url_patterns,
@@ -47,10 +55,17 @@ from nautobot.core.utils.migrations import migrate_content_type_references_to_ne
 from nautobot.core.utils.permissions import (
     get_permission_for_model,
     permission_is_exempt,
+    qs_filter_from_constraints,
     resolve_permission,
     resolve_permission_ct,
 )
+from nautobot.core.utils.querysets import (
+    maybe_prefetch_related,
+    maybe_select_related,
+)
 from nautobot.core.utils.requests import (
+    add_nautobot_version_query_param_to_url,
+    convert_querydict_to_dict,
     convert_querydict_to_factory_formset_acceptable_querydict,
     ensure_content_type_and_field_name_in_query_params,
     get_filterable_params_from_filter_params,
@@ -85,12 +100,14 @@ __all__ = (
     "GitRepo",
     "RoleModelsQuery",
     "TaggableClassesQuery",
+    "add_nautobot_version_query_param_to_url",
     "build_lookup_label",
     "check_if_key_is_graphql_safe",
     "class_deprecated",
     "class_deprecated_in_favor_of",
     "construct_cache_key",
     "convert_git_diff_log_to_list",
+    "convert_querydict_to_dict",
     "convert_querydict_to_factory_formset_acceptable_querydict",
     "deepmerge",
     "ensure_content_type_and_field_name_in_query_params",
@@ -104,6 +121,7 @@ __all__ = (
     "get_breadcrumbs_for_model",
     "get_celery_queues",
     "get_changes_for_model",
+    "get_created_and_last_updated_usernames_for_model",
     "get_detail_view_components_context_for_model",
     "get_filter_field_label",
     "get_filterable_params_from_filter_params",
@@ -112,6 +130,7 @@ __all__ = (
     "get_filterset_parameter_form_field",
     "get_form_for_model",
     "get_latest_release",
+    "get_model_for_view_name",
     "get_model_from_name",
     "get_object_detail_content_for_model",
     "get_permission_for_model",
@@ -119,6 +138,7 @@ __all__ = (
     "get_related_field_for_models",
     "get_route_for_model",
     "get_settings_or_config",
+    "get_table_class_string_from_view_name",
     "get_table_for_model",
     "get_url_for_url_pattern",
     "get_url_patterns",
@@ -131,12 +151,17 @@ __all__ = (
     "is_url",
     "is_uuid",
     "lighten_color",
+    "maybe_prefetch_related",
+    "maybe_select_related",
     "merge_dicts_without_collision",
+    "method_deprecated",
+    "method_deprecated_in_favor_of",
     "migrate_content_type_references_to_new_model",
     "migrate_role_data",
     "normalize_querydict",
     "permission_is_exempt",
     "populate_model_features_registry",
+    "qs_filter_from_constraints",
     "refresh_job_model_from_job_class",
     "remove_prefix_from_cf_key",
     "render_jinja2",

nautobot/core/celery/__init__.py

@@ -5,7 +5,7 @@ from pathlib import Path
 import shutil
 import sys
 
-from celery import Celery, shared_task, signals
+from celery import bootsteps, Celery, shared_task, signals
 from celery.app.log import TaskFormatter
 from celery.utils.log import get_logger
 from django.apps import apps
@@ -268,3 +268,48 @@ def register_jobs(*jobs):
     for job in jobs:
         if job.class_path not in registry["jobs"]:
             registry["jobs"][job.class_path] = job
+
+
+@signals.worker_ready.connect
+def worker_ready(**_):
+    if not settings.CELERY_HEALTH_PROBES_AS_FILES:
+        return
+    WORKER_READINESS_FILE = Path(settings.CELERY_WORKER_READINESS_FILE)
+    WORKER_READINESS_FILE.touch(exist_ok=True)
+
+
+@signals.worker_shutdown.connect
+def worker_shutdown(**_):
+    if not settings.CELERY_HEALTH_PROBES_AS_FILES:
+        return
+    WORKER_READINESS_FILE = Path(settings.CELERY_WORKER_READINESS_FILE)
+    WORKER_READINESS_FILE.unlink(missing_ok=True)
+
+
+class LivenessProbe(bootsteps.StartStopStep):
+    requires = {"celery.worker.components:Timer"}
+
+    def __init__(self, parent, **kwargs):
+        self.requests = []
+        self.tref = None
+        self.WORKER_HEARTBEAT_FILE = Path(settings.CELERY_WORKER_HEARTBEAT_FILE)
+
+    def start(self, parent):
+        if not settings.CELERY_HEALTH_PROBES_AS_FILES:
+            return
+        # This is a 1-second interval.
+        self.tref = parent.timer.call_repeatedly(
+            1.0,
+            self.update_worker_heartbeat_file,
+            (parent,),
+            priority=10,
+        )
+
+    def stop(self, parent):
+        self.WORKER_HEARTBEAT_FILE.unlink(missing_ok=True)
+
+    def update_worker_heartbeat_file(self, parent):
+        self.WORKER_HEARTBEAT_FILE.touch(exist_ok=True)
+
+
+app.steps["worker"].add(LivenessProbe)