Opened 11 years ago
Last modified 5 years ago
#12096 new New feature
Model fields are not accessible as attributes of the model class
Reported by: | sejo | Owned by: | |
---|---|---|---|
Component: | Database layer (models, ORM) | Version: | 1.1 |
Severity: | Normal | Keywords: | model, docstrings, attributes |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
When using attribute docstrings in my models they will never be picked up by doctools as the attributes disappear top level from the model.
This makes me to keep separate documentation and code for djagios.
Change History (10)
comment:1 Changed 11 years ago by
comment:2 Changed 11 years ago by
Owner: | changed from nobody to Jacob |
---|---|
Status: | new → assigned |
comment:3 Changed 11 years ago by
Triage Stage: | Unreviewed → Accepted |
---|
comment:4 Changed 11 years ago by
comment:5 Changed 10 years ago by
Severity: | → Normal |
---|---|
Type: | → Bug |
comment:8 Changed 8 years ago by
Component: | Core (Other) → Database layer (models, ORM) |
---|
comment:9 Changed 5 years ago by
Owner: | Jacob deleted |
---|---|
Status: | assigned → new |
Summary: | model attributes are not set toplevel which causes doctools to miss the attribute docstrings → Model fields are not accessible as attributes of the model class |
Type: | Bug → New feature |
I'm not sure what the implementation should look like. It seems that Jacob's comment about "ModelClass.field
raises AttributeError
is obsolete.
comment:10 Changed 5 years ago by
To get this to work we need to change some low-level stuff since model fields are stripped out by the metaclass to be put in Model._meta. Since Sphinx's autodoc module allows to manually add members to a class I think it would be better to do in manually than trying to change the way Django models are constructed.
Anyway, I came up with the following code that makes Sphinx's autodoc work for Django models. It is very hackish and unsurprisingly makes some tests fail, so I'm just putting this here for the record in case anyone would want to take that over someday.
class ModelBase(type): def __getattr__(self, attr): if attr == '_meta': raise AttributeError(attr) try: return self._meta.get_field(attr) except FieldDoesNotExist: raise AttributeError(attr) @property def __dict__(self): try: model_dict = { f.name: f for f in self._meta.get_fields() } except AppRegistryNotReady: model_dict = {} model_dict.update(super(ModelBase, self).__dict__) return model_dict # Rest of ModelBase code...
This is actually because
ModelClass.field
raisesAttributeError
from the descriptor. I've been wanting to stop that, anyway -- it ought to just return theField
object.