summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrazer McLean <frazer@frazermclean.co.uk>2016-07-26 00:02:03 +0200
committerFrazer McLean <frazer@frazermclean.co.uk>2016-07-26 00:04:19 +0200
commit3145f7d7e660add640a692a21c8b63713979276e (patch)
tree5ce4f5df312a2a739acf5d65292e09110a63dd2f
parent96c4208bf83607120d2f716070ed22ee10312dd0 (diff)
downloadsqlalchemy-pr/295.tar.gz
Add docstring to declarative_basepr/295
-rw-r--r--lib/sqlalchemy/ext/declarative/api.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/sqlalchemy/ext/declarative/api.py b/lib/sqlalchemy/ext/declarative/api.py
index 54e78ee1a..1d84d3416 100644
--- a/lib/sqlalchemy/ext/declarative/api.py
+++ b/lib/sqlalchemy/ext/declarative/api.py
@@ -246,7 +246,7 @@ class _stateful_declared_attr(declared_attr):
def declarative_base(bind=None, metadata=None, mapper=None, cls=object,
name='Base', constructor=_declarative_constructor,
class_registry=None,
- metaclass=DeclarativeMeta):
+ metaclass=DeclarativeMeta, doc=None):
"""Construct a base class for declarative class definitions.
The new base class will be given a metaclass that produces
@@ -321,6 +321,8 @@ def declarative_base(bind=None, metadata=None, mapper=None, cls=object,
class_dict['__init__'] = constructor
if mapper:
class_dict['__mapper_cls__'] = mapper
+ if doc:
+ class_dict['__doc__'] = doc
return metaclass(name, bases, class_dict)
@@ -358,6 +360,7 @@ def as_declarative(**kw):
def decorate(cls):
kw['cls'] = cls
kw['name'] = cls.__name__
+ kw['doc'] = cls.__doc__
return declarative_base(**kw)
return decorate