Route class

CRUDLFA+ introduces an MVC-ish pattern, as the Router class is meant to sit between a Model class and its set of View. Your views will have to inherit from Route to work in Router.views. This structural decision made for you by CRUDLFA+ was not exactly designed: it’s an open source rewrite of a module that was ordered in a proprietary project.

class crudlfap.route.Route

The mixin for Views that will make it compatible with Router.

authenticate

False by default, it makes the default has_perm() implementation require Django permission.

urlargs

Args that should be passed to reverse() along with Route.urlfullname.

url

Absolute url to the view, relying on Route.urlfullname and Route.urlargs.

You will be able to check if a user has access to a view with a given object for example as such:

crudlfap.site[YourModel]['detail'].clone(
    request=request,
    object=obj,
).has_perm()

If you want to open a View to all, set authenticate=False, examples:

class YourDetailView(DetailView):
    authenticate = False

class YourRouter(Router):
    views = [
        YourDetailView,
        ListView.clone(authenticate=False),  # example with clone
    ]

Without authenticate=False, the default has_perm() implementation requires the request user to have the permission corresponding to the permission_fullcode attribute.

To create the permission with permission_fullcode, you can browse in your CRUDLFA+ site and navigate to URL list view, for each URL you have link in the menu called “authorized” that lets you select which groups have this permission: it will auto-create the permission in the database if necessary.

classmethod abstract(**kwargs)

Return an instance of this view.

dispatch(request, *args, **kwargs)

This will run has_perm prior to super().dispatch().

get_permission_codename()

Return the codename attribute for the view Permission.

get_permission_fullcode()

Return a string with the app name, permission_shortcode and model name.

get_permission_shortcode()

Return the middle part for the view permission.

Returns the urlname by default.

get_url()

Return the URL for this view given its current state. Given that the reverse() method is a class method, this should allow things like:

url = YourView(object=your_object).url

get_urlargs()

Return args for reversing this view url from self. See self.reverse() for detail.

has_perm()

Called to decide if user has the permission to execute this view.

This is what you should override to code view level permission logic, unless you want to use a Django permission backend.

If unsure, you probably need to just define Router.has_perm.

Default behaviour:

• return True if the view authenticate attribute has been overridden to False

• return self.router.has_perm(self) if the view has a router

• return self.has_perm_backend otherwise, to let a Django permission backend decide

has_perm_backend()

Django Authentication backend has_perm() call.

This is called by Route.has_perm by default, from Router.has_perm is the view has a router object, and useful only if you implement your own permission backend, or add crudlfap_auth.backends.ViewBackend to settings.AUTHENTICATION_BACKENDS, or implement your own View permission backend.

If unsure, you probably need to just define Router.has_perm.

classmethod reverse(*args, **kwargs)

Reverse a url to this view with the given args.

class crudlfap.route.RouteMetaclass

Base autocalculations for views.

app_name

The view’s app name.

model

The view’s model if any.

urlpath

The path for the url path definition.

label

The view label, serves as key in a Router.views.

urlpattern

The Django URL path() instance, for inclusion in url lists.

urlfullname

The full name to reverse the URL, with namespaces if any.

urlfield

The default model field that will be use to match in the URL. It can be pk, or name, slug …

get_app_name()

Return the model’s app_name or None.

get_label()

Return a readable label for this view.

Strips View and Route from class name, also removes the model class name if it finds it: for YourModelUpdateView this returns update.

get_model()

Return the router’s model or None.

get_urlfield()

Return the router urlfield if any, else guess_urlfield()

get_urlfullname()

Return the url name eventually with router and site namespaces.

get_urlname()

Return a string that can be used as url name.

get_urlpath()

Return the urlname.

get_urlpattern()

Return the Django URL object to include in a urlpatterns.