Refactor REST API serializers to avoid circular imports

netbox/core/api/serializers.py

@@ -1,75 +1,3 @@
-from rest_framework import serializers
-
-from core.choices import *
-from core.models import *
-from netbox.api.fields import ChoiceField, ContentTypeField, RelatedObjectCountField
-from netbox.api.serializers import BaseModelSerializer, NetBoxModelSerializer
-from netbox.utils import get_data_backend_choices
-from users.api.serializers import UserSerializer
-
-__all__ = (
-    'DataFileSerializer',
-    'DataSourceSerializer',
-    'JobSerializer',
-)
-
-
-class DataSourceSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name='core-api:datasource-detail'
-    )
-    type = ChoiceField(
-        choices=get_data_backend_choices()
-    )
-    status = ChoiceField(
-        choices=DataSourceStatusChoices,
-        read_only=True
-    )
-
-    # Related object counts
-    file_count = RelatedObjectCountField('datafiles')
-
-    class Meta:
-        model = DataSource
-        fields = [
-            'id', 'url', 'display', 'name', 'type', 'source_url', 'enabled', 'status', 'description', 'comments',
-            'parameters', 'ignore_rules', 'custom_fields', 'created', 'last_updated', 'file_count',
-        ]
-        brief_fields = ('id', 'url', 'display', 'name', 'description')
-
-
-class DataFileSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name='core-api:datafile-detail'
-    )
-    source = DataSourceSerializer(
-        nested=True,
-        read_only=True
-    )
-
-    class Meta:
-        model = DataFile
-        fields = [
-            'id', 'url', 'display', 'source', 'path', 'last_updated', 'size', 'hash',
-        ]
-        brief_fields = ('id', 'url', 'display', 'path')
-
-
-class JobSerializer(BaseModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name='core-api:job-detail')
-    user = UserSerializer(
-        nested=True,
-        read_only=True
-    )
-    status = ChoiceField(choices=JobStatusChoices, read_only=True)
-    object_type = ContentTypeField(
-        read_only=True
-    )
-
-    class Meta:
-        model = Job
-        fields = [
-            'id', 'url', 'display', 'object_type', 'object_id', 'name', 'status', 'created', 'scheduled', 'interval',
-            'started', 'completed', 'user', 'data', 'error', 'job_id',
-        ]
-        brief_fields = ('url', 'created', 'completed', 'user', 'status')
+from .serializers_.data import *
+from .serializers_.jobs import *
+from .nested_serializers import *

netbox/core/api/serializers_/data.py

@@ -0,0 +1,53 @@
+from rest_framework import serializers
+
+from core.choices import *
+from core.models import DataFile, DataSource
+from netbox.api.fields import ChoiceField, RelatedObjectCountField
+from netbox.api.serializers import NetBoxModelSerializer
+from netbox.utils import get_data_backend_choices
+
+__all__ = (
+    'DataFileSerializer',
+    'DataSourceSerializer',
+)
+
+
+class DataSourceSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='core-api:datasource-detail'
+    )
+    type = ChoiceField(
+        choices=get_data_backend_choices()
+    )
+    status = ChoiceField(
+        choices=DataSourceStatusChoices,
+        read_only=True
+    )
+
+    # Related object counts
+    file_count = RelatedObjectCountField('datafiles')
+
+    class Meta:
+        model = DataSource
+        fields = [
+            'id', 'url', 'display', 'name', 'type', 'source_url', 'enabled', 'status', 'description', 'comments',
+            'parameters', 'ignore_rules', 'custom_fields', 'created', 'last_updated', 'file_count',
+        ]
+        brief_fields = ('id', 'url', 'display', 'name', 'description')
+
+
+class DataFileSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='core-api:datafile-detail'
+    )
+    source = DataSourceSerializer(
+        nested=True,
+        read_only=True
+    )
+
+    class Meta:
+        model = DataFile
+        fields = [
+            'id', 'url', 'display', 'source', 'path', 'last_updated', 'size', 'hash',
+        ]
+        brief_fields = ('id', 'url', 'display', 'path')

netbox/core/api/serializers_/jobs.py

@@ -0,0 +1,31 @@
+from rest_framework import serializers
+
+from core.choices import *
+from core.models import Job
+from netbox.api.fields import ChoiceField, ContentTypeField
+from netbox.api.serializers import BaseModelSerializer
+from users.api.serializers_.users import UserSerializer
+
+__all__ = (
+    'JobSerializer',
+)
+
+
+class JobSerializer(BaseModelSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='core-api:job-detail')
+    user = UserSerializer(
+        nested=True,
+        read_only=True
+    )
+    status = ChoiceField(choices=JobStatusChoices, read_only=True)
+    object_type = ContentTypeField(
+        read_only=True
+    )
+
+    class Meta:
+        model = Job
+        fields = [
+            'id', 'url', 'display', 'object_type', 'object_id', 'name', 'status', 'created', 'scheduled', 'interval',
+            'started', 'completed', 'user', 'data', 'error', 'job_id',
+        ]
+        brief_fields = ('url', 'created', 'completed', 'user', 'status')