Cleanup get_viewname URL resolution and make extensible #11458

New Issue

adam · 2025-12-29T21:45:31+01:00

adam commented

2025-12-29 21:45:31 +01:00

Originally created by @arthanson on GitHub (Aug 7, 2025).

Originally assigned to: @arthanson on GitHub.

Proposed Changes

Create a new utility function alongside get_viewname tentatively called get_action_url that combines the functionality of get_viewname and reversing the URL. Also allow this function to be overridden at the model level by plugins.

Justification

utilities.views.get_viewname is used throughout the code doing basically the following:

viewname = get_viewname(instance, 'action')
url = reverse(viewname, kwargs={'pk': instance.pk})

In almost every case the URL is the only thing needed so this code can be made DRY by a combined function.

In addition, this function requires the viewname to conform to the '{app_label}:{model_name}_{action} format with a single param being the object_id. While this is valid for most plugins and models, there are cases where the plugin would need a different format (for example a URL with extra kwargs being passed in). It would be fairly easy to make the URL resolution for this function be overridable at the model-class level, for example:

def get_action_url(model, action=None, rest_api=False, kwargs=None):
    if hasattr(model, '_get_action_url'):
        return model._get_action_url(action, rest_api, kwargs)

    return reverse(get_viewname(model, action, rest_api), kwargs=kwargs)

Originally created by @arthanson on GitHub (Aug 7, 2025). Originally assigned to: @arthanson on GitHub. ### Proposed Changes Create a new utility function alongside `get_viewname` tentatively called `get_action_url` that combines the functionality of get_viewname and reversing the URL. Also allow this function to be overridden at the model level by plugins. ### Justification `utilities.views.get_viewname` is used throughout the code doing basically the following: ``` viewname = get_viewname(instance, 'action') url = reverse(viewname, kwargs={'pk': instance.pk}) ``` In almost every case the URL is the only thing needed so this code can be made DRY by a combined function. In addition, this function requires the viewname to conform to the `'{app_label}:{model_name}_{action}` format with a single param being the object_id. While this is valid for most plugins and models, there are cases where the plugin would need a different format (for example a URL with extra kwargs being passed in). It would be fairly easy to make the URL resolution for this function be overridable at the model-class level, for example: ``` def get_action_url(model, action=None, rest_api=False, kwargs=None): if hasattr(model, '_get_action_url'): return model._get_action_url(action, rest_api, kwargs) return reverse(get_viewname(model, action, rest_api), kwargs=kwargs) ```

adam added the status: accepted type: housekeeping labels 2025-12-29 21:45:31 +01:00

adam closed this issue

2025-12-29 21:45:31 +01:00

adam referenced this issue

2025-12-29 23:20:50 +01:00

[PR #11458] [MERGED] Fixes #11440 - Add the `enabled` field to InterfaceTemplate #13792

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