Simplify the declaration of custom field support in models #5957

New Issue

adam · 2025-12-29T19:34:54+01:00

adam commented

2025-12-29 19:34:54 +01:00

Originally created by @jeremystretch on GitHub (Jan 17, 2022).

Proposed Changes

Currently, a NetBox model must meet two conditions for custom fields to function properly:

Inherit from CustomFieldsMixin
Register as having custom fields via the extras_features() decorator

The second step is redundant, given that it should be assumed that any model inheriting from CustomFieldsMixin supports custom fields. However, failing to register via extras_features() excludes the model from the list of available models when creating a custom field, and from other such selections.

We can obviate the need to register the model explicitly by instead connecting a receiver function to Django's class_prepared signal and checking for custom field support on the class.

Justification

Eliminates redundant code and reduces the possibility for human error.

Originally created by @jeremystretch on GitHub (Jan 17, 2022). ### Proposed Changes Currently, a NetBox model must meet two conditions for custom fields to function properly: 1. Inherit from CustomFieldsMixin 2. Register as having custom fields via the `extras_features()` decorator The second step is redundant, given that it should be assumed that any model inheriting from CustomFieldsMixin supports custom fields. However, failing to register via `extras_features()` excludes the model from the list of available models when creating a custom field, and from other such selections. We can obviate the need to register the model explicitly by instead connecting a receiver function to Django's [`class_prepared` signal](https://docs.djangoproject.com/en/4.0/ref/signals/#class-prepared) and checking for custom field support on the class. ### Justification Eliminates redundant code and reduces the possibility for human error.

adam added the type: housekeeping label 2025-12-29 19:34:54 +01:00

adam closed this issue

2025-12-29 19:34:54 +01:00

adam commented

2025-12-29 19:34:54 +01:00

@jeremystretch commented on GitHub (Jan 17, 2022):

A similar issue exists with the declaration of support for tags: A model must both inherit from TagsMixin (to receive the appropriate manager) and register via extras_features().

@jeremystretch commented on GitHub (Jan 17, 2022): A similar issue exists with the declaration of support for tags: A model must both inherit from TagsMixin (to receive the appropriate manager) and register via `extras_features()`.

adam commented

2025-12-29 19:34:54 +01:00

@jeremystretch commented on GitHub (Jan 28, 2022):

This has been resolved under #8392.

@jeremystretch commented on GitHub (Jan 28, 2022): This has been resolved under #8392.

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#5957