IPython

https://ipython.readthedocs.io/en/stable/
Admin
IPython is a powerful interactive Python shell and Jupyter kernel that provides enhanced interactive...
Tokens:677,806
Snippets:5,914
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Starting IPython with --gui flag

Source: https://ipython.readthedocs.io/en/stable/_sources/interactive/reference.rst.txt

Shows how to start IPython with an event loop set up using the --gui flag. The example uses --gui=qt to enable the Qt event loop.

```shell
$ ipython --gui=qt
```

--------------------------------

### Set config options when starting IPython from Python

Source: https://ipython.readthedocs.io/en/stable/config/intro.html

Create a traitlets Config object, set options as in a config file, and pass it to start_ipython(). This example sets exec_lines, colors, confirm_exit, and display_banner.

```python
"""Quick snippet explaining how to set config options when using start_ipython."""

# First create a config object from the traitlets library
from traitlets.config import Config
c = Config()

# Now we can set options as we would in a config file:
#   c.Class.config_value = value
# For example, we can set the exec_lines option of the InteractiveShellApp
# class to run some code when the IPython REPL starts
c.InteractiveShellApp.exec_lines = [
    'print("\\nimporting some things\\n")',
    'import math',
    "math"
]
c.InteractiveShell.colors = "lightbg"
c.InteractiveShell.confirm_exit = False
c.TerminalIPythonApp.display_banner = False

# Now we start ipython with our configuration
import IPython
IPython.start_ipython(config=c)

```

--------------------------------

### %cd example

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows changing to a subdirectory and the resulting working directory output.

```ipython
In [10]: cd parent/child
/home/tsuser/parent/child

```

--------------------------------

### Show ipykernel install help

Source: https://ipython.readthedocs.io/en/stable/_sources/install/index.rst.txt

Displays help for the ipykernel install command, listing all available options and usage details.

```bash
$ python -m ipykernel install  --help
```

--------------------------------

### Start IPython notebook server

Source: https://ipython.readthedocs.io/en/stable/_sources/whatsnew/version0.12.rst.txt

Starts the IPython notebook server in the current directory.

```bash
ipython notebook
```

--------------------------------

### %colors nocolor example

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows how to switch to a plain black and white terminal using %colors nocolor.

```ipython
%colors nocolor

```

--------------------------------

### %code_wrap usage and examples

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows the usage of %code_wrap magic, including defining a transformer, using it, and listing/removing transformers. The example demonstrates the before_after transformer.

```ipython
%code_wrap [--remove] [--list] [--list-all] [name]

```

```ipython
In [1]: %%code_wrap before_after
   ...: print('before')
   ...: __code__
   ...: print('after')
   ...: __ret__
   ...: 

In [2]: 1
before
after
Out[2]: 1

In [3]: %code_wrap --list
before
before_after
after

In [4]: %code_wrap --list-all
before
before_after :
    print('before')
    __code__
    print('after')
    __ret__

after

In [5]: %code_wrap --remove before_after
before
after

```

--------------------------------

### Doctest traceback output example

Source: https://ipython.readthedocs.io/en/stable/whatsnew/version9.html

Example output of the new `%xmode Doctest` mode, showing the traceback header, an ellipsis, and the exception line for easy copy-paste into doctests.

```text
Traceback (most recent call last):
    ...
ZeroDivisionError: division by zero

```

--------------------------------

### Autoawait example with aiohttp

Source: https://ipython.readthedocs.io/en/stable/whatsnew/version7.html

Demonstrates the autoawait feature in IPython 7.0.0, showing how to await asynchronous code directly in the REPL without manually managing an event loop.

```python
Python 3.6.0
Type 'copyright', 'credits' or 'license' for more information
IPython 7.0.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: import aiohttp
   ...: result = aiohttp.get('https://api.github.com')

In [2]: response = await result
<pause for a few 100s ms>

In [3]: await response.json()
Out[3]:
{'authorizations_url': 'https://api.github.com/authorizations',
 'code_search_url': 'https://api.github.com/search/code?q={&query}{&page,per_page,sort,order}',
...
}
```

--------------------------------

### Start the editor to define a function

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Opens the editor with an empty temporary file. After closing, the code is executed and the output shows the edited code as a string.

```ipython
In [1]: edit
Editing... done. Executing edited code...
Out[1]: 'def foo():\n    print("foo() was defined in an editing
session")\n'

```

--------------------------------

### %reset_selective magic: example with -f flag

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Demonstrates the %reset_selective magic with the -f flag to force reset without confirmation. The example shows resetting the namespace and checking the user_ns variable.

```ipython
In [1]: %reset -f

In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8

In [3]: who_ls
Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']

In [4]: %reset_selective -f b[2-3]m

In [5]: who_ls
Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']

In [6]: %reset_selective -f d

In [7]: who_ls
Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']

In [8]: %reset_selective -f c
```

--------------------------------

### %autocall with / prefix example

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows using the '/' prefix to force a function call even when autocall is off. The output shows the transformation and result.

```ipython
In [8]: /str 43
------> str(43)
Out[8]: '43'

```

--------------------------------

### %autocall mode 1 example

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows the behavior of %autocall in mode 1 (smart) where functions are called only if arguments are present. The output shows the transformation and result.

```ipython
In [1]: callable
Out[1]: <built-in function callable>

In [2]: callable 'hello'
------> callable('hello')
Out[2]: False

```

--------------------------------

### History Range Glob Example

Source: https://ipython.readthedocs.io/en/stable/whatsnew/version8.html

Shows how to specify a range of sessions and lines in %history, and how to use a glob pattern to search all history. Previously, specifying both would ignore the range and use the glob on all history.

```text
~8/1-~6/5   # see history from the first line of 8 sessions ago,
            # to the fifth line of 6 sessions ago.
```

```text
-g <pattern>  # glob ALL history for the specified pattern.
```

--------------------------------

### %autocall mode 2 example

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows the behavior of %autocall in mode 2 (full) where functions are called even without arguments. The output shows the transformation and result.

```ipython
In [2]: float
------> float()
Out[2]: 0.0

```

--------------------------------

### Vi-mode Prompt Stripping Example

Source: https://ipython.readthedocs.io/en/stable/whatsnew/version8.html

Shows that pasting code with standard In/Out prompts works, and that Vi-mode prompts (e.g., [ins]) previously caused a SyntaxError but are now skipped.

```text
In [1]: 2 * 2 == 4
Out[1]: True

In [2]: print("This still works as pasted")
```

```text
In [1]: [ins] In [13]: 2 * 2 == 4
   ...: Out[13]: True
   ...:
  File "<ipython-input-1-727bb88eaf33>", line 1
    [ins] In [13]: 2 * 2 == 4
          ^
SyntaxError: invalid syntax
```

--------------------------------

### %time magic usage examples

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows the %time magic in line mode timing a single expression, a sum, and a print statement, with the resulting CPU/wall time and return value. Also demonstrates that compilation time can dominate for constant expressions.

```ipython
In [1]: %time 2**128
CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
Wall time: 0.00
Out[1]: 340282366920938463463374607431768211456L

In [2]: n = 1000000

In [3]: %time sum(range(n))
CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
Wall time: 1.37
Out[3]: 499999500000L

In [4]: %time print('hello world')
hello world
CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
Wall time: 0.00
```

```ipython
In [5]: %time 3**9999;
CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
Wall time: 0.00 s

In [6]: %time 3**999999;
CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
Wall time: 0.00 s
Compiler : 0.78 s
```

--------------------------------

### Debugging with %run -d and pdb

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows the internal pdb call used when running with -d, and an example of setting a breakpoint on line 40 with -b40.

```python
pdb.run('execfile("YOURFILENAME")')
```

```ipython
%run -d -b40 myscript
```

--------------------------------

### Using %alias with %s specifiers

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows how to define an alias with %s specifiers for parameters. The alias 'parts' echoes the first and second parameters. The example also shows the error when an incorrect number of arguments is provided.

```ipython
In [1]: alias parts echo first %s second %s
In [2]: %parts A B
first A second B
In [3]: %parts A
Incorrect number of arguments: 2 expected.
parts is an alias to: 'echo first %s second %s'

```

--------------------------------

### Using %alias with %l specifier

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows how to define an alias with the %l specifier to represent the whole line. The alias 'bracket' echoes the input in brackets. The example demonstrates the output when calling the alias with 'hello world'.

```ipython
In [2]: alias bracket echo "Input in brackets: <%l>"
In [3]: bracket hello world
Input in brackets: <hello world>

```

--------------------------------

### Install IPython with pip

Source: https://ipython.readthedocs.io/en/stable/install/install.html

Installs IPython and its dependencies using pip. Requires Python ≥ 3.11 and pip installed. This is the quickest way to get IPython running.

```bash
$ pip install ipython

```

--------------------------------

### Old launcher configuration example

Source: https://ipython.readthedocs.io/en/stable/_sources/whatsnew/version0.12.rst.txt

Shows the previous way to specify launcher classes using full import paths.

```python
IPClusterEngines.engine_launcher = 'IPython.parallel.apps.launcher.MPIExecEngineSetLauncher'
IPClusterStart.controller_launcher = 'IPython.parallel.apps.launcher.SSHControllerLauncher'
```

--------------------------------

### Example code for traceback highlighting

Source: https://ipython.readthedocs.io/en/stable/whatsnew/version8.html

This code defines functions that will be used to demonstrate the new traceback highlighting. When bar() is called, it raises an IndexError, and IPython 8.0 highlights the exact AST node where the error occurs.

```python
def foo(i):
    x = [[[0]]]
    return x[0][i][0]


def bar():
    return foo(0) + foo(
        1
    ) + foo(2)

```

--------------------------------

### Traceback with AST node highlighting

Source: https://ipython.readthedocs.io/en/stable/whatsnew/version8.html

Shows the traceback output when calling bar() from the previous example. The caret symbols (^) indicate the exact location of the error, which will be highlighted in the terminal and notebooks.

```text
IndexError
Input In [2], in <module>
----> 1 bar()
        ^^^^^

Input In [1], in bar()
      6 def bar():
----> 7     return foo(0) + foo(
                            ^^^^
      8         1
         ^^^^^^^^
      9     ) + foo(2)
         ^^^^

Input In [1], in foo(i)
      1 def foo(i):
      2     x = [[[0]]]
----> 3     return x[0][i][0]
                   ^^^^^^^

```

--------------------------------

### IPython.paths.get_ipython_package_dir()

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.paths.html

Gets the base directory where IPython itself is installed.

```APIDOC
## Function: get_ipython_package_dir

### Description
Get the base directory where IPython itself is installed.

### Signature
`IPython.paths.get_ipython_package_dir() -> str`

### Parameters
None

### Returns
- **str** - The base directory path.

### Example
```python
import IPython.paths
package_dir = IPython.paths.get_ipython_package_dir()
```
```

--------------------------------

### Deprecated %sc shell capture example

Source: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Shows the deprecated %sc command and its modern replacement using !. The old form stores output in a variable; the new form uses shell assignment.

```python
%sc -l myfiles = ls
```

```python
myfiles = !ls
```

--------------------------------

### Load extension at startup via configuration

Source: https://ipython.readthedocs.io/en/stable/_sources/config/extensions/index.rst.txt

List the extension module name in the c.InteractiveShellApp.extensions configuration list to load it each time IPython starts.

```python
c.InteractiveShellApp.extensions = [
    'myextension'
]
```

--------------------------------

### Install IPython with pip

Source: https://ipython.readthedocs.io/en/stable/_sources/install/index.rst.txt

Use this command to install IPython via pip. It is the quickest way to get IPython if you are already familiar with Python package management.

```bash
$ pip install ipython
```

--------------------------------

### Configure default debugger predicates in .pdbrc

Source: https://ipython.readthedocs.io/en/stable/whatsnew/version7.html

Edit your ~/.pdbrc file to set default predicates for the IPython debugger. The example sets 'skip_predicates readonly True' to hide read-only frames and 'skip_predicates tbhide False' to show frames with __tracebackhide__.

```text
# file : ~/.pdbrc
skip_predicates readonly True
skip_predicates tbhide False

```

--------------------------------

### full_path function examples

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.testing.tools.html

Examples of the full_path function, which makes full paths for listed files based on a start path. The first example shows using a file path as startPath, and the second shows using a directory path.

```python
>>> full_path('/foo/bar.py',['a.txt','b.txt'])
['/foo/a.txt', '/foo/b.txt']
```

```python
>>> full_path('/foo',['a.txt','b.txt'])
['/a.txt', '/b.txt']
```

--------------------------------

### New launcher configuration example

Source: https://ipython.readthedocs.io/en/stable/_sources/whatsnew/version0.12.rst.txt

Shows the new way to specify launcher classes by name only.

```python
IPClusterEngines.engine_launcher_class = 'MPI'
IPClusterStart.controller_launcher_class = 'SSH'
```

--------------------------------

### Get path links including symlinks

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.core.interactiveshell.html

Example usage of InteractiveShell.get_path_links() to retrieve all symlinks for a given path. The example shows that the number of unique paths equals the total, and that the result is non-empty.

```python
In [1]: from IPython.core.interactiveshell import InteractiveShell
In [2]: import sys, pathlib
In [3]: paths = InteractiveShell.get_path_links(pathlib.Path(sys.executable))
In [4]: len(paths) == len(set(paths)) Out[4]: True
In [5]: bool(paths) Out[5]: True
```

--------------------------------

### Demo.__init__

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.lib.demo.html

Initializes a new Demo object with source, title, arguments, and formatting options.

```APIDOC
## Demo.__init__

### Description
Initializes a new Demo object. To run the demo, simply call the object.

### Method
Constructor

### Signature
`Demo(src, title='', arg_str='', auto_all=None, format_rst=False, formatter='terminal', style='default')`

### Parameters
- **src** (file, file-like, or str) - Required - Source file, file-like object, or string that can be resolved to a filename.
- **title** (str) - Optional - A string to use as the demo name.
- **arg_str** (str) - Optional - A string of arguments, internally converted to a list like sys.argv.
- **auto_all** (bool or None) - Optional - Global flag to run all blocks automatically without confirmation.
- **format_rst** (bool) - Optional - Enable comments and docstrings formatting with pygments rst lexer.
- **formatter** (str) - Optional - Pygments formatter name (e.g., 'terminal', 'terminal256', 'terminal16m').
- **style** (str) - Optional - Pygments style name.

### Usage Example
```python
demo = Demo('script.py', title='My Demo', auto_all=True)
demo()
```
```

--------------------------------

### Create and run a Demo from a file

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.lib.demo.html

Creates a Demo instance from a file and runs the first block. Each call to the demo object executes the next block.

```python
from IPython.lib.demo import Demo
d = Demo('ex_demo.py')
d()

```

--------------------------------

### Basic IPython directive example

Source: https://ipython.readthedocs.io/en/stable/_sources/sphinxext.rst.txt

Shows a basic IPython directive block with prompts. The prompts are renumbered starting at 1, and the output from the embedded interpreter is inserted. This example demonstrates simple variable assignment and arithmetic.

```ipython
.. ipython::

   In [136]: x = 2

   In [137]: x**3
   Out[137]: 8
```

--------------------------------

### IPython.lib.clipboard.wayland_clipboard_get()

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.lib.clipboard.html

Get the clipboard's text under Wayland using wl-paste command. This requires Wayland and wl-clipboard installed and running.

```APIDOC
## wayland_clipboard_get()

### Description
Get the clipboard's text under Wayland using wl-paste command.

### Method
Function

### Signature
`wayland_clipboard_get()`

### Parameters
None

### Returns
- **str** - The clipboard's text.

### Exceptions
- **ClipboardEmpty** - If the clipboard is empty.

### Notes
This requires Wayland and wl-clipboard installed and running.
```

--------------------------------

### IPython.start_ipython

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.html

Launches a normal IPython instance with full initialization, including loading startup files and configuration. This is a public API method.

```APIDOC
## IPython.start_ipython

### Description
Launches a normal IPython instance with full initialization, including loading startup files and configuration. This is a public API method.

### Method
Function call

### Endpoint
IPython.start_ipython(_argv: list[str] | None = None_, _**kwargs: Any_) → Any

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **argv** (_list_ or _None_, _optional_) - If unspecified or None, IPython parses command-line options from sys.argv. Pass an empty list to prevent command-line parsing.
- **user_ns** (_dict_, _optional_) - Dictionary to initialize the IPython user namespace with particular values.
- ****kwargs** (_various_, _optional_) - Any other kwargs passed to the Application constructor, such as `config`.

### Request Example
No explicit example provided in the source.

### Response
#### Success Response (200)
Returns the result of the IPython application run, typically `None`.

#### Response Example
No explicit response example provided in the source.
```

--------------------------------

### psearch show objects with single underscore example

Source: https://ipython.readthedocs.io/en/stable/api/generated/IPython.core.magics.namespace.html

Shows how to include objects starting with a single underscore using the -a option.

```ipython
%psearch -a _*         list objects beginning with a single underscore
```

--------------------------------

### Show IPython notebook help options

Source: https://ipython.readthedocs.io/en/stable/_sources/whatsnew/version0.12.rst.txt

Displays help for the notebook server, with --help-all providing more detailed options.

```bash
ipython notebook --help
```

```bash
ipython notebook --help-all  # even more
```
Tokens:
Raw