Adding upstream version 3.1.7.upstream/3.1.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 75 insertions, 0 deletions

diff --git a/docs/api/abc.rst b/docs/api/abc.rst
new file mode 100644
index 0000000..9514e9b
--- /dev/null
+++ b/docs/api/abc.rst
@@ -0,0 +1,75 @@
+`!abc` -- Psycopg abstract classes
+==================================
+
+The module exposes Psycopg definitions which can be used for static type
+checking.
+
+.. module:: psycopg.abc
+
+.. autoclass:: Dumper(cls, context=None)
+
+    :param cls: The type that will be managed by this dumper.
+    :type cls: type
+    :param context: The context where the transformation is performed. If not
+        specified the conversion might be inaccurate, for instance it will not
+        be possible to know the connection encoding or the server date format.
+    :type context: `AdaptContext` or None
+
+    A partial implementation of this protocol (implementing everything except
+    `dump()`) is available as `psycopg.adapt.Dumper`.
+
+    .. autoattribute:: format
+
+    .. automethod:: dump
+
+        The format returned by dump shouldn't contain quotes or escaped
+        values.
+
+    .. automethod:: quote
+
+        .. tip::
+
+            This method will be used by `~psycopg.sql.Literal` to convert a
+            value client-side.
+
+        This method only makes sense for text dumpers; the result of calling
+        it on a binary dumper is undefined. It might scratch your car, or burn
+        your cake. Don't tell me I didn't warn you.
+
+    .. autoattribute:: oid
+
+        If the OID is not specified, PostgreSQL will try to infer the type
+        from the context, but this may fail in some contexts and may require a
+        cast (e.g. specifying :samp:`%s::{type}` for its placeholder).
+
+        You can use the `psycopg.adapters`\ ``.``\
+        `~psycopg.adapt.AdaptersMap.types` registry to find the OID of builtin
+        types, and you can use `~psycopg.types.TypeInfo` to extend the
+        registry to custom types.
+
+    .. automethod:: get_key
+    .. automethod:: upgrade
+
+
+.. autoclass:: Loader(oid, context=None)
+
+    :param oid: The type that will be managed by this dumper.
+    :type oid: int
+    :param context: The context where the transformation is performed. If not
+        specified the conversion might be inaccurate, for instance it will not
+        be possible to know the connection encoding or the server date format.
+    :type context: `AdaptContext` or None
+
+    A partial implementation of this protocol (implementing everything except
+    `load()`) is available as `psycopg.adapt.Loader`.
+
+    .. autoattribute:: format
+
+    .. automethod:: load
+
+
+.. autoclass:: AdaptContext
+    :members:
+
+    .. seealso:: :ref:`adaptation` for an explanation about how contexts are
+        connected.