Add class name interpolation in Meta.permissions codenames
|Reported by:||faldridge||Owned by:||sergei-maertens|
|Component:||Database layer (models, ORM)||Version:||master|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||yes|
I've got a patch for a slight behavior modification that I needed and that might be useful for others, and I wanted to collect some thoughts on it before writing up the regression tests and documentation changes.
Twice now, I've come across a situation where the default Django behavior for inheriting permissions is inappropriate for my security model.
Here's the situation: I have a permission on an abstract base model class that I want all child classes to inherit, and I want to then append specific permission(s) to one or more of the children.
class MyAppBaseModel(models.Model): class Meta: abstract = True permissions = (("view_%(class)s", "Can view %(class)s"),) class ChildModel(MyAppBaseModel): class Meta: permissions = (("foobar_childmodel", "Can foobar childmodel"),)
Two problems arise:
- Although permissions currently may be inherited, the Options class does not currently implement %(class)s replacement like the RelatedField class does, so my permissions end up actually being stored in the database with %(class)s in the name and codename.
- The way Meta attributes are currently processed in the ModelBase metaclass causes inherited permissions to be completely replaced if any explicit permissions are defined on the child class. So instead of can_view and can_foobar on ChildModel, I only get can_foobar.
This patch changes Django's behavior such that any explicit child class permissions would be appended to the inherited ones, rather than completely replacing them.
Also, I've added a backwards-compatible flag to the Meta options, 'inherit_permissions'. This flag would only be required in the case that one wanted Django's current behavior which is to discard base class permissions when explicit permissions are declared on the child class.
class MyAppBaseModel(models.Model): class Meta: abstract = True permissions = (("view_%(class)s", "Can view %(class)s"),) class ChildModel(MyAppBaseModel): class Meta: permissions = (("foobar_childmodel", "Can foobar childmodel"),) inherit_permissions = False
This would result in ChildModel only having the can_foobar permission (Django's current behavior). If you wanted to inherit/append the view_class
permission instead (proposed behavior), you could set the attribute to True or leave it out entirely.
This, of course, assumes that my desired behavior is what most other people would want. I suspect, but am not certain that this is the case.
Though a small change, I believe it requires a design decision.
Change History (24)
Changed 7 years ago by faldridge
comment:1 Changed 7 years ago by jacob
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Triage Stage changed from Unreviewed to Design decision needed
Changed 5 years ago by Soby
comment:6 Changed 3 years ago by akaariai
- Triage Stage changed from Design decision needed to Accepted
comment:9 Changed 7 months ago by sergei-maertens
- Owner changed from nobody to sergei-maertens
- Status changed from new to assigned
comment:15 Changed 8 weeks ago by sergei-maertens
- Patch needs improvement unset
comment:16 Changed 7 weeks ago by timgraham
- Summary changed from 2 simple improvements to permission inheritance. to Add class name interpolation in Meta.permissions codenames