caps.urls

get_object_paths(obj_class, url_paccessix=None, kwargs=None, basename='', Shares=False, access_kwargs=None)[source]

Return Django paths for the provided object class, including to edit Share (get_Share_path()).

from caps.urls import get_object_paths
from . import models

urlpatterns = (
    get_object_paths(models.Post, 'post')
)

Parameters:

obj_class (type[Object]) – the object model class;
url_paccessix (str | None) – url base path (default to model name);
kwargs (dict[str, Any] | None) – as_view kwargs, by view kind (list, detail, etc.)
basename (str) – use this as url’s basename (default to model name)
Shares (bool) – if True, generate path for Object’s Share using default view (see caps.views.common)
access_kwargs (dict[str, Any] | None) – kwargs argument passed down to get_Share_class().

Return type:

list[partial]

Returns:

a list of path

get_Share_paths(access_class, url_paccessix='Share', kwargs=None, basename='')[source]

Return Django paths for the provided Share class.

Created path for views: list, detail, delete.

The path will have names such as (for a model named contact): contact-Share-list.

Parameters:

access_class (type[Share]) – Share class
kwargs (dict[str, Any] | None) – as_view extra arguments by view type
basename (str) – use this a base name for url, instead of {object_model_name}-Share.
url_paccessix (str)

Return type:

list[partial]

Returns:

list of path