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

Old Django Taggit codenames not removed #2739

New Issue
Closed
opened 2025-12-29 18:21:35 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:21:35 +01:00
Owner
Copy Link

Originally created by @bdlamprecht on GitHub (Jul 12, 2019).

Environment

  • Python version: 3.6.8
  • NetBox version: v2.6.1

Similar to issue #2624 and interface-connections, when the custom tag models for Django was introduced, the old standard taggit models were not removed during any migration.

This is an issue for when you want to programatically assign permissions to users/groups (as is available in netbox-docker).

The evidence can be seen by following the steps below.

Steps to Reproduce

  1. Enter the python shell
  2. Import the Django Permission library
  3. Loop over and print each codename
$ cd /opt/netbox/netbox
$ ./manage.py shell

>>> from django.contrib.auth.models import Permission
>>> for p in Permission.objects.all():
>>>  print(p.codename)

What you see is two sets of permissions for tags with the same name.
On lines 207 - 214:

add_tag
change_tag
delete_tag
view_tag
add_taggeditem
change_taggeditem
delete_taggeditem
view_taggeditem

And another set on lines 280-287:

add_tag
change_tag
delete_tag
view_tag
add_taggeditem
change_taggeditem
delete_taggeditem
view_taggeditem

Expected Behavior

Be able to add permissions to users / groups programatically.

Observed Behavior

When bringing up netbox, this error occurs:

django.contrib.auth.models.MultipleObjectsReturned: get() returned more than one Permission -- it returned 2!
Originally created by @bdlamprecht on GitHub (Jul 12, 2019). ### Environment * Python version: 3.6.8 * NetBox version: v2.6.1 Similar to issue #2624 and `interface-connections`, when the custom `tag` models for Django was introduced, the old standard `taggit` models were not removed during any migration. This is an issue for when you want to programatically assign permissions to users/groups (as is available in `netbox-docker`). The evidence can be seen by following the steps below. ### Steps to Reproduce 1. Enter the python shell 2. Import the Django `Permission` library 3. Loop over and print each codename ``` $ cd /opt/netbox/netbox $ ./manage.py shell >>> from django.contrib.auth.models import Permission >>> for p in Permission.objects.all(): >>> print(p.codename) ``` What you see is **two** sets of permissions for `tags` with the same name. On lines `207 - 214`: ``` add_tag change_tag delete_tag view_tag add_taggeditem change_taggeditem delete_taggeditem view_taggeditem ``` And another set on lines `280-287`: ``` add_tag change_tag delete_tag view_tag add_taggeditem change_taggeditem delete_taggeditem view_taggeditem ``` <!-- What did you expect to happen? --> ### Expected Behavior Be able to add permissions to users / groups programatically. <!-- What happened instead? --> ### Observed Behavior When bringing up `netbox`, this error occurs: ``` django.contrib.auth.models.MultipleObjectsReturned: get() returned more than one Permission -- it returned 2! ```
adam closed this issue 2025-12-29 18:21:35 +01:00
adam commented 2025-12-29 18:21:35 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 16, 2019):

To clarify, one set of permissions is for extras.Tag and the other is for taggit.Tag:

>>> for p in Permission.objects.all():
...     if p.codename.endswith('tag'):
...         print(p.content_type.app_label, p.codename)
... 
extras add_tag
extras change_tag
extras delete_tag
extras view_tag
taggit add_tag
taggit change_tag
taggit delete_tag
taggit view_tag

Permission code names aren't necessarily unique on their own: only the set (content_type, codename) must be unique. NetBox doesn't currently have any duplicate model names, but this might not always be the case: #2199 for instance would result in two models named "Role." It's a good idea to get into the habit now of not assuming model names to be unique.

Beside that, the Tag model provided by django-taggit is still technically in use (since the model is installed by the package); it wouldn't make sense to remove the permission objects for it.

@jeremystretch commented on GitHub (Jul 16, 2019): To clarify, one set of permissions is for `extras.Tag` and the other is for `taggit.Tag`: ``` >>> for p in Permission.objects.all(): ... if p.codename.endswith('tag'): ... print(p.content_type.app_label, p.codename) ... extras add_tag extras change_tag extras delete_tag extras view_tag taggit add_tag taggit change_tag taggit delete_tag taggit view_tag ``` Permission code names aren't necessarily unique on their own: only the set `(content_type, codename)` must be unique. NetBox doesn't currently have any duplicate model names, but this might not always be the case: #2199 for instance would result in two models named "Role." It's a good idea to get into the habit now of not assuming model names to be unique. Beside that, the Tag model provided by `django-taggit` is still technically in use (since the model is installed by the package); it wouldn't make sense to remove the permission objects for it.
adam commented 2025-12-29 18:21:35 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 16, 2019):

Related: I did open #3347 to extend the upgrade process to include removing stale content types. This won't affect the taggit.Tag model or its permissions but there are a couple other content types that are due to be removed.

@jeremystretch commented on GitHub (Jul 16, 2019): Related: I did open #3347 to extend the upgrade process to include removing stale content types. This won't affect the `taggit.Tag` model or its permissions but there are a couple other content types that are due to be removed.
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#2739
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?