Skip to content

Commit 1bbf60d

Browse files
[3.11] Docs: add links to 'callable' term in sqlite3 docs (GH-106072) (#106074)
(cherry picked from commit bef1c87) Co-authored-by: Erlend E. Aasland <erlend@python.org>
1 parent dbe416b commit 1bbf60d

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

Doc/library/sqlite3.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -394,15 +394,15 @@ Module functions
394394

395395
.. function:: register_adapter(type, adapter, /)
396396

397-
Register an *adapter* callable to adapt the Python type *type* into an
398-
SQLite type.
397+
Register an *adapter* :term:`callable` to adapt the Python type *type*
398+
into an SQLite type.
399399
The adapter is called with a Python object of type *type* as its sole
400400
argument, and must return a value of a
401401
:ref:`type that SQLite natively understands <sqlite3-types>`.
402402

403403
.. function:: register_converter(typename, converter, /)
404404

405-
Register the *converter* callable to convert SQLite objects of type
405+
Register the *converter* :term:`callable` to convert SQLite objects of type
406406
*typename* into a Python object of a specific type.
407407
The converter is invoked for all SQLite values of type *typename*;
408408
it is passed a :class:`bytes` object and should return an object of the
@@ -459,7 +459,7 @@ Module constants
459459
SQLITE_DENY
460460
SQLITE_IGNORE
461461

462-
Flags that should be returned by the *authorizer_callback* callable
462+
Flags that should be returned by the *authorizer_callback* :term:`callable`
463463
passed to :meth:`Connection.set_authorizer`, to indicate whether:
464464

465465
* Access is allowed (:const:`!SQLITE_OK`),
@@ -562,8 +562,8 @@ Connection objects
562562

563563
Create and return a :class:`Cursor` object.
564564
The cursor method accepts a single optional parameter *factory*. If
565-
supplied, this must be a callable returning an instance of :class:`Cursor`
566-
or its subclasses.
565+
supplied, this must be a :term:`callable` returning
566+
an instance of :class:`Cursor` or its subclasses.
567567

568568
.. method:: blobopen(table, column, row, /, *, readonly=False, name="main")
569569

@@ -647,7 +647,7 @@ Connection objects
647647
If ``-1``, it may take any number of arguments.
648648

649649
:param func:
650-
A callable that is called when the SQL function is invoked.
650+
A :term:`callable` that is called when the SQL function is invoked.
651651
The callable must return :ref:`a type natively supported by SQLite
652652
<sqlite3-types>`.
653653
Set to ``None`` to remove an existing SQL function.
@@ -872,9 +872,10 @@ Connection objects
872872

873873
.. method:: set_authorizer(authorizer_callback)
874874

875-
Register callable *authorizer_callback* to be invoked for each attempt to
876-
access a column of a table in the database. The callback should return
877-
one of :const:`SQLITE_OK`, :const:`SQLITE_DENY`, or :const:`SQLITE_IGNORE`
875+
Register :term:`callable` *authorizer_callback* to be invoked
876+
for each attempt to access a column of a table in the database.
877+
The callback should return one of :const:`SQLITE_OK`,
878+
:const:`SQLITE_DENY`, or :const:`SQLITE_IGNORE`
878879
to signal how access to the column should be handled
879880
by the underlying SQLite library.
880881

@@ -897,7 +898,7 @@ Connection objects
897898

898899
.. method:: set_progress_handler(progress_handler, n)
899900

900-
Register callable *progress_handler* to be invoked for every *n*
901+
Register :term:`callable` *progress_handler* to be invoked for every *n*
901902
instructions of the SQLite virtual machine. This is useful if you want to
902903
get called from SQLite during long-running operations, for example to update
903904
a GUI.
@@ -912,8 +913,8 @@ Connection objects
912913

913914
.. method:: set_trace_callback(trace_callback)
914915

915-
Register callable *trace_callback* to be invoked for each SQL statement
916-
that is actually executed by the SQLite backend.
916+
Register :term:`callable` *trace_callback* to be invoked
917+
for each SQL statement that is actually executed by the SQLite backend.
917918

918919
The only argument passed to the callback is the statement (as
919920
:class:`str`) that is being executed. The return value of the callback is
@@ -1045,8 +1046,8 @@ Connection objects
10451046
Defaults to ``-1``.
10461047

10471048
:param progress:
1048-
If set to a callable, it is invoked with three integer arguments for
1049-
every backup iteration:
1049+
If set to a :term:`callable`,
1050+
it is invoked with three integer arguments for every backup iteration:
10501051
the *status* of the last iteration,
10511052
the *remaining* number of pages still to be copied,
10521053
and the *total* number of pages.
@@ -1247,8 +1248,8 @@ Connection objects
12471248

12481249
.. attribute:: text_factory
12491250

1250-
A callable that accepts a :class:`bytes` parameter and returns a text
1251-
representation of it.
1251+
A :term:`callable` that accepts a :class:`bytes` parameter
1252+
and returns a text representation of it.
12521253
The callable is invoked for SQLite values with the ``TEXT`` data type.
12531254
By default, this attribute is set to :class:`str`.
12541255
If you want to return ``bytes`` instead, set *text_factory* to ``bytes``.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy