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 all ForeignKey references from model __str__ methods #2158

New Issue
Closed
opened 2025-12-29 17:22:48 +01:00 by adam · 0 comments
adam commented 2025-12-29 17:22:48 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Nov 28, 2018).

Proposed Changes

There are some instances where the __str__() method of a model references a field on a related model. For example:

class Circuit(ChangeLoggedModel, CustomFieldModel):
    ...
    def __str__(self):
        return '{} {}'.format(self.provider, self.cid)

We should rewrite these methods to ensure that they only reference local properties.

Justification

This is inefficient as it generates a database query for the lookup, unless care was taken to include the related field in the queryset used to retrieve the instance(s). Additionally, it can trigger a RelatedObjectDoesNotExist exception when attempting to print the model class (see #2623).

Originally created by @jeremystretch on GitHub (Nov 28, 2018). ### Proposed Changes There are some instances where the `__str__()` method of a model references a field on a related model. For example: ``` class Circuit(ChangeLoggedModel, CustomFieldModel): ... def __str__(self): return '{} {}'.format(self.provider, self.cid) ``` We should rewrite these methods to ensure that they only reference local properties. ### Justification This is inefficient as it generates a database query for the lookup, unless care was taken to include the related field in the queryset used to retrieve the instance(s). Additionally, it can trigger a `RelatedObjectDoesNotExist` exception when attempting to print the model class (see #2623).
adam closed this issue 2025-12-29 17:22:48 +01:00
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
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#2158
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?