##// END OF EJS Templates
Use check_same_thread=False by default for history sqlite db (#13886)...
Use check_same_thread=False by default for history sqlite db (#13886) I had run into the following exception while trying to use IPython in a thread: ``` Traceback (most recent call last): File "/usr/local/lib/python3.11/dist-packages/IPython/core/interactiveshell.py", line 3745, in atexit_operations self._atexit_once() File "/usr/local/lib/python3.11/dist-packages/IPython/core/interactiveshell.py", line 3728, in _atexit_once self.history_manager.end_session() File "/usr/local/lib/python3.11/dist-packages/IPython/core/history.py", line 576, in end_session self.writeout_cache() File "/usr/local/lib/python3.11/dist-packages/decorator.py", line 232, in fun return caller(func, *(extras + args), **kw) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/dist-packages/IPython/core/history.py", line 60, in only_when_enabled return f(self, *a, **kw) ^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/dist-packages/IPython/core/history.py", line 831, in writeout_cache self._writeout_input_cache(conn) File "/usr/local/lib/python3.11/dist-packages/IPython/core/history.py", line 812, in _writeout_input_cache with conn: sqlite3.ProgrammingError: SQLite objects created in a thread can only be used in that same thread. The object was created in thread id 139673788811008 and this is thread id 139673823184704. ``` And discovered that an issue (#680) has been open for it since 2011. Back in [2012](https://github.com/ipython/ipython/issues/680#issuecomment-3444922), it seems like the only reason not to fix it was that the parameter `check_same_thread` was not documented, but now [it is](https://docs.python.org/3.11/library/sqlite3.html#sqlite3.connect), and it has been at least since [3.6](https://docs.python.org/3.6/library/sqlite3.html#sqlite3.connect). Note that according to the docs: > check_same_thread ([bool](https://docs.python.org/3/library/functions.html#bool)) – If True (default), only the creating thread may use the connection. If False, the connection may be shared across multiple threads; if so, write operations should be serialized by the user to avoid data corruption. But I don't think this is an issue here. The operations should be synchronized by the user only *on the same connection object*, and if I'm not mistaken, if two instances of IPython were started in separate threads, they'd each have their own history manager with its own connection. The exception above (and the one in the related issue) is raised from `atexit`, when the main thread is running finalizations registered by other threads. At that point, the operations are serial anyway because they are executed in a single thread.
Matthias Bussonnier -
r28320:2da6fb98 merge
Show More
Name Size Modified Last Commit Author
/ docs
man
source
sphinxext
Makefile Loading ...
README.rst Loading ...
autogen_api.py Loading ...
autogen_config.py Loading ...
autogen_magics.py Loading ...
autogen_shortcuts.py Loading ...
environment.yml Loading ...
make.cmd Loading ...
requirements.txt Loading ...

IPython Documentation

This directory contains the majority of the documentation for IPython.

Deploy docs

Documentation is automatically deployed on ReadTheDocs on every push or merged Pull requests.

Requirements

The documentation must be built using Python 3.

In addition to :ref:`devinstall`, the following tools are needed to build the documentation:

  • sphinx
  • sphinx_rtd_theme
  • docrepr

In a conda environment, or a Python 3 venv, you should be able to run:

cd ipython
pip install -U -r docs/requirements.txt

Build Commands

The documentation gets built using make, and comes in several flavors.

make html - build the API and narrative documentation web pages, this is the default make target, so running just make is equivalent to make html.

make html_noapi - same as above, but without running the auto-generated API docs. When you are working on the narrative documentation, the most time consuming portion of the build process is the processing and rendering of the API documentation. This build target skips that.

make pdf will compile a pdf from the documentation.

You can run make help to see information on all possible make targets.

To save time, the make targets above only process the files that have been changed since the previous docs build. To remove the previous docs build you can use make clean. You can also combine clean with other make commands; for example, make clean html will do a complete rebuild of the docs or make clean pdf will do a complete build of the pdf.

Continuous Integration

Documentation builds are included in the Travis-CI continuous integration process, so you can see the results of the docs build for any pull request at https://travis-ci.org/ipython/ipython/pull_requests.