From 3145f7d7e660add640a692a21c8b63713979276e Mon Sep 17 00:00:00 2001 From: Frazer McLean Date: Tue, 26 Jul 2016 00:02:03 +0200 Subject: Add docstring to declarative_base --- lib/sqlalchemy/ext/declarative/api.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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 -- cgit v1.2.1