diff options
Diffstat (limited to 'lib/sqlalchemy')
| -rw-r--r-- | lib/sqlalchemy/ext/assignmapper.py | 31 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/mapper.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/query.py | 15 | ||||
| -rw-r--r-- | lib/sqlalchemy/util.py | 23 |
4 files changed, 49 insertions, 22 deletions
diff --git a/lib/sqlalchemy/ext/assignmapper.py b/lib/sqlalchemy/ext/assignmapper.py index 730b5313b..0fe203f9d 100644 --- a/lib/sqlalchemy/ext/assignmapper.py +++ b/lib/sqlalchemy/ext/assignmapper.py @@ -1,7 +1,7 @@ from sqlalchemy import util, exceptions import types from sqlalchemy.orm import mapper, Query - + def _monkeypatch_query_method(name, ctx, class_): def do(self, *args, **kwargs): query = Query(class_, session=ctx.current) @@ -11,7 +11,7 @@ def _monkeypatch_query_method(name, ctx, class_): do.__name__ = name except: pass - if not hasattr(class_, name): + if not hasattr(class_, name): setattr(class_, name, classmethod(do)) def _monkeypatch_session_method(name, ctx, class_): @@ -22,11 +22,10 @@ def _monkeypatch_session_method(name, ctx, class_): do.__name__ = name except: pass - if not hasattr(class_, name): + if not hasattr(class_, name): setattr(class_, name, do) - + def assign_mapper(ctx, class_, *args, **kwargs): - util.warn_deprecated("assign_mapper is deprecated. Use scoped_session() instead.") extension = kwargs.pop('extension', None) if extension is not None: extension = util.to_list(extension) @@ -35,26 +34,32 @@ def assign_mapper(ctx, class_, *args, **kwargs): extension = ctx.mapper_extension validate = kwargs.pop('validate', False) - + if not isinstance(getattr(class_, '__init__'), types.MethodType): def __init__(self, **kwargs): for key, value in kwargs.items(): if validate: - if not self.mapper.get_property(key, resolve_synonyms=False, raiseerr=False): - raise exceptions.ArgumentError("Invalid __init__ argument: '%s'" % key) + if not self.mapper.get_property(key, + resolve_synonyms=False, + raiseerr=False): + raise exceptions.ArgumentError( + "Invalid __init__ argument: '%s'" % key) setattr(self, key, value) class_.__init__ = __init__ - + class query(object): def __getattr__(self, key): return getattr(ctx.current.query(class_), key) def __call__(self): return ctx.current.query(class_) - if not hasattr(class_, 'query'): + if not hasattr(class_, 'query'): class_.query = query() - - for name in ('get', 'filter', 'filter_by', 'select', 'select_by', 'selectfirst', 'selectfirst_by', 'selectone', 'selectone_by', 'get_by', 'join_to', 'join_via', 'count', 'count_by', 'options', 'instances'): + + for name in ('get', 'filter', 'filter_by', 'select', 'select_by', + 'selectfirst', 'selectfirst_by', 'selectone', 'selectone_by', + 'get_by', 'join_to', 'join_via', 'count', 'count_by', + 'options', 'instances'): _monkeypatch_query_method(name, ctx, class_) for name in ('refresh', 'expire', 'delete', 'expunge', 'update'): _monkeypatch_session_method(name, ctx, class_) @@ -63,3 +68,5 @@ def assign_mapper(ctx, class_, *args, **kwargs): class_.mapper = m return m +assign_mapper = util.deprecated( + assign_mapper, "assign_mapper is deprecated. Use scoped_session() instead.") diff --git a/lib/sqlalchemy/orm/mapper.py b/lib/sqlalchemy/orm/mapper.py index 2df7926aa..19e9c35e9 100644 --- a/lib/sqlalchemy/orm/mapper.py +++ b/lib/sqlalchemy/orm/mapper.py @@ -845,7 +845,7 @@ class Mapper(object): import sqlalchemy.orm.query return sqlalchemy.orm.Query(self, session).instances(cursor, *mappers, **kwargs) - instances = util.deprecated(instances, False) + instances = util.deprecated(instances, add_deprecation_to_docstring=False) def identity_key_from_row(self, row): """Return an identity-map key for use in storing/retrieving an diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index 91d157fdd..190530c54 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -1344,11 +1344,16 @@ class Query(object): return self._legacy_filter_by(*args, **params).one() -for deprecated_method in ['list', 'scalar', 'count_by', - 'select_whereclause', 'get_by', 'select_by', 'join_by', 'selectfirst', - 'selectone', 'select', 'execute', 'select_statement', 'select_text', - 'join_to', 'join_via', 'selectfirst_by', 'selectone_by']: - setattr(Query, deprecated_method, util.deprecated(getattr(Query, deprecated_method), False)) + +for deprecated_method in ('list', 'scalar', 'count_by', + 'select_whereclause', 'get_by', 'select_by', + 'join_by', 'selectfirst', 'selectone', 'select', + 'execute', 'select_statement', 'select_text', + 'join_to', 'join_via', 'selectfirst_by', + 'selectone_by'): + setattr(Query, deprecated_method, + util.deprecated(getattr(Query, deprecated_method), + add_deprecation_to_docstring=False)) Query.logger = logging.class_logger(Query) diff --git a/lib/sqlalchemy/util.py b/lib/sqlalchemy/util.py index 1d4218748..1784f9917 100644 --- a/lib/sqlalchemy/util.py +++ b/lib/sqlalchemy/util.py @@ -833,12 +833,27 @@ class ScopedRegistry(object): def warn_deprecated(msg): warnings.warn(logging.SADeprecationWarning(msg), stacklevel=3) -def deprecated(func, add_deprecation_to_docstring=True): +def deprecated(func, message=None, add_deprecation_to_docstring=True): + if message is not None: + warning = message % dict(func=func.__name__) + else: + warning = "Call to deprecated function %s" % func.__name__ + def func_with_warning(*args, **kwargs): - warnings.warn(logging.SADeprecationWarning("Call to deprecated function %s" % func.__name__), - stacklevel=2) + if self.warn: + warnings.warn(logging.SADeprecationWarning(warning), + stacklevel=2) return func(*args, **kwargs) - func_with_warning.__doc__ = (add_deprecation_to_docstring and 'Deprecated.\n' or '') + str(func.__doc__) + func_with_warning.warn = True + self = func_with_warning + + doc = func.__doc__ is not None and func.__doc__ or '' + + if add_deprecation_to_docstring: + header = message is not None and warning or 'Deprecated.' + doc = '\n'.join((header.rstrip(), doc)) + + func_with_warning.__doc__ = doc func_with_warning.__dict__.update(func.__dict__) try: func_with_warning.__name__ = func.__name__ |