Reverse accessor on Tags for plugins

[bkampsnl]

Hi,

I'm trying to fix an issue in a conflict between the bgp and netbox-routing plugins.

Both plugins have a PrefixList class that derives from NetboxModel. Both classes are in their own namespace but there is a conflict in the tags (derived from NetboxModel>TagsMixin.

When I use both plugins I get the following error during database migration:

ERRORS:
netbox_bgp.PrefixList.tags: (fields.E304) Reverse accessor 'Tag.prefixlist_set' for 'netbox_bgp.PrefixList.tags' clashes with reverse accessor for 'netbox_routing.PrefixList.tags'.
        HINT: Add or change a related_name argument to the definition for 'netbox_bgp.PrefixList.tags' or 'netbox_routing.PrefixList.tags'.
netbox_routing.PrefixList.tags: (fields.E304) Reverse accessor 'Tag.prefixlist_set' for 'netbox_routing.PrefixList.tags' clashes with reverse accessor for 'netbox_bgp.PrefixList.tags'.
        HINT: Add or change a related_name argument to the definition for 'netbox_routing.PrefixList.tags' or 'netbox_bgp.PrefixList.tags'.

I'm trying to fix it but i'm not sure how. The related_name field should be changed so there is no clash. But is this issue in the base class TagsMixin?

[DanSheps]

I'm trying to fix it but i'm not sure how. The related_name field should be changed so there is no clash. But is this issue in the base class TagsMixin?

This is an issue between the netbox_bgp plugin and the netbox_routing plugin. There is no fixing it on your end, and this likely can't be fixed within the tag mixin either (without creating longer names for the reverse accessors) however this does beg the question, do we need to track the reverse accessor on a Tag?

[bkampsnl]

I'm trying to fix the issue in one of the plugins and create a pull request so it can be merged into the codebase.

So the only way this could be fixed is when one of the plugins change the classname PrefixList to something else?

[DanSheps]

I'm trying to fix the issue in one of the plugins and create a pull request so it can be merged into the codebase.

So the only way this could be fixed is when one of the plugins change the classname PrefixList to something else?

Yes, that is the only way

[lel-amri]

Hello there,

I'm implementing a module for NetBox 4.2.9 that has a model named Cluster. Its accessor collides with NetBox's built-in virtualization.Cluster model. Checking NetBox's django-taggit's through model, I found the following code:

class TaggedItem(GenericTaggedItemBase):
    tag = models.ForeignKey(
        to=Tag,
        related_name="%(app_label)s_%(class)s_items",
        on_delete=models.CASCADE
    )
    ...

It appears that the reverse accessor name is set to something that includes the application name, but it looks like it's not taken into account. Could something elsewhere be overriding the expected Django behavior?

[DanSheps]

You should rename the model to something else if you can. Alternatively, it would be nice if a check was done to for the plugin namespace.