Hopiu/django-eav2
1
0
Fork 0
mirror of https://github.com/jazzband/django-eav2.git synced 2026-04-09 18:01:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add docstring for the EavConfig (#5)

Browse source
This commit is contained in:
Iwo Herka 2018-06-01 14:36:46 +02:00
parent b6e4231f6b
commit a4a3511c56
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
eav/registry.py
View file

@ -19,8 +19,21 @@ from .models import Attribute, Entity, Value
class EavConfig(object):
'''
The default EevConfig class used if it is not overriden on registration.
The default EavConfig class used if it is not overriden on registration.
This is where all the default eav attribute names are defined.
Available options are as follows:
1. manager_attr - Specifies manager name. Used to refer to the
manager from Entity class, "objects" by default.
2. manager_only - Specifies whether signals and generic relation should
be setup for the registered model.
3. eav_attr - Named of the Entity toolkit instance on the registered
model instance. "eav" by default. See attach_eav_attr.
4. generic_relation_attr - Name of the GenericRelation to Value
objects. "eav_values" by default.
5. generic_relation_related_name - Name of the related name for
GenericRelation from Entity to Value. None by default. Therefore,
if not overridden, it is not possible to query Values by Entities.
'''
manager_attr = 'objects'