Skip to content

Fixes: #17492 - Changes Serializer field to prevent exceptions when plugins inherit the base serializer #17493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Fixes: #17492 - Changes Serializer field to prevent exceptions when plugins inherit the base serializer #17493

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions netbox/netbox/api/serializers/fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
from django.utils.translation import gettext_lazy as _
Copy link
Member Author

@DanSheps DanSheps Sep 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just FYI, this is to fix an error my IDE was showing that we were using _ without importing it

from rest_framework import serializers

from utilities.views import get_viewname

__all__ = (
'NetBoxAPIHyperlinkedIdentityField',
'NetBoxURLHyperlinkedIdentityField',
Expand Down Expand Up @@ -30,24 +33,22 @@ def get_url(self, obj, view_name, request, format):
lookup_value = getattr(obj, self.lookup_field)
kwargs = {self.lookup_url_kwarg: lookup_value}

model_name = self.parent.Meta.model._meta.model_name
app_name = self.parent.Meta.model._meta.app_label
view_name = self.get_view_name(app_name, model_name)
view_name = self.get_view_name(obj)
return self.reverse(view_name, kwargs=kwargs, request=request, format=format)

def get_view_name(self, app_name, model_name):
def get_view_name(self, model):
raise NotImplementedError(_('{class_name} must implement get_view_name()').format(
class_name=self.__class__.__name__
))


class NetBoxAPIHyperlinkedIdentityField(BaseNetBoxHyperlinkedIdentityField):

def get_view_name(self, app_name, model_name):
return f'{app_name}-api:{model_name}-detail'
def get_view_name(self, model):
return get_viewname(model=model, action='detail', rest_api=True)


class NetBoxURLHyperlinkedIdentityField(BaseNetBoxHyperlinkedIdentityField):

def get_view_name(self, app_name, model_name):
return f'{app_name}:{model_name}'
def get_view_name(self, model):
return get_viewname(model=model)