nautobot 2.0.0a3__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/extras/models/mixins.py

@@ -1,14 +1,8 @@
 """
 Class-modifying mixins that need to be standalone to avoid circular imports.
 """
-import sys
-
-from cacheops.utils import family_has_profile
-from django.db.models import Q
 from django.urls import NoReverseMatch, reverse
-from funcy import once_per
 
-from nautobot.core.forms.fields import DynamicModelMultipleChoiceField
 from nautobot.core.utils.lookup import get_route_for_model
 
 
@@ -78,68 +72,3 @@ class NotesMixin:
                 continue
 
         return None
-
-
-# 2.0 TODO: Remove after v2 since we will no longer care about backwards-incompatibility.
-# - Remove the `monkey_mix` from `nautobot.core.apps.CoreConfig.ready()`
-# - Convert this into a subclass instead of a mixin and move it to `nautobot.extras.models.managers.TaggableManager` (assuming this stays in `extras`)
-# - Replace all `from taggit.managers import TaggableManager` references to `from nautobot.extras.models.managers import TaggableManager`
-class TaggableManagerMonkeyMixin:
-    """
-    Dynamically-applied monkey-patch mixin that is used to replace any defined
-    methods on eligible objects.
-
-    Intended to be used on the right-hand side of `monkey_mix()` to overload the
-    `formfield()` method.
-
-    Usage:
-
-        monkey_mix(TaggableManager, TaggableManagerMonkeyMixin)
-
-    See: `nautobot.core.apps.ready()`
-    """
-
-    @once_per("cls")
-    def _install_hotfix(self, cls):
-        # Install auto-created models as their module attributes to make them picklable
-        module = sys.modules[cls.__module__]
-        if not hasattr(module, cls.__name__):
-            setattr(module, cls.__name__, cls)
-
-    # This is probably still needed if models are created dynamically.
-    def contribute_to_class(self, cls, name):
-        """
-        Overload default so that we can assert that this is called when
-        attached to any model that is using a `TaggableManager`.
-
-        Using `.contribute_to_class()` is how field objects get added to the model
-        at during the instance preparation. This is also where any custom model
-        methods are hooked in. So in short this method asserts that any time a`
-        `TaggableManager` is added to a model, that model also gets its methods
-        monkey-mixed without having to define them on the model yourself.
-        """
-
-        self._no_monkey.contribute_to_class(self, cls, name)
-        # Django migrations create lots of fake models, just skip them
-        # NOTE: we make it here rather then inside _install_hotfix()
-        #       because we don't want @once_per() to hold refs to all of them.
-        # family_has_profile is fork-lifted from cacheops which
-        # is used to identify "all proxy models, including subclasess, superclassses and siblings" for a model object.
-        # See: https://github.com/Suor/django-cacheops/blob/ad83e51b6d82ba2bf4820953925ff889e4c4b840/cacheops/utils.py#L16-L27
-        if cls.__module__ != "__fake__" and family_has_profile(cls):
-            self._install_hotfix(cls)
-
-    def formfield(self, form_class=DynamicModelMultipleChoiceField, **kwargs):
-        from nautobot.extras.models.tags import Tag
-
-        queryset = Tag.objects.filter(
-            Q(
-                content_types__model=self.model._meta.model_name,
-                content_types__app_label=self.model._meta.app_label,
-            )
-            | Q(content_types__isnull=True)
-        )
-        kwargs.setdefault("queryset", queryset)
-        kwargs.setdefault("required", False)
-        kwargs.setdefault("query_params", {"content_types": self.model._meta.label_lower})
-        return self._no_monkey.formfield(self, form_class=form_class, **kwargs)

nautobot/extras/models/models.py

@@ -12,7 +12,6 @@ from django.core.exceptions import ValidationError
 from django.db import models
 from django.http import HttpResponse
 from django.utils.text import slugify
-from django.urls import reverse
 from graphene_django.settings import graphene_settings
 from graphql import get_default_backend
 from graphql.error import GraphQLSyntaxError
@@ -136,9 +135,6 @@ class ConfigContext(BaseModel, ChangeLoggedModel, ConfigContextSchemaValidationM
             return f"[{self.owner}] {self.name}"
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("extras:configcontext", kwargs={"pk": self.pk})
-
     def clean(self):
         super().clean()
 
@@ -285,9 +281,6 @@ class ConfigContextSchema(OrganizationalModel):
             return f"[{self.owner}] {self.name}"
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("extras:configcontextschema", args=[self.slug])
-
     def clean(self):
         """
         Validate the schema
@@ -360,9 +353,6 @@ class CustomLink(BaseModel, ChangeLoggedModel, NotesMixin):
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("extras:customlink", kwargs={"pk": self.pk})
-
 
 #
 # Export templates
@@ -447,9 +437,6 @@ class ExportTemplate(BaseModel, ChangeLoggedModel, RelationshipModel, NotesMixin
 
         return response
 
-    def get_absolute_url(self):
-        return reverse("extras:exporttemplate", kwargs={"pk": self.pk})
-
     def clean(self):
         super().clean()
         if self.file_extension.startswith("."):
@@ -557,9 +544,6 @@ class GraphQLQuery(BaseModel, ChangeLoggedModel, NotesMixin):
         verbose_name = "GraphQL query"
         verbose_name_plural = "GraphQL queries"
 
-    def get_absolute_url(self):
-        return reverse("extras:graphqlquery", kwargs={"pk": self.pk})
-
     def save(self, *args, **kwargs):
         variables = {}
         schema = graphene_settings.SCHEMA
@@ -826,9 +810,6 @@ class Webhook(BaseModel, ChangeLoggedModel, NotesMixin):
         else:
             return json.dumps(context, cls=JSONEncoder, ensure_ascii=False)
 
-    def get_absolute_url(self):
-        return reverse("extras:webhook", kwargs={"pk": self.pk})
-
     @classmethod
     def check_for_conflicts(
         cls, instance=None, content_types=None, payload_url=None, type_create=None, type_update=None, type_delete=None

nautobot/extras/models/relationships.py

@@ -21,7 +21,7 @@ from nautobot.core.models.fields import AutoSlugField, slugify_dashes_to_undersc
 from nautobot.core.models.querysets import RestrictedQuerySet
 from nautobot.core.utils.lookup import get_filterset_for_model, get_route_for_model
 from nautobot.extras.choices import RelationshipTypeChoices, RelationshipRequiredSideChoices, RelationshipSideChoices
-from nautobot.extras.utils import FeatureQuery, extras_features
+from nautobot.extras.utils import FeatureQuery, check_if_key_is_graphql_safe, extras_features
 from nautobot.extras.models import ChangeLoggedModel
 from nautobot.extras.models.mixins import NotesMixin
 
@@ -261,9 +261,9 @@ class RelationshipModel(models.Model):
 
             required_model_class = getattr(relation, f"{opposite_side}_type").model_class()
             required_model_meta = required_model_class._meta
-            cr_field_name = f"cr_{relation.slug}__{opposite_side}"
+            cr_field_name = f"cr_{relation.key}__{opposite_side}"
             name_plural = cls._meta.verbose_name_plural
-            field_key = relation.slug if output_for == "api" else cr_field_name
+            field_key = relation.key if output_for == "api" else cr_field_name
             field_errors = {field_key: []}
 
             if not required_model_class.objects.exists():
@@ -312,7 +312,7 @@ class RelationshipModel(models.Model):
                         )
                     elif output_for == "api":
                         field_errors[field_key].append(
-                            f'You need to specify ["relationships"]["{relation.slug}"]["{opposite_side}"]["objects"].'
+                            f'You need to specify ["relationships"]["{relation.key}"]["{opposite_side}"]["objects"].'
                         )
 
             if len(field_errors[field_key]) > 0:
@@ -346,11 +346,11 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
 
 
 class Relationship(BaseModel, ChangeLoggedModel, NotesMixin):
-    name = models.CharField(max_length=100, unique=True, help_text="Name of the relationship as displayed to users")
-    slug = AutoSlugField(
-        populate_from="name",
+    label = models.CharField(max_length=100, unique=True, help_text="Label of the relationship as displayed to users")
+    key = AutoSlugField(
+        populate_from="label",
         slugify_function=slugify_dashes_to_underscores,
-        help_text="Internal relationship name. Please use underscores rather than dashes in this slug.",
+        help_text="Internal relationship key. Please use underscores rather than dashes in this key.",
     )
     description = models.CharField(max_length=200, blank=True)
     type = models.CharField(
@@ -435,10 +435,10 @@ class Relationship(BaseModel, ChangeLoggedModel, NotesMixin):
     objects = RelationshipManager()
 
     class Meta:
-        ordering = ["name"]
+        ordering = ["label"]
 
     def __str__(self):
-        return self.name.replace("_", " ")
+        return self.label
 
     @property
     def symmetric(self):
@@ -454,9 +454,6 @@ class Relationship(BaseModel, ChangeLoggedModel, NotesMixin):
             return self.source_type
         return None
 
-    def get_absolute_url(self):
-        return reverse("extras:relationship", args=[self.slug])
-
     def get_label(self, side):
         """Return the label for a given side, source or destination.
 
@@ -562,6 +559,9 @@ class Relationship(BaseModel, ChangeLoggedModel, NotesMixin):
         return field
 
     def clean(self):
+        # Check if relationship.key is graphql safe.
+        if self.key != "":
+            check_if_key_is_graphql_safe(self.__class__.__name__, self.key)
         # Check if source and destination filters are valid
         for side in ["source", "destination"]:
             if not getattr(self, f"{side}_filter"):
@@ -734,6 +734,12 @@ class RelationshipAssociation(BaseModel):
 
         return None
 
+    def get_absolute_url(self, api=False):
+        # TODO: in the new UI we should be able to have an actual UI URL for this model
+        if not api:
+            return self.relationship.get_absolute_url(api=api)
+        return super().get_absolute_url(api=api)
+
     def get_source(self):
         """Accessor for self.source - returns None if the object cannot be located."""
         return self._get_genericforeignkey("source")

nautobot/extras/models/roles.py

@@ -23,20 +23,9 @@ class Role(NameColorContentTypesModel):
     )
     weight = models.PositiveSmallIntegerField(null=True, blank=True)
 
-    csv_headers = ["name", "weight", "color", "content_types", "description"]
-
     class Meta:
         ordering = ("weight", "name")
 
-    def to_csv(self):
-        return (
-            self.name,
-            self.weight,
-            self.color,
-            self.get_content_types(),
-            self.description,
-        )
-
 
 class RoleField(ForeignKeyLimitedByContentTypes):
     """Model database field that automatically limits role choices
@@ -46,27 +35,4 @@ class RoleField(ForeignKeyLimitedByContentTypes):
     def __init__(self, *args, **kwargs):
         kwargs.setdefault("to", Role)
         kwargs.setdefault("on_delete", models.PROTECT)
-        kwargs.setdefault("blank", True)
         super().__init__(*args, **kwargs)
-
-
-class RoleModelMixin(models.Model):
-    """
-    Abstract base class for any model which may have roles.
-    """
-
-    role = RoleField(null=True, blank=True)
-
-    class Meta:
-        abstract = True
-
-
-class RoleRequiredRoleModelMixin(models.Model):
-    """
-    Abstract base class for any model which may have roles with role field required.
-    """
-
-    role = RoleField(null=False, blank=False)
-
-    class Meta:
-        abstract = True

nautobot/extras/models/secrets.py

@@ -3,7 +3,6 @@ import logging
 from django.core.exceptions import ValidationError
 from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
-from django.urls import reverse
 
 from jinja2.exceptions import UndefinedError, TemplateSyntaxError
 
@@ -38,12 +37,6 @@ class Secret(PrimaryModel):
     provider = models.CharField(max_length=100)
     parameters = models.JSONField(encoder=DjangoJSONEncoder, default=dict)
 
-    csv_headers = [
-        "name",
-        "description",
-        "provider",
-        "parameters",
-    ]
     clone_fields = [
         "provider",
     ]
@@ -54,17 +47,6 @@ class Secret(PrimaryModel):
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("extras:secret", args=[self.pk])
-
-    def to_csv(self):
-        return (
-            self.name,
-            self.description,
-            self.provider,
-            self.parameters,
-        )
-
     def rendered_parameters(self, obj=None):
         """Render self.parameters as a Jinja2 template with the given object as context."""
         try:
@@ -117,17 +99,9 @@ class SecretsGroup(OrganizationalModel):
         to=Secret, related_name="secrets_groups", through="extras.SecretsGroupAssociation", blank=True
     )
 
-    csv_headers = ["name", "description"]
-
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("extras:secretsgroup", args=[self.pk])
-
-    def to_csv(self):
-        return (self.name, self.description)
-
     def get_secret_value(self, access_type, secret_type, obj=None, **kwargs):
         """Helper method to retrieve a specific secret from this group.
 
@@ -151,6 +125,8 @@ class SecretsGroupAssociation(BaseModel):
     access_type = models.CharField(max_length=32, choices=SecretsGroupAccessTypeChoices)
     secret_type = models.CharField(max_length=32, choices=SecretsGroupSecretTypeChoices)
 
+    natural_key_field_names = ["secrets_group", "access_type", "secret_type", "secret"]
+
     class Meta:
         unique_together = (
             # Don't allow the same access-type/secret-type combination to be used more than once in the same group

nautobot/extras/models/statuses.py

@@ -7,6 +7,7 @@ from django.utils.hashable import make_hashable
 
 from nautobot.core.models.fields import ForeignKeyLimitedByContentTypes
 from nautobot.core.models.name_color_content_types import NameColorContentTypesModel
+from nautobot.core.utils.deprecation import class_deprecated
 from nautobot.extras.utils import extras_features, FeatureQuery
 
 
@@ -47,9 +48,6 @@ class StatusField(ForeignKeyLimitedByContentTypes):
         kwargs.setdefault("on_delete", models.PROTECT)
         super().__init__(*args, **kwargs)
 
-    def get_limit_choices_to(self):
-        return {"content_types": ContentType.objects.get_for_model(self.model)}
-
     def contribute_to_class(self, cls, *args, **kwargs):
         """
         Overload default so that we can assert that `.get_FOO_display` is
@@ -102,12 +100,15 @@ class StatusField(ForeignKeyLimitedByContentTypes):
             )
 
 
+@class_deprecated(message="please directly declare `status = StatusField(...)` on your model instead")
 class StatusModel(models.Model):
     """
-    Abstract base class for any model which may have statuses.
+    Deprecated abstract base class for any model which may have statuses.
+
+    Just directly include a StatusField instead for any new models.
     """
 
-    status = StatusField()
+    status = StatusField(null=True)  # for backward compatibility
 
     class Meta:
         abstract = True

nautobot/extras/models/tags.py

@@ -1,6 +1,5 @@
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
-from django.urls import reverse
 from taggit.models import TagBase, GenericUUIDTaggedItemBase
 
 from nautobot.core.choices import ColorChoices
@@ -25,8 +24,7 @@ class TagQuerySet(RestrictedQuerySet):
         """
         Return all `Tags` assigned to the given model.
         """
-        content_type = ContentType.objects.get_for_model(model._meta.concrete_model)
-        return self.filter(content_types=content_type)
+        return self.filter(content_types__model=model._meta.model_name, content_types__app_label=model._meta.app_label)
 
 
 @extras_features(
@@ -44,19 +42,11 @@ class Tag(TagBase, BaseModel, ChangeLoggedModel, CustomFieldModel, RelationshipM
         blank=True,
     )
 
-    csv_headers = ["name", "slug", "color", "description"]
-
     objects = BaseManager.from_queryset(TagQuerySet)()
 
     class Meta:
         ordering = ["name"]
 
-    def get_absolute_url(self):
-        return reverse("extras:tag", args=[self.slug])
-
-    def to_csv(self):
-        return (self.name, self.slug, self.color, self.description)
-
     def validate_content_types_removal(self, content_types_id):
         """Validate content_types to be removed are not tagged to a model"""
         errors = {}
@@ -76,12 +66,7 @@ class Tag(TagBase, BaseModel, ChangeLoggedModel, CustomFieldModel, RelationshipM
 
 class TaggedItem(BaseModel, GenericUUIDTaggedItemBase):
     tag = models.ForeignKey(to=Tag, related_name="%(app_label)s_%(class)s_items", on_delete=models.CASCADE)
-    object_id = models.UUIDField()
 
     class Meta:
         index_together = ("content_type", "object_id")
-        # TODO: unique_together = [["content_type", "object_id", "tag"]]
-
-    # TODO: This isn't a guaranteed natural key for this model (see lack of a `unique_together` above), but in practice
-    # it is "nearly" unique. Once a proper unique_together is added and accounted for, this can be removed as redundant
-    natural_key_field_names = ["content_type", "object_id", "tag"]
+        unique_together = [["content_type", "object_id", "tag"]]