Apsw

========

PyPI now includes Python 3.11 builds.

Instead of using scripts, you can now run several tools directly:

* :ref:`tests <testing>`: python3 **-m apsw.tests** *[options]*

* :ref:`tracer <apswtrace>`: python3 **-m apsw.trace** *[options]*

* :ref:`speed tester <speedtest>`: python3 **-m apsw.speedtest** *[options]*

* :ref:`shell <shell>`: python3 **-m apsw** *[options]*

The shell class has moved from apsw.Shell to :class:`apsw.shell.Shell`
(:issue:`356`). You can still reference it via the old name (ie
existing code will not break, except on Python 3.6).

:ref:`shell`: On Windows the native console support for colour is now used
(previously a third party module was supported).

You :ref:`can use --definevalues in setup.py build_ext
<setup_build_flags>` to provide compiler defines used for configuring
SQLite. (:issue:`357`)

If SQLITE_ENABLE_COLUMN_METADATA is enabled then
:attr:`Cursor.description_full` is available providing all the column
metadata available. (:issue:`354`)

:attr:`Connection.cursor_factory` attribute is now present and is used
when :meth:`Connection.cursor` is called. Added
:meth:`Connection.execute` and :meth:`Connection.executemany` which
automatically obtain the underlying cursor. See :ref:`customizing
connections and cursors <customizing_connection_cursor>` in the
:doc:`tips`. (:issue:`361`)

========

**Version numbering scheme change:** Instead of a *-r1* style suffix,
there is *.0* style suffix (:issue:`340`)

Updated building for PyPI to include more compiled platforms,
including aarch64 (Linux) and universal (MacOS). Windows binaries are
no longer separately provided since PyPI has them.

When the amalgamation is included into APSW, `SQLITE_MAX_ATTACHED
<https://www.sqlite.org/limits.html#max_attached>`__ is set to 125 if
not defined, up from the default of 10.

Updated typing information stubs with more detail and include docstrings.
This is still ongoing, but core functionality is well covered.
(:issue:`338`) (:issue:`381`)

Corrected the :ref:`tips <diagnostics_tips>` log handler of extended
result code (:issue:`342`)

Added :func:`Connection.db_names` (:issue:`343`)

=========

APSW is now on PyPI, so you can::

pip install apsw

(Thanks to several people behind the scenes who helped with the various pieces
to make this happen.)

Removed support for setup.py downloading the in-development (aka
fossil) version of SQLite.

Shell exit for --version etc cleanly exits (:issue:`210`)

Python 3.11 (:issue:`326`) now works.

PyPy3 compiles and mostly works (:issue:`323`).

=========

All items now have full docstrings including type information.
(Previously just one line summaries). Note the C implemented
functions and data (ie almost all of APSW) can't provide the same
level of type information as regular Python code.

A pyi file is included which does provide all the typing
information in `type stub
<https://typing.readthedocs.io/en/latest/source/stubs.html>`__ format,
and shown by most IDEs.

Removal of code, tests, and documentation only relevant to CPython
before 3.7. (Python 3.6 does still work, but is end of life.)

Keyword arguments can be used everywhere.

The statement cache implementation changed from a dictionary to a
list. This allows the cache to be used for the same query text
multiple times. (The code is also a quarter of the size and simpler).

The default for setup.py's fetch command is to get the SQLite version
corresponding to APSW's release. (Previously it got the latest release.)

Added constants:

* SQLITE_INDEX_CONSTRAINT_OFFSET, SQLITE_INDEX_CONSTRAINT_LIMIT

=========

Allow breaking of reference cycles between objects that contain a
:obj:`Connection` or :obj:`Cursor`, and also use callbacks from that
object (eg busy handler). (:issue:`314`)

This is the last release supporting Python 2 and Python 3 before 3.7.
If you still use those Python versions then you should pin to this
APSW version. (`More information
<https://www.rogerbinns.com/blog/apsw-ending-python2early3.html>`__).

Windows Python 3.10 binaries are available to download. The .exe format
is no longer available with this Python version.

Fixed custom VFS extension loading failure could leave the error
message unterminated.

Updated size of mutex array used by the :func:`fork checker <fork_checker>`

Connections are opened with SQLITE_OPEN_EXRESCODE so open errors will
also include extended result codes.

:meth:`Connection.changes` and :meth:`Connection.total_changes` use the
new SQLite APIs that return 64 bit values (ie can now return values
greater than 2 billion).

Added :meth:`Connection.autovacuum_pages`.

Added constants:

* SQLITE_CONSTRAINT_DATATYPE, SQLITE_OPEN_EXRESCODE

=========

Implemented :meth:`Connection.serialize` and
:meth:`Connection.deserialize`. They turn a database into bytes, and
bytes into a database respectively.

Allow any subclass of VFS to implement WAL, not just direct
subclasses. (:issue:`311`)

Added constants:

* SQLITE_FCNTL_EXTERNAL_READER, SQLITE_FCNTL_CKSM_FILE