1
|
|
|
# Configuration file for ipython. |
2
|
|
|
|
3
|
|
|
# ------------------------------------------------------------------------------ |
4
|
|
|
# InteractiveShellApp(Configurable) configuration |
5
|
|
|
# ------------------------------------------------------------------------------ |
6
|
|
|
|
7
|
|
|
## A Mixin for applications that start InteractiveShell instances. |
8
|
|
|
# |
9
|
|
|
# Provides configurables for loading extensions and executing files as part of |
10
|
|
|
# configuring a Shell environment. |
11
|
|
|
# |
12
|
|
|
# The following methods should be called by the :meth:`initialize` method of the |
13
|
|
|
# subclass: |
14
|
|
|
# |
15
|
|
|
# - :meth:`init_path` |
16
|
|
|
# - :meth:`init_shell` (to be implemented by the subclass) |
17
|
|
|
# - :meth:`init_gui_pylab` |
18
|
|
|
# - :meth:`init_extensions` |
19
|
|
|
# - :meth:`init_code` |
20
|
|
|
|
21
|
|
|
## Execute the given command string. |
22
|
|
|
# c.InteractiveShellApp.code_to_run = '' |
23
|
|
|
|
24
|
|
|
## Run the file referenced by the PYTHONSTARTUP environment variable at IPython |
25
|
|
|
# startup. |
26
|
|
|
# c.InteractiveShellApp.exec_PYTHONSTARTUP = True |
27
|
|
|
|
28
|
|
|
## List of files to run at IPython startup. |
29
|
|
|
# c.InteractiveShellApp.exec_files = [] |
30
|
|
|
|
31
|
|
|
## lines of code to run at IPython startup. |
32
|
|
|
c.InteractiveShellApp.exec_lines = ['%autoreload 2'] |
|
|
|
|
33
|
|
|
|
34
|
|
|
## A list of dotted module names of IPython extensions to load. |
35
|
|
|
c.InteractiveShellApp.extensions = ['autoreload'] |
36
|
|
|
|
37
|
|
|
## dotted module name of an IPython extension to load. |
38
|
|
|
# c.InteractiveShellApp.extra_extension = '' |
39
|
|
|
|
40
|
|
|
## A file to be run |
41
|
|
|
# c.InteractiveShellApp.file_to_run = '' |
42
|
|
|
|
43
|
|
|
## Enable GUI event loop integration with any of ('asyncio', 'glut', 'gtk', |
44
|
|
|
# 'gtk2', 'gtk3', 'osx', 'pyglet', 'qt', 'qt4', 'qt5', 'tk', 'wx', 'gtk2', |
45
|
|
|
# 'qt4'). |
46
|
|
|
# c.InteractiveShellApp.gui = None |
47
|
|
|
|
48
|
|
|
## Should variables loaded at startup (by startup files, exec_lines, etc.) be |
49
|
|
|
# hidden from tools like %who? |
50
|
|
|
# c.InteractiveShellApp.hide_initial_ns = True |
51
|
|
|
|
52
|
|
|
## Configure matplotlib for interactive use with the default matplotlib backend. |
53
|
|
|
# c.InteractiveShellApp.matplotlib = None |
54
|
|
|
|
55
|
|
|
## Run the module as a script. |
56
|
|
|
# c.InteractiveShellApp.module_to_run = '' |
57
|
|
|
|
58
|
|
|
## Pre-load matplotlib and numpy for interactive use, selecting a particular |
59
|
|
|
# matplotlib backend and loop integration. |
60
|
|
|
# c.InteractiveShellApp.pylab = None |
61
|
|
|
|
62
|
|
|
## If true, IPython will populate the user namespace with numpy, pylab, etc. and |
63
|
|
|
# an ``import *`` is done from numpy and pylab, when using pylab mode. |
64
|
|
|
# |
65
|
|
|
# When False, pylab mode should not import any names into the user namespace. |
66
|
|
|
# c.InteractiveShellApp.pylab_import_all = True |
67
|
|
|
|
68
|
|
|
## Reraise exceptions encountered loading IPython extensions? |
69
|
|
|
# c.InteractiveShellApp.reraise_ipython_extension_failures = False |
70
|
|
|
|
71
|
|
|
# ------------------------------------------------------------------------------ |
72
|
|
|
# Application(SingletonConfigurable) configuration |
73
|
|
|
# ------------------------------------------------------------------------------ |
74
|
|
|
|
75
|
|
|
## This is an application. |
76
|
|
|
|
77
|
|
|
## The date format used by logging formatters for %(asctime)s |
78
|
|
|
# c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S' |
79
|
|
|
|
80
|
|
|
## The Logging format template |
81
|
|
|
# c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s' |
82
|
|
|
|
83
|
|
|
## Set the log level by value or name. |
84
|
|
|
# c.Application.log_level = 30 |
85
|
|
|
|
86
|
|
|
# ------------------------------------------------------------------------------ |
87
|
|
|
# BaseIPythonApplication(Application) configuration |
88
|
|
|
# ------------------------------------------------------------------------------ |
89
|
|
|
|
90
|
|
|
## IPython: an enhanced interactive Python shell. |
91
|
|
|
|
92
|
|
|
## Whether to create profile dir if it doesn't exist |
93
|
|
|
# c.BaseIPythonApplication.auto_create = False |
94
|
|
|
|
95
|
|
|
## Whether to install the default config files into the profile dir. If a new |
96
|
|
|
# profile is being created, and IPython contains config files for that profile, |
97
|
|
|
# then they will be staged into the new directory. Otherwise, default config |
98
|
|
|
# files will be automatically generated. |
99
|
|
|
# c.BaseIPythonApplication.copy_config_files = False |
100
|
|
|
|
101
|
|
|
## Path to an extra config file to load. |
102
|
|
|
# |
103
|
|
|
# If specified, load this config file in addition to any other IPython config. |
104
|
|
|
# c.BaseIPythonApplication.extra_config_file = '' |
105
|
|
|
|
106
|
|
|
## The name of the IPython directory. This directory is used for logging |
107
|
|
|
# configuration (through profiles), history storage, etc. The default is usually |
108
|
|
|
# $HOME/.ipython. This option can also be specified through the environment |
109
|
|
|
# variable IPYTHONDIR. |
110
|
|
|
# c.BaseIPythonApplication.ipython_dir = '' |
111
|
|
|
|
112
|
|
|
## Whether to overwrite existing config files when copying |
113
|
|
|
# c.BaseIPythonApplication.overwrite = False |
114
|
|
|
|
115
|
|
|
## The IPython profile to use. |
116
|
|
|
# c.BaseIPythonApplication.profile = 'default' |
117
|
|
|
|
118
|
|
|
## Create a massive crash report when IPython encounters what may be an internal |
119
|
|
|
# error. The default is to append a short message to the usual traceback |
120
|
|
|
# c.BaseIPythonApplication.verbose_crash = False |
121
|
|
|
|
122
|
|
|
# ------------------------------------------------------------------------------ |
123
|
|
|
# TerminalIPythonApp(BaseIPythonApplication,InteractiveShellApp) configuration |
124
|
|
|
# ------------------------------------------------------------------------------ |
125
|
|
|
|
126
|
|
|
## Whether to display a banner upon starting IPython. |
127
|
|
|
# c.TerminalIPythonApp.display_banner = True |
128
|
|
|
|
129
|
|
|
## If a command or file is given via the command-line, e.g. 'ipython foo.py', |
130
|
|
|
# start an interactive shell after executing the file or command. |
131
|
|
|
# c.TerminalIPythonApp.force_interact = False |
132
|
|
|
|
133
|
|
|
## Class to use to instantiate the TerminalInteractiveShell object. Useful for |
134
|
|
|
# custom Frontends |
135
|
|
|
# c.TerminalIPythonApp.interactive_shell_class = 'IPython.terminal.interactiveshell.TerminalInteractiveShell' |
136
|
|
|
|
137
|
|
|
## Start IPython quickly by skipping the loading of config files. |
138
|
|
|
# c.TerminalIPythonApp.quick = False |
139
|
|
|
|
140
|
|
|
# ------------------------------------------------------------------------------ |
141
|
|
|
# InteractiveShell(SingletonConfigurable) configuration |
142
|
|
|
# ------------------------------------------------------------------------------ |
143
|
|
|
|
144
|
|
|
## An enhanced, interactive shell for Python. |
145
|
|
|
|
146
|
|
|
## 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying which |
147
|
|
|
# nodes should be run interactively (displaying output from expressions). |
148
|
|
|
# c.InteractiveShell.ast_node_interactivity = 'last_expr' |
149
|
|
|
|
150
|
|
|
## A list of ast.NodeTransformer subclass instances, which will be applied to |
151
|
|
|
# user input before code is run. |
152
|
|
|
# c.InteractiveShell.ast_transformers = [] |
153
|
|
|
|
154
|
|
|
## Automatically run await statement in the top level repl. |
155
|
|
|
# c.InteractiveShell.autoawait = True |
156
|
|
|
|
157
|
|
|
## Make IPython automatically call any callable object even if you didn't type |
158
|
|
|
# explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically. |
159
|
|
|
# The value can be '0' to disable the feature, '1' for 'smart' autocall, where |
160
|
|
|
# it is not applied if there are no more arguments on the line, and '2' for |
161
|
|
|
# 'full' autocall, where all callable objects are automatically called (even if |
162
|
|
|
# no arguments are present). |
163
|
|
|
# c.InteractiveShell.autocall = 0 |
164
|
|
|
|
165
|
|
|
## Autoindent IPython code entered interactively. |
166
|
|
|
# c.InteractiveShell.autoindent = True |
167
|
|
|
|
168
|
|
|
## Enable magic commands to be called without the leading %. |
169
|
|
|
# c.InteractiveShell.automagic = True |
170
|
|
|
|
171
|
|
|
## The part of the banner to be printed before the profile |
172
|
|
|
# c.InteractiveShell.banner1 = "Python 3.8.1 (default, Jan 9 2020, 14:37:22) \nType 'copyright', 'credits' or 'license' for more information\nIPython 7.12.0 -- An enhanced Interactive Python. Type '?' for help.\n" |
173
|
|
|
|
174
|
|
|
## The part of the banner to be printed after the profile |
175
|
|
|
# c.InteractiveShell.banner2 = '' |
176
|
|
|
|
177
|
|
|
## Set the size of the output cache. The default is 1000, you can change it |
178
|
|
|
# permanently in your config file. Setting it to 0 completely disables the |
179
|
|
|
# caching system, and the minimum value accepted is 3 (if you provide a value |
180
|
|
|
# less than 3, it is reset to 0 and a warning is issued). This limit is defined |
181
|
|
|
# because otherwise you'll spend more time re-flushing a too small cache than |
182
|
|
|
# working |
183
|
|
|
# c.InteractiveShell.cache_size = 1000 |
184
|
|
|
|
185
|
|
|
## Use colors for displaying information about objects. Because this information |
186
|
|
|
# is passed through a pager (like 'less'), and some pagers get confused with |
187
|
|
|
# color codes, this capability can be turned off. |
188
|
|
|
# c.InteractiveShell.color_info = True |
189
|
|
|
|
190
|
|
|
## Set the color scheme (NoColor, Neutral, Linux, or LightBG). |
191
|
|
|
# c.InteractiveShell.colors = 'Neutral' |
192
|
|
|
|
193
|
|
|
## |
194
|
|
|
# c.InteractiveShell.debug = False |
195
|
|
|
|
196
|
|
|
## Don't call post-execute functions that have failed in the past. |
197
|
|
|
# c.InteractiveShell.disable_failing_post_execute = False |
198
|
|
|
|
199
|
|
|
## If True, anything that would be passed to the pager will be displayed as |
200
|
|
|
# regular output instead. |
201
|
|
|
# c.InteractiveShell.display_page = False |
202
|
|
|
|
203
|
|
|
## (Provisional API) enables html representation in mime bundles sent to pagers. |
204
|
|
|
# c.InteractiveShell.enable_html_pager = False |
205
|
|
|
|
206
|
|
|
## Total length of command history |
207
|
|
|
# c.InteractiveShell.history_length = 10000 |
208
|
|
|
|
209
|
|
|
## The number of saved history entries to be loaded into the history buffer at |
210
|
|
|
# startup. |
211
|
|
|
# c.InteractiveShell.history_load_length = 1000 |
212
|
|
|
|
213
|
|
|
## |
214
|
|
|
# c.InteractiveShell.ipython_dir = '' |
215
|
|
|
|
216
|
|
|
## Start logging to the given file in append mode. Use `logfile` to specify a log |
217
|
|
|
# file to **overwrite** logs to. |
218
|
|
|
# c.InteractiveShell.logappend = '' |
219
|
|
|
|
220
|
|
|
## The name of the logfile to use. |
221
|
|
|
# c.InteractiveShell.logfile = '' |
222
|
|
|
|
223
|
|
|
## Start logging to the default log file in overwrite mode. Use `logappend` to |
224
|
|
|
# specify a log file to **append** logs to. |
225
|
|
|
# c.InteractiveShell.logstart = False |
226
|
|
|
|
227
|
|
|
## Select the loop runner that will be used to execute top-level asynchronous |
228
|
|
|
# code |
229
|
|
|
# c.InteractiveShell.loop_runner = 'IPython.core.interactiveshell._asyncio_runner' |
230
|
|
|
|
231
|
|
|
## |
232
|
|
|
# c.InteractiveShell.object_info_string_level = 0 |
233
|
|
|
|
234
|
|
|
## Automatically call the pdb debugger after every exception. |
235
|
|
|
# c.InteractiveShell.pdb = False |
236
|
|
|
|
237
|
|
|
## Deprecated since IPython 4.0 and ignored since 5.0, set |
238
|
|
|
# TerminalInteractiveShell.prompts object directly. |
239
|
|
|
# c.InteractiveShell.prompt_in1 = 'In [\\#]: ' |
240
|
|
|
|
241
|
|
|
## Deprecated since IPython 4.0 and ignored since 5.0, set |
242
|
|
|
# TerminalInteractiveShell.prompts object directly. |
243
|
|
|
# c.InteractiveShell.prompt_in2 = ' .\\D.: ' |
244
|
|
|
|
245
|
|
|
## Deprecated since IPython 4.0 and ignored since 5.0, set |
246
|
|
|
# TerminalInteractiveShell.prompts object directly. |
247
|
|
|
# c.InteractiveShell.prompt_out = 'Out[\\#]: ' |
248
|
|
|
|
249
|
|
|
## Deprecated since IPython 4.0 and ignored since 5.0, set |
250
|
|
|
# TerminalInteractiveShell.prompts object directly. |
251
|
|
|
# c.InteractiveShell.prompts_pad_left = True |
252
|
|
|
|
253
|
|
|
## |
254
|
|
|
# c.InteractiveShell.quiet = False |
255
|
|
|
|
256
|
|
|
## |
257
|
|
|
# c.InteractiveShell.separate_in = '\n' |
258
|
|
|
|
259
|
|
|
## |
260
|
|
|
# c.InteractiveShell.separate_out = '' |
261
|
|
|
|
262
|
|
|
## |
263
|
|
|
# c.InteractiveShell.separate_out2 = '' |
264
|
|
|
|
265
|
|
|
## Show rewritten input, e.g. for autocall. |
266
|
|
|
# c.InteractiveShell.show_rewritten_input = True |
267
|
|
|
|
268
|
|
|
## Enables rich html representation of docstrings. (This requires the docrepr |
269
|
|
|
# module). |
270
|
|
|
# c.InteractiveShell.sphinxify_docstring = False |
271
|
|
|
|
272
|
|
|
## |
273
|
|
|
# c.InteractiveShell.wildcards_case_sensitive = True |
274
|
|
|
|
275
|
|
|
## Switch modes for the IPython exception handlers. |
276
|
|
|
# c.InteractiveShell.xmode = 'Context' |
277
|
|
|
|
278
|
|
|
# ------------------------------------------------------------------------------ |
279
|
|
|
# TerminalInteractiveShell(InteractiveShell) configuration |
280
|
|
|
# ------------------------------------------------------------------------------ |
281
|
|
|
|
282
|
|
|
## Autoformatter to reformat Terminal code. Can be `'black'` or `None` |
283
|
|
|
# c.TerminalInteractiveShell.autoformatter = None |
284
|
|
|
|
285
|
|
|
## Set to confirm when you try to exit IPython with an EOF (Control-D in Unix, |
286
|
|
|
# Control-Z/Enter in Windows). By typing 'exit' or 'quit', you can force a |
287
|
|
|
# direct exit without any confirmation. |
288
|
|
|
# c.TerminalInteractiveShell.confirm_exit = True |
289
|
|
|
|
290
|
|
|
## Options for displaying tab completions, 'column', 'multicolumn', and |
291
|
|
|
# 'readlinelike'. These options are for `prompt_toolkit`, see `prompt_toolkit` |
292
|
|
|
# documentation for more information. |
293
|
|
|
# c.TerminalInteractiveShell.display_completions = 'multicolumn' |
294
|
|
|
|
295
|
|
|
## Shortcut style to use at the prompt. 'vi' or 'emacs'. |
296
|
|
|
# c.TerminalInteractiveShell.editing_mode = 'emacs' |
297
|
|
|
|
298
|
|
|
## Set the editor used by IPython (default to $EDITOR/vi/notepad). |
299
|
|
|
# c.TerminalInteractiveShell.editor = 'vim' |
300
|
|
|
|
301
|
|
|
## Allows to enable/disable the prompt toolkit history search |
302
|
|
|
# c.TerminalInteractiveShell.enable_history_search = True |
303
|
|
|
|
304
|
|
|
## Enable vi (v) or Emacs (C-X C-E) shortcuts to open an external editor. This is |
305
|
|
|
# in addition to the F2 binding, which is always enabled. |
306
|
|
|
# c.TerminalInteractiveShell.extra_open_editor_shortcuts = False |
307
|
|
|
|
308
|
|
|
## Provide an alternative handler to be called when the user presses Return. This |
309
|
|
|
# is an advanced option intended for debugging, which may be changed or removed |
310
|
|
|
# in later releases. |
311
|
|
|
# c.TerminalInteractiveShell.handle_return = None |
312
|
|
|
|
313
|
|
|
## Highlight matching brackets. |
314
|
|
|
# c.TerminalInteractiveShell.highlight_matching_brackets = True |
315
|
|
|
|
316
|
|
|
## The name or class of a Pygments style to use for syntax highlighting. To see |
317
|
|
|
# available styles, run `pygmentize -L styles`. |
318
|
|
|
# c.TerminalInteractiveShell.highlighting_style = traitlets.Undefined |
319
|
|
|
|
320
|
|
|
## Override highlighting format for specific tokens |
321
|
|
|
# c.TerminalInteractiveShell.highlighting_style_overrides = {} |
322
|
|
|
|
323
|
|
|
## |
324
|
|
|
# c.TerminalInteractiveShell.mime_renderers = {} |
325
|
|
|
|
326
|
|
|
## Enable mouse support in the prompt (Note: prevents selecting text with the |
327
|
|
|
# mouse) |
328
|
|
|
# c.TerminalInteractiveShell.mouse_support = False |
329
|
|
|
|
330
|
|
|
## Display the current vi mode (when using vi editing mode). |
331
|
|
|
# c.TerminalInteractiveShell.prompt_includes_vi_mode = True |
332
|
|
|
|
333
|
|
|
## Class used to generate Prompt token for prompt_toolkit |
334
|
|
|
# c.TerminalInteractiveShell.prompts_class = 'IPython.terminal.prompts.Prompts' |
335
|
|
|
|
336
|
|
|
## Use `raw_input` for the REPL, without completion and prompt colors. |
337
|
|
|
# |
338
|
|
|
# Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. |
339
|
|
|
# Known usage are: IPython own testing machinery, and emacs inferior-shell |
340
|
|
|
# integration through elpy. |
341
|
|
|
# |
342
|
|
|
# This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT` environment |
343
|
|
|
# variable is set, or the current terminal is not a tty. |
344
|
|
|
# c.TerminalInteractiveShell.simple_prompt = False |
345
|
|
|
|
346
|
|
|
## Number of line at the bottom of the screen to reserve for the completion menu |
347
|
|
|
# c.TerminalInteractiveShell.space_for_menu = 6 |
348
|
|
|
|
349
|
|
|
## Automatically set the terminal title |
350
|
|
|
# c.TerminalInteractiveShell.term_title = True |
351
|
|
|
|
352
|
|
|
## Customize the terminal title format. This is a python format string. |
353
|
|
|
# Available substitutions are: {cwd}. |
354
|
|
|
# c.TerminalInteractiveShell.term_title_format = 'IPython: {cwd}' |
355
|
|
|
|
356
|
|
|
## Use 24bit colors instead of 256 colors in prompt highlighting. If your |
357
|
|
|
# terminal supports true color, the following command should print 'TRUECOLOR' |
358
|
|
|
# in orange: printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n" |
359
|
|
|
# c.TerminalInteractiveShell.true_color = False |
360
|
|
|
|
361
|
|
|
# ------------------------------------------------------------------------------ |
362
|
|
|
# HistoryAccessor(HistoryAccessorBase) configuration |
363
|
|
|
# ------------------------------------------------------------------------------ |
364
|
|
|
|
365
|
|
|
## Access the history database without adding to it. |
366
|
|
|
# |
367
|
|
|
# This is intended for use by standalone history tools. IPython shells use |
368
|
|
|
# HistoryManager, below, which is a subclass of this. |
369
|
|
|
|
370
|
|
|
## Options for configuring the SQLite connection |
371
|
|
|
# |
372
|
|
|
# These options are passed as keyword args to sqlite3.connect when establishing |
373
|
|
|
# database connections. |
374
|
|
|
# c.HistoryAccessor.connection_options = {} |
375
|
|
|
|
376
|
|
|
## enable the SQLite history |
377
|
|
|
# |
378
|
|
|
# set enabled=False to disable the SQLite history, in which case there will be |
379
|
|
|
# no stored history, no SQLite connection, and no background saving thread. |
380
|
|
|
# This may be necessary in some threaded environments where IPython is embedded. |
381
|
|
|
# c.HistoryAccessor.enabled = True |
382
|
|
|
|
383
|
|
|
## Path to file to use for SQLite history database. |
384
|
|
|
# |
385
|
|
|
# By default, IPython will put the history database in the IPython profile |
386
|
|
|
# directory. If you would rather share one history among profiles, you can set |
387
|
|
|
# this value in each, so that they are consistent. |
388
|
|
|
# |
389
|
|
|
# Due to an issue with fcntl, SQLite is known to misbehave on some NFS mounts. |
390
|
|
|
# If you see IPython hanging, try setting this to something on a local disk, |
391
|
|
|
# e.g:: |
392
|
|
|
# |
393
|
|
|
# ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite |
394
|
|
|
# |
395
|
|
|
# you can also use the specific value `:memory:` (including the colon at both |
396
|
|
|
# end but not the back ticks), to avoid creating an history file. |
397
|
|
|
# c.HistoryAccessor.hist_file = '' |
398
|
|
|
|
399
|
|
|
# ------------------------------------------------------------------------------ |
400
|
|
|
# HistoryManager(HistoryAccessor) configuration |
401
|
|
|
# ------------------------------------------------------------------------------ |
402
|
|
|
|
403
|
|
|
## A class to organize all history-related functionality in one place. |
404
|
|
|
|
405
|
|
|
## Write to database every x commands (higher values save disk access & power). |
406
|
|
|
# Values of 1 or less effectively disable caching. |
407
|
|
|
# c.HistoryManager.db_cache_size = 0 |
408
|
|
|
|
409
|
|
|
## Should the history database include output? (default: no) |
410
|
|
|
# c.HistoryManager.db_log_output = False |
411
|
|
|
|
412
|
|
|
# ------------------------------------------------------------------------------ |
413
|
|
|
# ProfileDir(LoggingConfigurable) configuration |
414
|
|
|
# ------------------------------------------------------------------------------ |
415
|
|
|
|
416
|
|
|
## An object to manage the profile directory and its resources. |
417
|
|
|
# |
418
|
|
|
# The profile directory is used by all IPython applications, to manage |
419
|
|
|
# configuration, logging and security. |
420
|
|
|
# |
421
|
|
|
# This object knows how to find, create and manage these directories. This |
422
|
|
|
# should be used by any code that wants to handle profiles. |
423
|
|
|
|
424
|
|
|
## Set the profile location directly. This overrides the logic used by the |
425
|
|
|
# `profile` option. |
426
|
|
|
# c.ProfileDir.location = '' |
427
|
|
|
|
428
|
|
|
# ------------------------------------------------------------------------------ |
429
|
|
|
# BaseFormatter(Configurable) configuration |
430
|
|
|
# ------------------------------------------------------------------------------ |
431
|
|
|
|
432
|
|
|
## A base formatter class that is configurable. |
433
|
|
|
# |
434
|
|
|
# This formatter should usually be used as the base class of all formatters. It |
435
|
|
|
# is a traited :class:`Configurable` class and includes an extensible API for |
436
|
|
|
# users to determine how their objects are formatted. The following logic is |
437
|
|
|
# used to find a function to format an given object. |
438
|
|
|
# |
439
|
|
|
# 1. The object is introspected to see if it has a method with the name |
440
|
|
|
# :attr:`print_method`. If is does, that object is passed to that method |
441
|
|
|
# for formatting. |
442
|
|
|
# 2. If no print method is found, three internal dictionaries are consulted |
443
|
|
|
# to find print method: :attr:`singleton_printers`, :attr:`type_printers` |
444
|
|
|
# and :attr:`deferred_printers`. |
445
|
|
|
# |
446
|
|
|
# Users should use these dictionaries to register functions that will be used to |
447
|
|
|
# compute the format data for their objects (if those objects don't have the |
448
|
|
|
# special print methods). The easiest way of using these dictionaries is through |
449
|
|
|
# the :meth:`for_type` and :meth:`for_type_by_name` methods. |
450
|
|
|
# |
451
|
|
|
# If no function/callable is found to compute the format data, ``None`` is |
452
|
|
|
# returned and this format type is not used. |
453
|
|
|
|
454
|
|
|
## |
455
|
|
|
# c.BaseFormatter.deferred_printers = {} |
456
|
|
|
|
457
|
|
|
## |
458
|
|
|
# c.BaseFormatter.enabled = True |
459
|
|
|
|
460
|
|
|
## |
461
|
|
|
# c.BaseFormatter.singleton_printers = {} |
462
|
|
|
|
463
|
|
|
## |
464
|
|
|
# c.BaseFormatter.type_printers = {} |
465
|
|
|
|
466
|
|
|
# ------------------------------------------------------------------------------ |
467
|
|
|
# PlainTextFormatter(BaseFormatter) configuration |
468
|
|
|
# ------------------------------------------------------------------------------ |
469
|
|
|
|
470
|
|
|
## The default pretty-printer. |
471
|
|
|
# |
472
|
|
|
# This uses :mod:`IPython.lib.pretty` to compute the format data of the object. |
473
|
|
|
# If the object cannot be pretty printed, :func:`repr` is used. See the |
474
|
|
|
# documentation of :mod:`IPython.lib.pretty` for details on how to write pretty |
475
|
|
|
# printers. Here is a simple example:: |
476
|
|
|
# |
477
|
|
|
# def dtype_pprinter(obj, p, cycle): |
478
|
|
|
# if cycle: |
479
|
|
|
# return p.text('dtype(...)') |
480
|
|
|
# if hasattr(obj, 'fields'): |
481
|
|
|
# if obj.fields is None: |
482
|
|
|
# p.text(repr(obj)) |
483
|
|
|
# else: |
484
|
|
|
# p.begin_group(7, 'dtype([') |
485
|
|
|
# for i, field in enumerate(obj.descr): |
486
|
|
|
# if i > 0: |
487
|
|
|
# p.text(',') |
488
|
|
|
# p.breakable() |
489
|
|
|
# p.pretty(field) |
490
|
|
|
# p.end_group(7, '])') |
491
|
|
|
|
492
|
|
|
## |
493
|
|
|
# c.PlainTextFormatter.float_precision = '' |
494
|
|
|
|
495
|
|
|
## Truncate large collections (lists, dicts, tuples, sets) to this size. |
496
|
|
|
# |
497
|
|
|
# Set to 0 to disable truncation. |
498
|
|
|
# c.PlainTextFormatter.max_seq_length = 1000 |
499
|
|
|
|
500
|
|
|
## |
501
|
|
|
# c.PlainTextFormatter.max_width = 79 |
502
|
|
|
|
503
|
|
|
## |
504
|
|
|
# c.PlainTextFormatter.newline = '\n' |
505
|
|
|
|
506
|
|
|
## |
507
|
|
|
# c.PlainTextFormatter.pprint = True |
508
|
|
|
|
509
|
|
|
## |
510
|
|
|
# c.PlainTextFormatter.verbose = False |
511
|
|
|
|
512
|
|
|
# ------------------------------------------------------------------------------ |
513
|
|
|
# Completer(Configurable) configuration |
514
|
|
|
# ------------------------------------------------------------------------------ |
515
|
|
|
|
516
|
|
|
## Enable unicode completions, e.g. \alpha<tab> . Includes completion of latex |
517
|
|
|
# commands, unicode names, and expanding unicode characters back to latex |
518
|
|
|
# commands. |
519
|
|
|
# c.Completer.backslash_combining_completions = True |
520
|
|
|
|
521
|
|
|
## Enable debug for the Completer. Mostly print extra information for |
522
|
|
|
# experimental jedi integration. |
523
|
|
|
# c.Completer.debug = False |
524
|
|
|
|
525
|
|
|
## Activate greedy completion PENDING DEPRECTION. this is now mostly taken care |
526
|
|
|
# of with Jedi. |
527
|
|
|
# |
528
|
|
|
# This will enable completion on elements of lists, results of function calls, |
529
|
|
|
# etc., but can be unsafe because the code is actually evaluated on TAB. |
530
|
|
|
# c.Completer.greedy = False |
531
|
|
|
|
532
|
|
|
## Experimental: restrict time (in milliseconds) during which Jedi can compute |
533
|
|
|
# types. Set to 0 to stop computing types. Non-zero value lower than 100ms may |
534
|
|
|
# hurt performance by preventing jedi to build its cache. |
535
|
|
|
# c.Completer.jedi_compute_type_timeout = 400 |
536
|
|
|
|
537
|
|
|
## Experimental: Use Jedi to generate autocompletions. Default to True if jedi is |
538
|
|
|
# installed. |
539
|
|
|
# c.Completer.use_jedi = True |
540
|
|
|
|
541
|
|
|
# ------------------------------------------------------------------------------ |
542
|
|
|
# IPCompleter(Completer) configuration |
543
|
|
|
# ------------------------------------------------------------------------------ |
544
|
|
|
|
545
|
|
|
## Extension of the completer class with IPython-specific features |
546
|
|
|
|
547
|
|
|
## DEPRECATED as of version 5.0. |
548
|
|
|
# |
549
|
|
|
# Instruct the completer to use __all__ for the completion |
550
|
|
|
# |
551
|
|
|
# Specifically, when completing on ``object.<tab>``. |
552
|
|
|
# |
553
|
|
|
# When True: only those names in obj.__all__ will be included. |
554
|
|
|
# |
555
|
|
|
# When False [default]: the __all__ attribute is ignored |
556
|
|
|
# c.IPCompleter.limit_to__all__ = False |
557
|
|
|
|
558
|
|
|
## Whether to merge completion results into a single list |
559
|
|
|
# |
560
|
|
|
# If False, only the completion results from the first non-empty completer will |
561
|
|
|
# be returned. |
562
|
|
|
# c.IPCompleter.merge_completions = True |
563
|
|
|
|
564
|
|
|
## Instruct the completer to omit private method names |
565
|
|
|
# |
566
|
|
|
# Specifically, when completing on ``object.<tab>``. |
567
|
|
|
# |
568
|
|
|
# When 2 [default]: all names that start with '_' will be excluded. |
569
|
|
|
# |
570
|
|
|
# When 1: all 'magic' names (``__foo__``) will be excluded. |
571
|
|
|
# |
572
|
|
|
# When 0: nothing will be excluded. |
573
|
|
|
# c.IPCompleter.omit__names = 2 |
574
|
|
|
|
575
|
|
|
# ------------------------------------------------------------------------------ |
576
|
|
|
# ScriptMagics(Magics) configuration |
577
|
|
|
# ------------------------------------------------------------------------------ |
578
|
|
|
|
579
|
|
|
## Magics for talking to scripts |
580
|
|
|
# |
581
|
|
|
# This defines a base `%%script` cell magic for running a cell with a program in |
582
|
|
|
# a subprocess, and registers a few top-level magics that call %%script with |
583
|
|
|
# common interpreters. |
584
|
|
|
|
585
|
|
|
## Extra script cell magics to define |
586
|
|
|
# |
587
|
|
|
# This generates simple wrappers of `%%script foo` as `%%foo`. |
588
|
|
|
# |
589
|
|
|
# If you want to add script magics that aren't on your path, specify them in |
590
|
|
|
# script_paths |
591
|
|
|
# c.ScriptMagics.script_magics = [] |
592
|
|
|
|
593
|
|
|
## Dict mapping short 'ruby' names to full paths, such as '/opt/secret/bin/ruby' |
594
|
|
|
# |
595
|
|
|
# Only necessary for items in script_magics where the default path will not find |
596
|
|
|
# the right interpreter. |
597
|
|
|
# c.ScriptMagics.script_paths = {} |
598
|
|
|
|
599
|
|
|
# ------------------------------------------------------------------------------ |
600
|
|
|
# LoggingMagics(Magics) configuration |
601
|
|
|
# ------------------------------------------------------------------------------ |
602
|
|
|
|
603
|
|
|
## Magics related to all logging machinery. |
604
|
|
|
|
605
|
|
|
## Suppress output of log state when logging is enabled |
606
|
|
|
# c.LoggingMagics.quiet = False |
607
|
|
|
|
608
|
|
|
# ------------------------------------------------------------------------------ |
609
|
|
|
# StoreMagics(Magics) configuration |
610
|
|
|
# ------------------------------------------------------------------------------ |
611
|
|
|
|
612
|
|
|
## Lightweight persistence for python variables. |
613
|
|
|
# |
614
|
|
|
# Provides the %store magic. |
615
|
|
|
|
616
|
|
|
## If True, any %store-d variables will be automatically restored when IPython |
617
|
|
|
# starts. |
618
|
|
|
# c.StoreMagics.autorestore = False |
619
|
|
|
|