deserialize_object() does not account for resolved tags in object data #10882

New Issue

adam · 2025-12-29T21:37:14+01:00

adam commented

2025-12-29 21:37:14 +01:00

Originally created by @jeremystretch on GitHub (Mar 12, 2025).

Originally assigned to: @jeremystretch on GitHub.

Deployment Type

NetBox Cloud

NetBox Version

v4.2.5

Python Version

3.10

Steps to Reproduce

Create an object with one or more tags assigned. (In this example, we use a tenant.)
Serialize the object using the serialize_object() utility function.

from pprint import pprint
from tenancy.models import Tenant
from utilities.serialization import serialize_object, deserialize_object

tenant = Tenant.objects.first()
data = serialize_object(tenant)
pprint(data)

The output data is below:

{'comments': '',
 'created': '2020-12-19T00:00:00Z',
 'custom_fields': {'cust_id': 'CYB01'},
 'description': '',
 'group': 1,
 'last_updated': '2025-03-12T18:02:59.743Z',
 'name': 'Cyberdyne Systems',
 'slug': 'cyberdyne',
 'tags': ['Alpha', 'Bravo', 'Charlie']}

Attempt to deserialize the serialized data back into the object.

deserialize_object(Tenant, data)

Expected Behavior

deserialize_object() should return the deserialized object with all attributes set correctly.

Observed Behavior

A DeserializationError is raised:

django.core.serializers.base.DeserializationError: ['“Alpha” value must be an integer.']: (tenancy.tenant:pk=None) field_value was 'Alpha'

This occurs because the function does not account for the tags being specified by name rather than by numeric primary key.

Originally created by @jeremystretch on GitHub (Mar 12, 2025). Originally assigned to: @jeremystretch on GitHub. ### Deployment Type NetBox Cloud ### NetBox Version v4.2.5 ### Python Version 3.10 ### Steps to Reproduce 1. Create an object with one or more tags assigned. (In this example, we use a tenant.) 2. Serialize the object using the `serialize_object()` utility function. ```python from pprint import pprint from tenancy.models import Tenant from utilities.serialization import serialize_object, deserialize_object tenant = Tenant.objects.first() data = serialize_object(tenant) pprint(data) ``` The output data is below: ```python {'comments': '', 'created': '2020-12-19T00:00:00Z', 'custom_fields': {'cust_id': 'CYB01'}, 'description': '', 'group': 1, 'last_updated': '2025-03-12T18:02:59.743Z', 'name': 'Cyberdyne Systems', 'slug': 'cyberdyne', 'tags': ['Alpha', 'Bravo', 'Charlie']} ``` 3. Attempt to deserialize the serialized data back into the object. ```python deserialize_object(Tenant, data) ``` ### Expected Behavior `deserialize_object()` should return the deserialized object with all attributes set correctly. ### Observed Behavior A DeserializationError is raised: ``` django.core.serializers.base.DeserializationError: ['“Alpha” value must be an integer.']: (tenancy.tenant:pk=None) field_value was 'Alpha' ``` This occurs because the function does not account for the tags being specified by name rather than by numeric primary key.

adam added the type: bug status: accepted severity: medium labels 2025-12-29 21:37:14 +01:00

adam closed this issue

2025-12-29 21:37:15 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#10882

deserialize_object() does not account for resolved tags in object data #10882