summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2016-03-27 19:39:14 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2016-03-27 19:39:14 (GMT)
commitfa0f62d6ab3d4acf949bd0160bca16f0f973c323 (patch)
treeab21e061c2c0ce17e9fb65f48d31c35642a95d0b /Doc/library
parentf70fe6f6cfde596264ed6fdd626b8c2964443f3e (diff)
downloadcpython-fa0f62d6ab3d4acf949bd0160bca16f0f973c323.zip
cpython-fa0f62d6ab3d4acf949bd0160bca16f0f973c323.tar.gz
cpython-fa0f62d6ab3d4acf949bd0160bca16f0f973c323.tar.bz2
Issue #23758: Improve num_params docs of create_{function,aggregate} functions
If you pass -1, the callable can take any number of arguments. Added tests to verify the behavior. Initial patch by Cédric Krier.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/sqlite3.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 4890fc5..b037b45 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -324,8 +324,9 @@ Connection Objects
Creates a user-defined function that you can later use from within SQL
statements under the function name *name*. *num_params* is the number of
- parameters the function accepts, and *func* is a Python callable that is called
- as the SQL function.
+ parameters the function accepts (if *num_params* is -1, the function may
+ take any number of arguments), and *func* is a Python callable that is
+ called as the SQL function.
The function can return any of the types supported by SQLite: bytes, str, int,
float and None.
@@ -340,7 +341,8 @@ Connection Objects
Creates a user-defined aggregate function.
The aggregate class must implement a ``step`` method, which accepts the number
- of parameters *num_params*, and a ``finalize`` method which will return the
+ of parameters *num_params* (if *num_params* is -1, the function may take
+ any number of arguments), and a ``finalize`` method which will return the
final result of the aggregate.
The ``finalize`` method can return any of the types supported by SQLite: