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

nautobot/__init__.py

@@ -11,6 +11,21 @@ __version__ = metadata.version(__name__)
 # Sentinel to make sure we only initialize once.
 __initialized = False
 
+
+def add_success_logger():
+    """Add a custom log level for success messages."""
+    SUCCESS = 25
+    logging.addLevelName(SUCCESS, "SUCCESS")
+
+    def success(self, message, *args, **kws):
+        if self.isEnabledFor(SUCCESS):
+            self._log(SUCCESS, message, args, **kws)
+
+    logging.Logger.success = success
+    return success
+
+
+add_success_logger()
 logger = logging.getLogger(__name__)
 
 

nautobot/apps/__init__.py

@@ -6,6 +6,6 @@ from nautobot.extras.plugins import NautobotAppConfig
 
 __all__ = (
     "ConstanceConfigItem",
-    "nautobot_database_ready",
     "NautobotAppConfig",
+    "nautobot_database_ready",
 )

nautobot/apps/api.py

@@ -39,7 +39,6 @@ from nautobot.core.api.utils import (
 from nautobot.core.api.views import (
     BulkDestroyModelMixin,
     BulkUpdateModelMixin,
-    GetObjectCountsView,
     ModelViewSet,
     ModelViewSetMixin,
     ReadOnlyModelViewSet,
@@ -57,13 +56,6 @@ __all__ = (
     "ContentTypeField",
     "CustomFieldModelSerializerMixin",
     "CustomFieldModelViewSet",
-    "dict_to_filter_params",
-    "dynamic_import",
-    "get_api_version_serializer",
-    "get_serializer_for_model",
-    "get_view_name",
-    "GetObjectCountsView",
-    "is_api_request",
     "LaxURLField",
     "ModelViewSet",
     "ModelViewSetMixin",
@@ -80,13 +72,19 @@ __all__ = (
     "OrderedDefaultRouter",
     "ReadOnlyModelViewSet",
     "RelationshipModelSerializerMixin",
-    "rest_api_server_error",
     "SerializedPKRelatedField",
     "TaggedModelSerializerMixin",
     "TimeZoneSerializerField",
     "TreeModelSerializerMixin",
     "ValidatedModelSerializer",
-    "versioned_serializer_selector",
     "WritableNestedSerializer",
     "WritableSerializerMixin",
+    "dict_to_filter_params",
+    "dynamic_import",
+    "get_api_version_serializer",
+    "get_serializer_for_model",
+    "get_view_name",
+    "is_api_request",
+    "rest_api_server_error",
+    "versioned_serializer_selector",
 )

nautobot/apps/change_logging.py

@@ -11,11 +11,11 @@ from nautobot.extras.context_managers import (
 )
 
 __all__ = (
-    "change_logging",
     "ChangeContext",
     "JobChangeContext",
     "JobHookChangeContext",
     "ORMChangeContext",
-    "web_request_context",
     "WebChangeContext",
+    "change_logging",
+    "web_request_context",
 )

nautobot/apps/choices.py

@@ -77,12 +77,12 @@ __all__ = (
     "DeviceFaceChoices",
     "DeviceRedundancyGroupFailoverStrategyChoices",
     "DynamicGroupOperatorChoices",
-    "InterfaceModeChoices",
-    "InterfaceRedundancyGroupProtocolChoices",
-    "InterfaceTypeChoices",
     "IPAddressRoleChoices",
     "IPAddressTypeChoices",
     "IPAddressVersionChoices",
+    "InterfaceModeChoices",
+    "InterfaceRedundancyGroupProtocolChoices",
+    "InterfaceTypeChoices",
     "JobExecutionType",
     "JobResultStatusChoices",
     "LogLevelChoices",
@@ -110,6 +110,6 @@ __all__ = (
     "SoftwareImageFileStatusChoices",
     "SoftwareVersionStatusChoices",
     "SubdeviceRoleChoices",
-    "unpack_grouped_choices",
     "WebhookHttpMethodChoices",
+    "unpack_grouped_choices",
 )

nautobot/apps/config.py

@@ -1,12 +1,41 @@
 """Helper code for loading values that may be defined in settings.py/nautobot_config.py *or* in django-constance."""
 
+import contextlib
+import logging
+
 from constance import config
 from django.conf import settings
+from django.core.exceptions import ObjectDoesNotExist
+from django.db import OperationalError, ProgrammingError
+
+logger = logging.getLogger(__name__)
+
 
+def get_app_settings_or_config(app_name, variable_name, fallback=None):
+    """
+    Get a value from Django settings.PLUGINS_CONFIG (if specified there) or Constance configuration (otherwise).
 
-def get_app_settings_or_config(app_name, variable_name):
-    """Get a value from Django settings (if specified there) or Constance configuration (otherwise)."""
+    The fallback value is returned *only* if the requested variable cannot be found at all - this is an error case,
+    and will generate warning logs.
+    """
     # Explicitly set in settings.py or nautobot_config.py takes precedence, for now
     if variable_name in settings.PLUGINS_CONFIG[app_name]:
         return settings.PLUGINS_CONFIG[app_name][variable_name]
-    return getattr(config, f"{app_name}__{variable_name}")
+    # django-constance 4.x removed some built-in error handling here, so we have to do it ourselves now
+    constance_key = f"{app_name}__{variable_name}"
+    with contextlib.suppress(ObjectDoesNotExist, OperationalError, ProgrammingError):
+        return getattr(config, constance_key)
+    logger.warning(
+        '"PLUGINS_CONFIG[%r][%r]" is not in settings, and could not read from the Constance database table '
+        "(perhaps not initialized yet?)",
+        app_name,
+        variable_name,
+    )
+    if constance_key in settings.CONSTANCE_CONFIG:
+        default = settings.CONSTANCE_CONFIG[constance_key][0]
+        logger.warning('Using default value of "%s" from Constance configuration for "%s"', default, constance_key)
+        return default
+    logger.warning(
+        'Constance configuration does not include an entry for "%s" - must return %s', constance_key, fallback
+    )
+    return fallback

nautobot/apps/events.py

@@ -0,0 +1,19 @@
+"""APIs for Nautobot event-notification subsystem."""
+
+from nautobot.core.events import (
+    deregister_event_broker,
+    EventBroker,
+    publish_event,
+    RedisEventBroker,
+    register_event_broker,
+    SyslogEventBroker,
+)
+
+__all__ = (
+    "EventBroker",
+    "RedisEventBroker",
+    "SyslogEventBroker",
+    "deregister_event_broker",
+    "publish_event",
+    "register_event_broker",
+)

nautobot/apps/exceptions.py

@@ -5,7 +5,6 @@ from nautobot.core.exceptions import (
     AbortTransaction,
     CeleryWorkerNotRunningException,
     FilterSetFieldNotFound,
-    ViewConfigException,
 )
 from nautobot.extras.secrets.exceptions import (
     SecretError,
@@ -30,5 +29,4 @@ __all__ = (
     "SecretValueNotFoundError",
     "SerializerNotFound",
     "ServiceUnavailable",
-    "ViewConfigException",
 )

nautobot/apps/factory.py

@@ -13,11 +13,11 @@ from nautobot.core.factory import (
 
 __all__ = (
     "BaseModelFactory",
-    "get_random_instances",
     "NautobotBoolIterator",
     "NautobotFakerProvider",
     "OrganizationalModelFactory",
     "PrimaryModelFactory",
-    "random_instance",
     "UniqueFaker",
+    "get_random_instances",
+    "random_instance",
 )

nautobot/apps/filters.py

@@ -58,7 +58,6 @@ __all__ = (
     "LocalContextModelFilterSetMixin",
     "MACAddressFilter",
     "MappedPredicatesFilterMixin",
-    "multivalue_field_factory",
     "MultiValueBigNumberFilter",
     "MultiValueCharFilter",
     "MultiValueDateFilter",
@@ -84,4 +83,5 @@ __all__ = (
     "TagFilter",
     "TenancyModelFilterSetMixin",
     "TreeNodeMultipleChoiceFilter",
+    "multivalue_field_factory",
 )

nautobot/apps/forms.py

@@ -99,20 +99,13 @@ from nautobot.extras.forms.mixins import (
 from nautobot.ipam.formfields import IPAddressFormField, IPNetworkFormField
 
 __all__ = (
-    "add_blank_choice",
-    "add_field_to_filter_form_class",
-    "AddressFieldMixin",
     "APISelect",
     "APISelectMultiple",
+    "AddressFieldMixin",
     "BootstrapMixin",
     "BulkEditForm",
     "BulkEditNullBooleanSelect",
     "BulkRenameForm",
-    "ColorSelect",
-    "CommentField",
-    "ConfirmationForm",
-    "ContactTeamModelFilterFormMixin",
-    "ContentTypeSelect",
     "CSVChoiceField",
     "CSVContentTypeField",
     "CSVDataField",
@@ -121,35 +114,35 @@ __all__ = (
     "CSVModelForm",
     "CSVMultipleChoiceField",
     "CSVMultipleContentTypeField",
+    "ColorSelect",
+    "CommentField",
+    "ConfirmationForm",
+    "ContactTeamModelFilterFormMixin",
+    "ContentTypeSelect",
     "CustomFieldModelBulkEditFormMixin",
     "CustomFieldModelCSVForm",
     "CustomFieldModelFilterFormMixin",
     "CustomFieldModelFormMixin",
     "DatePicker",
     "DateTimePicker",
-    "dynamic_formset_factory",
     "DynamicFilterForm",
     "DynamicGroupModelFormMixin",
     "DynamicModelChoiceField",
     "DynamicModelChoiceMixin",
     "DynamicModelMultipleChoiceField",
-    "expand_alphanumeric_pattern",
-    "expand_ipaddress_pattern",
     "ExpandableIPAddressField",
     "ExpandableNameField",
-    "form_from_model",
-    "get_git_datasource_content_choices",
-    "ImportForm",
     "IPAddressFormField",
     "IPNetworkFormField",
+    "ImportForm",
     "JSONArrayFormField",
     "JSONField",
     "LaxURLField",
     "MACAddressField",
     "MultiMatchModelMultipleChoiceField",
-    "MultipleContentTypeField",
     "MultiValueCharField",
     "MultiValueCharInput",
+    "MultipleContentTypeField",
     "NautobotBulkEditForm",
     "NautobotFilterForm",
     "NautobotModelForm",
@@ -158,15 +151,10 @@ __all__ = (
     "NoteModelFormMixin",
     "NullableDateField",
     "NumericArrayField",
-    "parse_alphanumeric_range",
-    "parse_numeric_range",
     "PrefixFieldMixin",
-    "provider_choices",
-    "provider_choices_with_blank",
     "RelationshipModelBulkEditFormMixin",
     "RelationshipModelFilterFormMixin",
     "RelationshipModelFormMixin",
-    "restrict_form_fields",
     "ReturnURLForm",
     "RoleModelBulkEditFormMixin",
     "RoleModelFilterFormMixin",
@@ -183,4 +171,16 @@ __all__ = (
     "TagFilterField",
     "TagsBulkEditFormMixin",
     "TimePicker",
+    "add_blank_choice",
+    "add_field_to_filter_form_class",
+    "dynamic_formset_factory",
+    "expand_alphanumeric_pattern",
+    "expand_ipaddress_pattern",
+    "form_from_model",
+    "get_git_datasource_content_choices",
+    "parse_alphanumeric_range",
+    "parse_numeric_range",
+    "provider_choices",
+    "provider_choices_with_blank",
+    "restrict_form_fields",
 )

nautobot/apps/graphql.py

@@ -6,11 +6,11 @@ from nautobot.core.graphql.utils import construct_resolver, get_filtering_args_f
 
 __all__ = (
     "BigInteger",
-    "construct_resolver",
     "ContentTypeType",
+    "OptimizedNautobotObjectType",
+    "construct_resolver",
     "execute_query",
     "execute_saved_query",
     "get_filtering_args_from_filterset",
-    "OptimizedNautobotObjectType",
     "str_to_var_name",
 )

nautobot/apps/jobs.py

@@ -38,29 +38,29 @@ __all__ = (
     "ChoiceVar",
     "DatabaseFileField",
     "DryRunVar",
-    "enqueue_job_hooks",
     "FileVar",
-    "get_job",
-    "get_jobs",
     "GitRepositoryDryRun",
     "GitRepositorySync",
-    "IntegerVar",
     "IPAddressVar",
     "IPAddressWithMaskVar",
     "IPNetworkVar",
-    "is_job",
-    "is_variable",
+    "IntegerVar",
+    "JSONVar",
     "Job",
     "JobButtonReceiver",
     "JobHookReceiver",
-    "JSONVar",
     "MultiChoiceVar",
     "MultiObjectVar",
     "NautobotKombuJSONEncoder",
     "ObjectVar",
-    "register_jobs",
     "RunJobTaskFailed",
     "ScriptVariable",
     "StringVar",
     "TextVar",
+    "enqueue_job_hooks",
+    "get_job",
+    "get_jobs",
+    "is_job",
+    "is_variable",
+    "register_jobs",
 )

nautobot/apps/models.py

@@ -58,7 +58,6 @@ from nautobot.ipam.fields import VarbinaryIPField
 from nautobot.ipam.models import get_default_namespace, get_default_namespace_pk
 
 __all__ = (
-    "array_to_string",
     "AttributeSetter",
     "AutoSlugField",
     "BaseManager",
@@ -69,47 +68,29 @@ __all__ = (
     "CompositeKeyQuerySetMixin",
     "ConfigContextModel",
     "ConfigContextSchemaValidationMixin",
-    "construct_composite_key",
-    "construct_natural_slug",
     "ContactMixin",
     "ContentTypeRelatedQuerySet",
-    "count_related",
     "CustomFieldModel",
     "CustomValidator",
-    "deconstruct_composite_key",
     "DynamicGroupMixin",
     "DynamicGroupsModelMixin",
     "EmptyGroupByJSONBAgg",
     "EnhancedURLValidator",
     "ExclusionValidator",
-    "extras_features",
-    "find_models_with_matching_fields",
     "ForeignKeyLimitedByContentTypes",
     "ForeignKeyWithAutoRelatedName",
-    "get_all_concrete_models",
-    "get_default_namespace",
-    "get_default_namespace_pk",
-    "is_taggable",
     "JSONArrayField",
     "JSONBAgg",
     "LaxURLField",
-    "mac_unix_expanded_uppercase",
     "MACAddressCharField",
     "NameColorContentTypesModel",
-    "naturalize_interface",
-    "naturalize",
     "NaturalOrderingField",
     "NotesMixin",
     "OrganizationalModel",
-    "pretty_print_query",
     "PrimaryModel",
     "RelationshipModel",
     "RestrictedQuerySet",
     "SavedViewMixin",
-    "serialize_object_v2",
-    "serialize_object",
-    "slugify_dashes_to_underscores",
-    "slugify_dots_to_dashes",
     "StatusField",
     "StatusModel",
     "TagsField",
@@ -119,4 +100,23 @@ __all__ = (
     "TreeQuerySet",
     "ValidRegexValidator",
     "VarbinaryIPField",
+    "array_to_string",
+    "construct_composite_key",
+    "construct_natural_slug",
+    "count_related",
+    "deconstruct_composite_key",
+    "extras_features",
+    "find_models_with_matching_fields",
+    "get_all_concrete_models",
+    "get_default_namespace",
+    "get_default_namespace_pk",
+    "is_taggable",
+    "mac_unix_expanded_uppercase",
+    "naturalize",
+    "naturalize_interface",
+    "pretty_print_query",
+    "serialize_object",
+    "serialize_object_v2",
+    "slugify_dashes_to_underscores",
+    "slugify_dots_to_dashes",
 )

nautobot/apps/tables.py

@@ -32,7 +32,7 @@ __all__ = (
     "RelationshipColumn",
     "RoleTableMixin",
     "StatusTableMixin",
-    "TagColumn",
     "TableExtension",
+    "TagColumn",
     "ToggleColumn",
 )

nautobot/apps/testing.py

@@ -29,16 +29,8 @@ __all__ = (
     "APITestCase",
     "APITransactionTestCase",
     "APIViewTestCases",
-    "create_job_result_and_run_job",
-    "create_test_user",
-    "disable_warnings",
-    "extract_form_failures",
-    "extract_page_body",
     "FilterTestCases",
     "FormTestCases",
-    "generate_random_device_asset_tag_of_specified_size",
-    "get_deletable_objects",
-    "get_job_class_and_model",
     "ModelTestCase",
     "ModelTestCases",
     "ModelViewTestCase",
@@ -46,10 +38,18 @@ __all__ = (
     "NautobotTestCaseMixin",
     "NautobotTestClient",
     "OpenAPISchemaTestCases",
-    "post_data",
-    "run_job_for_testing",
     "SeleniumTestCase",
     "TestCase",
     "TransactionTestCase",
     "ViewTestCases",
+    "create_job_result_and_run_job",
+    "create_test_user",
+    "disable_warnings",
+    "extract_form_failures",
+    "extract_page_body",
+    "generate_random_device_asset_tag_of_specified_size",
+    "get_deletable_objects",
+    "get_job_class_and_model",
+    "post_data",
+    "run_job_for_testing",
 )

nautobot/apps/ui.py

@@ -1,13 +1,15 @@
 """Utilities for apps to integrate with and extend the existing Nautobot UI."""
 
-from nautobot.core.apps import (
+from nautobot.core.choices import ButtonColorChoices
+from nautobot.core.ui.base import PermissionsMixin
+from nautobot.core.ui.choices import LayoutChoices, SectionChoices
+from nautobot.core.ui.homepage import (
     HomePageBase,
     HomePageGroup,
     HomePageItem,
     HomePagePanel,
-    NavContext,
-    NavGrouping,
-    NavItem,
+)
+from nautobot.core.ui.nav import (
     NavMenuAddButton,
     NavMenuBase,
     NavMenuButton,
@@ -15,23 +17,46 @@ from nautobot.core.apps import (
     NavMenuImportButton,
     NavMenuItem,
     NavMenuTab,
-    PermissionsMixin,
 )
-from nautobot.core.choices import ButtonColorChoices
+from nautobot.core.ui.object_detail import (
+    BaseTextPanel,
+    Button,
+    Component,
+    DataTablePanel,
+    DistinctViewTab,
+    DropdownButton,
+    GroupedKeyValueTablePanel,
+    KeyValueTablePanel,
+    ObjectDetailContent,
+    ObjectFieldsPanel,
+    ObjectsTablePanel,
+    ObjectTextPanel,
+    Panel,
+    StatsPanel,
+    Tab,
+    TextPanel,
+)
+from nautobot.core.ui.utils import render_component_template
 from nautobot.extras.choices import BannerClassChoices
 from nautobot.extras.plugins import Banner, TemplateExtension
 
 __all__ = (
     "Banner",
     "BannerClassChoices",
+    "BaseTextPanel",
+    "Button",
     "ButtonColorChoices",
+    "Component",
+    "DataTablePanel",
+    "DistinctViewTab",
+    "DropdownButton",
+    "GroupedKeyValueTablePanel",
     "HomePageBase",
     "HomePageGroup",
     "HomePageItem",
     "HomePagePanel",
-    "NavContext",
-    "NavGrouping",
-    "NavItem",
+    "KeyValueTablePanel",
+    "LayoutChoices",
     "NavMenuAddButton",
     "NavMenuBase",
     "NavMenuButton",
@@ -39,6 +64,16 @@ __all__ = (
     "NavMenuImportButton",
     "NavMenuItem",
     "NavMenuTab",
+    "ObjectDetailContent",
+    "ObjectFieldsPanel",
+    "ObjectTextPanel",
+    "ObjectsTablePanel",
+    "Panel",
     "PermissionsMixin",
+    "SectionChoices",
+    "StatsPanel",
+    "Tab",
     "TemplateExtension",
+    "TextPanel",
+    "render_component_template",
 )

nautobot/apps/utils.py

@@ -38,11 +38,6 @@ from nautobot.core.utils.lookup import (
     get_view_for_model,
 )
 from nautobot.core.utils.migrations import migrate_content_type_references_to_new_model
-from nautobot.core.utils.navigation import (
-    get_all_new_ui_ready_routes,
-    get_only_new_ui_ready_routes,
-    is_route_new_ui_ready,
-)
 from nautobot.core.utils.permissions import (
     get_permission_for_model,
     permission_is_exempt,
@@ -79,8 +74,13 @@ from nautobot.extras.utils import (
 
 __all__ = (
     "BranchDoesNotExist",
-    "build_lookup_label",
     "ChangeLoggedModelsQuery",
+    "FeatureQuery",
+    "FeaturedQueryMixin",
+    "GitRepo",
+    "RoleModelsQuery",
+    "TaggableClassesQuery",
+    "build_lookup_label",
     "check_if_key_is_graphql_safe",
     "class_deprecated",
     "class_deprecated_in_favor_of",
@@ -89,15 +89,12 @@ __all__ = (
     "custom_validator_clean",
     "deepmerge",
     "ensure_content_type_and_field_name_in_query_params",
-    "FeaturedQueryMixin",
-    "FeatureQuery",
     "fixup_null_statuses",
     "flatten_dict",
     "flatten_iterable",
     "foreground_color",
     "generate_signature",
     "get_all_lookup_expr_for_field",
-    "get_all_new_ui_ready_routes",
     "get_base_template",
     "get_celery_queues",
     "get_changes_for_model",
@@ -109,21 +106,18 @@ __all__ = (
     "get_form_for_model",
     "get_latest_release",
     "get_model_from_name",
-    "get_only_new_ui_ready_routes",
     "get_permission_for_model",
     "get_related_class_for_model",
     "get_related_field_for_models",
     "get_route_for_model",
     "get_settings_or_config",
     "get_table_for_model",
-    "get_view_for_model",
     "get_url_for_url_pattern",
     "get_url_patterns",
+    "get_view_for_model",
     "get_worker_count",
-    "GitRepo",
     "hex_to_rgb",
     "image_upload",
-    "is_route_new_ui_ready",
     "is_single_choice_field",
     "is_url",
     "is_uuid",
@@ -140,11 +134,9 @@ __all__ = (
     "resolve_permission",
     "resolve_permission_ct",
     "rgb_to_hex",
-    "RoleModelsQuery",
     "sanitize",
     "shallow_compare_dict",
     "swap_status_initials",
-    "TaggableClassesQuery",
     "task_queues_as_choices",
     "to_meters",
     "wrap_model_clean_methods",