autotype_decorator fails on annotated fields #9389

New Issue

adam · 2025-12-29T20:49:13+01:00

adam commented

2025-12-29 20:49:13 +01:00

Originally created by @arthanson on GitHub (Mar 26, 2024).

Originally assigned to: @arthanson on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.0

Python Version

3.8

Steps to Reproduce

Create an annotated field for a model
Add it to the filterset for the model
Use the autotype_decorator for the filterset

Run into by peteeckel when migrating the DNS plugin to NB 4

For example:

Definition of the annotation:

    def get_queryset(self):
        return (
            super()
            .get_queryset()
            .annotate(
                active=ExpressionWrapper(
                    Q(status__in=Zone.ACTIVE_STATUS_LIST), output_field=BooleanField()
                )
            )
        )

Definition in the filterset:

    active = django_filters.BooleanFilter(
        label="Zone is active",
    )

Expected Behavior

autotype_decorator should not throw an error

Observed Behavior

autotype_decorator throws a FieldDoesNotExist error.

Originally created by @arthanson on GitHub (Mar 26, 2024). Originally assigned to: @arthanson on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.0 ### Python Version 3.8 ### Steps to Reproduce 1. Create an annotated field for a model 2. Add it to the filterset for the model 3. Use the autotype_decorator for the filterset Run into by peteeckel when migrating the DNS plugin to NB 4 **For example:** Definition of the annotation: ``` def get_queryset(self): return ( super() .get_queryset() .annotate( active=ExpressionWrapper( Q(status__in=Zone.ACTIVE_STATUS_LIST), output_field=BooleanField() ) ) ) ``` Definition in the filterset: ``` active = django_filters.BooleanFilter( label="Zone is active", ) ``` ### Expected Behavior autotype_decorator should not throw an error ### Observed Behavior autotype_decorator throws a FieldDoesNotExist error.

adam added the type: bug status: accepted beta severity: low labels 2025-12-29 20:49:13 +01:00

adam closed this issue

2025-12-29 20:49:13 +01:00

adam commented

2025-12-29 20:49:14 +01:00

@peteeckel commented on GitHub (Mar 26, 2024):

I'm not sure a fix is necessary after all, at least not for the annotation I added.

After removing the decorator from fields and just leaving a BooleanFilter for the annotated field in place, the @autotype_decorator created a functional filter without any further measures:

$ curl -s -H "Authorization: Token xxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json" -H "Accept: application/json"  https://netbox.example.com/graphql/ --data '{"query": "query {netbox_dns_zone_list(filters: {active: false}) {view {name}, name, status, active}}" }' | json_pp
{
   "data" : {
      "netbox_dns_zone_list" : [
         {
            "active" : false,
            "name" : "zone13.example.com",
            "status" : "reserved",
            "view" : null
         }
      ]
   }
}

So after removing the annotation from fields all seems to be OK.

@peteeckel commented on GitHub (Mar 26, 2024): I'm not sure a fix is necessary after all, at least not for the annotation I added. After removing the decorator from `fields` and just leaving a `BooleanFilter` for the annotated field in place, the `@autotype_decorator` created a functional filter without any further measures: ``` $ curl -s -H "Authorization: Token xxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json" -H "Accept: application/json" https://netbox.example.com/graphql/ --data '{"query": "query {netbox_dns_zone_list(filters: {active: false}) {view {name}, name, status, active}}" }' | json_pp { "data" : { "netbox_dns_zone_list" : [ { "active" : false, "name" : "zone13.example.com", "status" : "reserved", "view" : null } ] } } ``` So after removing the annotation from `fields` all seems to be OK.

adam commented

2025-12-29 20:49:14 +01:00

@jeremystretch commented on GitHub (Apr 3, 2024):

@arthanson can you confirm the above? And if not, could you please assign a severity to the bug?

@jeremystretch commented on GitHub (Apr 3, 2024): @arthanson can you confirm the above? And if not, could you please assign a severity to the bug?

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