openmedialibrary_platform_l.../lib/python3.4/site-packages/sqlalchemy/event/legacy.py

170 lines
5.7 KiB
Python
Raw Normal View History

2016-02-06 09:38:49 +00:00
# event/legacy.py
2016-02-22 11:49:42 +00:00
# Copyright (C) 2005-2016 the SQLAlchemy authors and contributors
2016-02-06 09:38:49 +00:00
# <see AUTHORS file>
#
# This module is part of SQLAlchemy and is released under
# the MIT License: http://www.opensource.org/licenses/mit-license.php
"""Routines to handle adaption of legacy call signatures,
generation of deprecation notes and docstrings.
"""
from .. import util
def _legacy_signature(since, argnames, converter=None):
def leg(fn):
if not hasattr(fn, '_legacy_signatures'):
fn._legacy_signatures = []
fn._legacy_signatures.append((since, argnames, converter))
return fn
return leg
2016-02-22 11:49:42 +00:00
def _wrap_fn_for_legacy(dispatch_collection, fn, argspec):
for since, argnames, conv in dispatch_collection.legacy_signatures:
2016-02-06 09:38:49 +00:00
if argnames[-1] == "**kw":
has_kw = True
argnames = argnames[0:-1]
else:
has_kw = False
if len(argnames) == len(argspec.args) \
and has_kw is bool(argspec.keywords):
if conv:
assert not has_kw
def wrap_leg(*args):
return fn(*conv(*args))
else:
def wrap_leg(*args, **kw):
2016-02-22 11:49:42 +00:00
argdict = dict(zip(dispatch_collection.arg_names, args))
2016-02-06 09:38:49 +00:00
args = [argdict[name] for name in argnames]
if has_kw:
return fn(*args, **kw)
else:
return fn(*args)
return wrap_leg
else:
return fn
def _indent(text, indent):
return "\n".join(
indent + line
for line in text.split("\n")
)
2016-02-22 11:49:42 +00:00
def _standard_listen_example(dispatch_collection, sample_target, fn):
2016-02-06 09:38:49 +00:00
example_kw_arg = _indent(
"\n".join(
"%(arg)s = kw['%(arg)s']" % {"arg": arg}
2016-02-22 11:49:42 +00:00
for arg in dispatch_collection.arg_names[0:2]
2016-02-06 09:38:49 +00:00
),
" ")
2016-02-22 11:49:42 +00:00
if dispatch_collection.legacy_signatures:
2016-02-06 09:38:49 +00:00
current_since = max(since for since, args, conv
2016-02-22 11:49:42 +00:00
in dispatch_collection.legacy_signatures)
2016-02-06 09:38:49 +00:00
else:
current_since = None
text = (
"from sqlalchemy import event\n\n"
"# standard decorator style%(current_since)s\n"
"@event.listens_for(%(sample_target)s, '%(event_name)s')\n"
"def receive_%(event_name)s("
"%(named_event_arguments)s%(has_kw_arguments)s):\n"
" \"listen for the '%(event_name)s' event\"\n"
"\n # ... (event handling logic) ...\n"
)
2016-02-22 11:49:42 +00:00
if len(dispatch_collection.arg_names) > 3:
2016-02-06 09:38:49 +00:00
text += (
"\n# named argument style (new in 0.9)\n"
"@event.listens_for("
"%(sample_target)s, '%(event_name)s', named=True)\n"
"def receive_%(event_name)s(**kw):\n"
" \"listen for the '%(event_name)s' event\"\n"
"%(example_kw_arg)s\n"
"\n # ... (event handling logic) ...\n"
)
text %= {
"current_since": " (arguments as of %s)" %
current_since if current_since else "",
"event_name": fn.__name__,
2016-02-22 11:49:42 +00:00
"has_kw_arguments": ", **kw" if dispatch_collection.has_kw else "",
"named_event_arguments": ", ".join(dispatch_collection.arg_names),
2016-02-06 09:38:49 +00:00
"example_kw_arg": example_kw_arg,
"sample_target": sample_target
}
return text
2016-02-22 11:49:42 +00:00
def _legacy_listen_examples(dispatch_collection, sample_target, fn):
2016-02-06 09:38:49 +00:00
text = ""
2016-02-22 11:49:42 +00:00
for since, args, conv in dispatch_collection.legacy_signatures:
2016-02-06 09:38:49 +00:00
text += (
"\n# legacy calling style (pre-%(since)s)\n"
"@event.listens_for(%(sample_target)s, '%(event_name)s')\n"
"def receive_%(event_name)s("
"%(named_event_arguments)s%(has_kw_arguments)s):\n"
" \"listen for the '%(event_name)s' event\"\n"
"\n # ... (event handling logic) ...\n" % {
"since": since,
"event_name": fn.__name__,
"has_kw_arguments": " **kw"
2016-02-22 11:49:42 +00:00
if dispatch_collection.has_kw else "",
2016-02-06 09:38:49 +00:00
"named_event_arguments": ", ".join(args),
"sample_target": sample_target
}
)
return text
2016-02-22 11:49:42 +00:00
def _version_signature_changes(dispatch_collection):
since, args, conv = dispatch_collection.legacy_signatures[0]
2016-02-06 09:38:49 +00:00
return (
"\n.. versionchanged:: %(since)s\n"
" The ``%(event_name)s`` event now accepts the \n"
" arguments ``%(named_event_arguments)s%(has_kw_arguments)s``.\n"
" Listener functions which accept the previous argument \n"
" signature(s) listed above will be automatically \n"
" adapted to the new signature." % {
"since": since,
2016-02-22 11:49:42 +00:00
"event_name": dispatch_collection.name,
"named_event_arguments": ", ".join(dispatch_collection.arg_names),
"has_kw_arguments": ", **kw" if dispatch_collection.has_kw else ""
2016-02-06 09:38:49 +00:00
}
)
2016-02-22 11:49:42 +00:00
def _augment_fn_docs(dispatch_collection, parent_dispatch_cls, fn):
2016-02-06 09:38:49 +00:00
header = ".. container:: event_signatures\n\n"\
" Example argument forms::\n"\
"\n"
sample_target = getattr(parent_dispatch_cls, "_target_class_doc", "obj")
text = (
header +
_indent(
_standard_listen_example(
2016-02-22 11:49:42 +00:00
dispatch_collection, sample_target, fn),
2016-02-06 09:38:49 +00:00
" " * 8)
)
2016-02-22 11:49:42 +00:00
if dispatch_collection.legacy_signatures:
2016-02-06 09:38:49 +00:00
text += _indent(
_legacy_listen_examples(
2016-02-22 11:49:42 +00:00
dispatch_collection, sample_target, fn),
2016-02-06 09:38:49 +00:00
" " * 8)
2016-02-22 11:49:42 +00:00
text += _version_signature_changes(dispatch_collection)
2016-02-06 09:38:49 +00:00
return util.inject_docstring_text(fn.__doc__,
text,
1
)