Show More
@@ -13,7 +13,7 itself, so hooks have full access to the entire IPython object. | |||
|
13 | 13 | |
|
14 | 14 | If you wish to define a new hook and activate it, you need to put the |
|
15 | 15 | necessary code into a python file which can be either imported or execfile()'d |
|
16 |
from within your ipython |
|
|
16 | from within your profile's ipython_config.py configuration. | |
|
17 | 17 | |
|
18 | 18 | For example, suppose that you have a module called 'myiphooks' in your |
|
19 | 19 | PYTHONPATH, which contains the following definition: |
@@ -640,11 +640,10 Currently the magic system has the following functions:\n""" | |||
|
640 | 640 | search. |
|
641 | 641 | |
|
642 | 642 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
643 |
these options |
|
|
644 |
file |
|
|
645 | 'wildcards_case_sensitive'. If this option is not specified in your | |
|
646 |
|
|
|
647 | search. | |
|
643 | these options are given, the default is read from your configuration | |
|
644 | file, with the option name 'wildcards_case_sensitive'. If this option | |
|
645 | is not specified in your configuration file, IPython's internal | |
|
646 | default is to do a case sensitive search. | |
|
648 | 647 | |
|
649 | 648 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
650 | 649 | specifiy can be searched in any of the following namespaces: |
@@ -1230,8 +1229,8 Currently the magic system has the following functions:\n""" | |||
|
1230 | 1229 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
1231 | 1230 | this feature on and off. |
|
1232 | 1231 | |
|
1233 |
The initial state of this feature is set in your |
|
|
1234 |
|
|
|
1232 | The initial state of this feature is set in your configuration | |
|
1233 | file (the option is called 'pdb'). | |
|
1235 | 1234 | |
|
1236 | 1235 | If you want to just activate the debugger AFTER an exception has fired, |
|
1237 | 1236 | without having to type '%pdb on' and rerunning your code, you can use |
@@ -2270,9 +2269,10 Currently the magic system has the following functions:\n""" | |||
|
2270 | 2269 | docstring for how to change the editor hook. |
|
2271 | 2270 | |
|
2272 | 2271 | You can also set the value of this editor via the command line option |
|
2273 |
'-editor' or in your |
|
|
2274 |
specifically for IPython an editor different from your typical |
|
|
2275 |
(and for Windows users who typically don't set environment |
|
|
2272 | '-editor' or in your configuration file. This is useful if you wish to | |
|
2273 | use specifically for IPython an editor different from your typical | |
|
2274 | default (and for Windows users who typically don't set environment | |
|
2275 | variables). | |
|
2276 | 2276 | |
|
2277 | 2277 | This command allows you to conveniently edit multi-line code right in |
|
2278 | 2278 | your IPython session. |
@@ -81,7 +81,7 MAIN FEATURES | |||
|
81 | 81 | |
|
82 | 82 | * Magic commands: type %magic for information on the magic subsystem. |
|
83 | 83 | |
|
84 |
* System command aliases, via the %alias command or the |
|
|
84 | * System command aliases, via the %alias command or the configuration file(s). | |
|
85 | 85 | |
|
86 | 86 | * Dynamic object information: |
|
87 | 87 |
@@ -328,9 +328,10 class PythonRunner(InteractiveRunner): | |||
|
328 | 328 | class SAGERunner(InteractiveRunner): |
|
329 | 329 | """Interactive SAGE runner. |
|
330 | 330 | |
|
331 |
WARNING: this runner only works if you manually |
|
|
332 | to use 'colors NoColor' in the ipythonrc config file, since currently the | |
|
333 |
prompt matching regexp does not identify |
|
|
331 | WARNING: this runner only works if you manually adjust your SAGE | |
|
332 | configuration so that the 'color' option in the configuration file is set to | |
|
333 | 'NoColor', because currently the prompt matching regexp does not identify | |
|
334 | color sequences.""" | |
|
334 | 335 | |
|
335 | 336 | def __init__(self,program='sage',args=None,out=sys.stdout,echo=True): |
|
336 | 337 | """New runner, optionally passing the sage command to use.""" |
@@ -3,11 +3,10 | |||
|
3 | 3 | Limitations: |
|
4 | 4 | |
|
5 | 5 | - When generating examples for use as doctests, make sure that you have |
|
6 |
pretty-printing OFF. This can be done either by s |
|
|
7 | flag '--nopprint', by setting pprint to 0 in your ipythonrc file, or by | |
|
8 | interactively disabling it with %Pprint. This is required so that IPython | |
|
9 |
|
|
|
10 | execution. | |
|
6 | pretty-printing OFF. This can be done either by setting the 'pprint' option | |
|
7 | in your configuration file to 'False', or by interactively disabling it with | |
|
8 | %Pprint. This is required so that IPython output matches that of normal | |
|
9 | Python, which is used by doctest for internal execution. | |
|
11 | 10 | |
|
12 | 11 | - Do not rely on specific prompt numbers for results (such as using |
|
13 | 12 | '_34==True', for example). For IPython tests run via an external process the |
@@ -242,9 +242,10 class ZMQInteractiveShell(InteractiveShell): | |||
|
242 | 242 | docstring for how to change the editor hook. |
|
243 | 243 | |
|
244 | 244 | You can also set the value of this editor via the command line option |
|
245 | '-editor' or in your ipythonrc file. This is useful if you wish to use | |
|
246 | specifically for IPython an editor different from your typical default | |
|
247 | (and for Windows users who typically don't set environment variables). | |
|
245 | '-editor' or via the 'editor' option in your configuration file. | |
|
246 | This is useful if you wish to use specifically for IPython an editor | |
|
247 | different from your typical default (and for Windows users who typically | |
|
248 | don't set environment variables). | |
|
248 | 249 | |
|
249 | 250 | This command allows you to conveniently edit multi-line code right in |
|
250 | 251 | your IPython session. |
@@ -19,10 +19,12 file and ignore your configuration setup. | |||
|
19 | 19 | |
|
20 | 20 | Please note that some of the configuration options are not available at |
|
21 | 21 | the command line, simply because they are not practical here. Look into |
|
22 |
your |
|
|
23 | installed in the IPYTHON_DIR directory. For Linux | |
|
24 | users, this will be $HOME/.config/ipython, and for other users it will be | |
|
25 | $HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents and | |
|
22 | your configuration files for details on those. There are separate configuration | |
|
23 | files for each profile, and the files look like "ipython_config.py" or | |
|
24 | "ipython_config_<frontendname>.py". Profile directories look like | |
|
25 | "profile_profilename" and are typically installed in the IPYTHON_DIR directory. | |
|
26 | For Linux users, this will be $HOME/.config/ipython, and for other users it | |
|
27 | will be $HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents and | |
|
26 | 28 | Settings\\YourUserName in most instances. |
|
27 | 29 | |
|
28 | 30 | |
@@ -46,9 +48,9 follow in any order. All options can be abbreviated to their shortest | |||
|
46 | 48 | non-ambiguous form and are case-sensitive. One or two dashes can be |
|
47 | 49 | used. Some options have an alternate short form, indicated after a ``|``. |
|
48 | 50 | |
|
49 |
Most options can also be set from your |
|
|
50 |
|
|
|
51 |
|
|
|
51 | Most options can also be set from your configuration file. See the provided | |
|
52 | example for more details on what the options do. Options given at the command | |
|
53 | line override the values set in the configuration file. | |
|
52 | 54 | |
|
53 | 55 | All options with a [no] prepended can be specified in negated form |
|
54 | 56 | (--no-option instead of --option) to turn the feature off. |
@@ -110,7 +112,7 All options with a [no] prepended can be specified in negated form | |||
|
110 | 112 | code and various other elements. However, because this information is |
|
111 | 113 | passed through a pager (like 'less') and many pagers get confused with |
|
112 | 114 | color codes, this option is off by default. You can test it and turn |
|
113 |
it on permanently in your |
|
|
115 | it on permanently in your configuration file if it works for you. As a | |
|
114 | 116 | reference, the 'less' pager supplied with Mandrake 8.2 works ok, but |
|
115 | 117 | that in RedHat 7.2 doesn't. |
|
116 | 118 | |
@@ -569,7 +571,7 syntax for this can be found in the readline documentation available | |||
|
569 | 571 | with your system or on the Internet. IPython doesn't read this file (if |
|
570 | 572 | it exists) directly, but it does support passing to readline valid |
|
571 | 573 | options via a simple interface. In brief, you can customize readline by |
|
572 |
setting the following options in your |
|
|
574 | setting the following options in your configuration file (note | |
|
573 | 575 | that these options can not be specified at the command line): |
|
574 | 576 | |
|
575 | 577 | * **readline_parse_and_bind**: this option can appear as many times as |
@@ -594,8 +596,7 that these options can not be specified at the command line): | |||
|
594 | 596 | This option is off by default so that new users see all |
|
595 | 597 | attributes of any objects they are dealing with. |
|
596 | 598 | |
|
597 |
You will find the default values |
|
|
598 | explanation in your ipythonrc file. | |
|
599 | You will find the default values in your configuration file. | |
|
599 | 600 | |
|
600 | 601 | |
|
601 | 602 | Session logging and restoring |
@@ -696,8 +697,7 Even object attributes can be expanded:: | |||
|
696 | 697 | System command aliases |
|
697 | 698 | ---------------------- |
|
698 | 699 | |
|
699 | The %alias magic function and the alias option in the ipythonrc | |
|
700 | configuration file allow you to define magic functions which are in fact | |
|
700 | The %alias magic functionallows you to define magic functions which are in fact | |
|
701 | 701 | system shell commands. These aliases can have parameters. |
|
702 | 702 | |
|
703 | 703 | ``%alias alias_name cmd`` defines 'alias_name' as an alias for 'cmd' |
@@ -828,7 +828,7 accidentally overwrite the Out variable you can recover it by typing | |||
|
828 | 828 | This system obviously can potentially put heavy memory demands on your |
|
829 | 829 | system, since it prevents Python's garbage collector from removing any |
|
830 | 830 | previously computed results. You can control how many results are kept |
|
831 |
in memory with the option (at the command line or in your |
|
|
831 | in memory with the option (at the command line or in your configuration | |
|
832 | 832 | file) cache_size. If you set it to 0, the whole system is completely |
|
833 | 833 | disabled and the prompts revert to the classic '>>>' of normal Python. |
|
834 | 834 |
@@ -127,5 +127,9 the IPython user list. | |||
|
127 | 127 | .. Now I have a nice little directory with everything I ever type in, |
|
128 | 128 | organized by project and date. |
|
129 | 129 | |
|
130 | .. warning:: | |
|
131 | ||
|
132 | This example uses the outdated ipythonrc-style configuration files, which no | |
|
133 | longer work as of IPython 0.11 | |
|
130 | 134 | |
|
131 | 135 |
General Comments 0
You need to be logged in to leave comments.
Login now