starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Remove deprecated uses of prefetch_related from views #6643

New Issue
Closed
opened 2025-12-29 19:43:26 +01:00 by adam · 6 comments
adam commented 2025-12-29 19:43:26 +01:00
Owner
Copy Link

Originally created by @hagbarddenstore on GitHub (Jul 11, 2022).

Originally assigned to: @hagbarddenstore on GitHub.

Proposed Changes

In views which display their data in a table, the use of prefetch_related can be removed since the table itself prefetches the displayed columns internally.

This is the code doing the magic:
https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/tables/tables.py#L76

Example of code that can be removed:
https://github.com/netbox-community/netbox/blob/develop/netbox/circuits/views.py#L194

Justification

Calling prefetch_related on some views but not others, adds confusion to developers whom are fixing bugs or developing new features, as it is unclear when it's needed or not.

Originally created by @hagbarddenstore on GitHub (Jul 11, 2022). Originally assigned to: @hagbarddenstore on GitHub. ### Proposed Changes In views which display their data in a table, the use of `prefetch_related` can be removed since the table itself prefetches the displayed columns internally. This is the code doing the magic: https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/tables/tables.py#L76 Example of code that can be removed: https://github.com/netbox-community/netbox/blob/develop/netbox/circuits/views.py#L194 ### Justification Calling `prefetch_related` on some views but not others, adds confusion to developers whom are fixing bugs or developing new features, as it is unclear when it's needed or not.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 19:43:26 +01:00
adam closed this issue 2025-12-29 19:43:27 +01:00
adam commented 2025-12-29 19:43:27 +01:00
Author
Owner
Copy Link

@hagbarddenstore commented on GitHub (Jul 11, 2022):

(I discussed it with @kkthxbye-code on Slack)

I can be assigned on this.

@hagbarddenstore commented on GitHub (Jul 11, 2022): (I discussed it with @kkthxbye-code on Slack) I can be assigned on this.
adam commented 2025-12-29 19:43:27 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 11, 2022):

Bear in mind that some prefetching is still needed. The automatic prefetching looks at the accessor used for the table column, but isn't smart enough to know if additional data is needed. For example, a TemplateColumn might render data from an additional related object, in which case a manual call to prefetch that object in the queryset is still necessary.

@jeremystretch commented on GitHub (Jul 11, 2022): Bear in mind that _some_ prefetching is still needed. The automatic prefetching looks at the accessor used for the table column, but isn't smart enough to know if additional data is needed. For example, a TemplateColumn might render data from an additional related object, in which case a manual call to prefetch that object in the queryset is still necessary.
adam commented 2025-12-29 19:43:28 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 27, 2022):

@hagbarddenstore would you still like to work on this? If not, I can take care of it.

@jeremystretch commented on GitHub (Jul 27, 2022): @hagbarddenstore would you still like to work on this? If not, I can take care of it.
adam commented 2025-12-29 19:43:28 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 1, 2022):

Great work @hagbarddenstore, thank you!

@jeremystretch commented on GitHub (Aug 1, 2022): Great work @hagbarddenstore, thank you!
adam commented 2025-12-29 19:43:28 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 1, 2022):

#9886 has been merged into the feature branch.

@jeremystretch commented on GitHub (Aug 1, 2022): #9886 has been merged into the `feature` branch.
adam commented 2025-12-29 19:43:28 +01:00
Author
Owner
Copy Link

@hagbarddenstore commented on GitHub (Oct 11, 2022):

I still want to do it. I’ve just been on vacation with the kids :)

Sent from my iPhone

On 27 Jul 2022, at 17:23, Jeremy Stretch @.***> wrote:


@hagbarddenstore would you still like to work on this? If not, I can take care of it.

—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you were mentioned.

@hagbarddenstore commented on GitHub (Oct 11, 2022): I still want to do it. I’ve just been on vacation with the kids :) Sent from my iPhone > On 27 Jul 2022, at 17:23, Jeremy Stretch ***@***.***> wrote: > >  > @hagbarddenstore would you still like to work on this? If not, I can take care of it. > > — > Reply to this email directly, view it on GitHub, or unsubscribe. > You are receiving this because you were mentioned.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6643
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?