##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

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.
Nikita Kniazev - - Load All Authors

File last commit:

r27042:360df2b6
r28320:2da6fb98 merge
Show More
install.rst
143 lines | 3.9 KiB | text/x-rst | RstLexer
/ docs / source / install / install.rst
History | Annotation | Raw |Copy content |Copy permalink

Installing IPython

IPython 6 requires Python ≥ 3.3. IPython 5.x can be installed on Python 2.

Quick Install

With pip already installed :

$ pip install ipython

This installs IPython as well as its dependencies.

If you want to use IPython with notebooks or the Qt console, you should also install Jupyter pip install jupyter.

Overview

This document describes in detail the steps required to install IPython. For a few quick ways to get started with package managers or full Python distributions, see the install page of the IPython website.

Please let us know if you have problems installing IPython or any of its dependencies.

IPython and most dependencies should be installed via :command:`pip`. In many scenarios, this is the simplest method of installing Python packages. More information about :mod:`pip` can be found on its PyPI page.

More general information about installing Python packages can be found in Python's documentation.

Dependencies

IPython relies on a number of other Python packages. Installing using a package manager like pip or conda will ensure the necessary packages are installed. Manual installation without dependencies is possible, but not recommended. The dependencies can be viewed with package manager commands, such as :command:`pip show ipython` or :command:`conda info ipython`.

Installing IPython itself

IPython requires several dependencies to work correctly, it is not recommended to install IPython and all its dependencies manually as this can be quite long and troublesome. You should use the python package manager pip.

Installation using pip

Make sure you have the latest version of :mod:`pip` (the Python package manager) installed. If you do not, head to Pip documentation and install :mod:`pip` first.

The quickest way to get up and running with IPython is to install it with pip:

$ pip install ipython

That's it.

Installation from source

To install IPython from source, grab the latest stable tarball of IPython from PyPI. Then do the following:

tar -xzf ipython-5.1.0.tar.gz
cd ipython-5.1.0
# The [test] extra ensures test dependencies are installed too:
pip install '.[test]'

Do not invoke setup.py directly as this can have undesirable consequences for further upgrades. We do not recommend using easy_install either.

If you are installing to a location (like /usr/local) that requires higher permissions, you may need to run the last command with :command:`sudo`. You can also install in user specific location by using the --user flag in conjunction with pip.

To run IPython's test suite, use the :command:`pytest` command:

$ pytest

Installing the development version

It is also possible to install the development version of IPython from our Git source code repository. To do this you will need to have Git installed on your system.

Then do:

$ git clone https://github.com/ipython/ipython.git
$ cd ipython
$ pip install -e '.[test]'

The :command:`pip install -e .` command allows users and developers to follow the development branch as it changes by creating links in the right places and installing the command line scripts to the appropriate locations.

Then, if you want to update your IPython at any time, do:

$ git pull

If the dependencies or entrypoints have changed, you may have to run

$ pip install -e .

again, but this is infrequent.