~ubuntu-branches/debian/experimental/spyder/experimental

« back to all changes in this revision

Viewing changes to doc/variableexplorer.rst

  • Committer: Package Import Robot
  • Author(s): Picca Frédéric-Emmanuel
  • Date: 2014-05-29 09:06:26 UTC
  • mfrom: (1.1.21) (18.1.6 sid)
  • Revision ID: package-import@ubuntu.com-20140529090626-f58t82g0n5iewaxu
Tags: 2.3.0~rc+dfsg-1~experimental2
* Add spyder-common binary package for all the python2,3 common files
* debian/path
  - 0001-fix-documentation-installation.patch (deleted)
  + 0001-fix-spyderlib-path.patch (new)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Variable Explorer
2
 
=================
3
 
 
4
 
The variable explorer shows the `globals()` namespace contents (i.e. all global 
5
 
object references) of the current console: it supports both the :doc:`console` 
6
 
(Python interpreter running in a remote process) 
7
 
and the :doc:`internalconsole`.
8
 
 
9
 
.. image:: images/variableexplorer1.png
10
 
 
11
 
The following screenshots show some interesting features such as editing 
12
 
lists, strings, dictionaries, NumPy arrays, or plotting/showing NumPy arrays
13
 
data.
14
 
 
15
 
.. image:: images/listeditor.png
16
 
 
17
 
.. image:: images/texteditor.png
18
 
 
19
 
.. image:: images/dicteditor.png
20
 
 
21
 
.. image:: images/arrayeditor.png
22
 
 
23
 
.. image:: images/variableexplorer-plot.png
24
 
 
25
 
.. image:: images/variableexplorer-imshow.png
26
 
 
27
 
The default variable explorer configuration allows to browse global variables 
28
 
without slowing the console even with very large NumPy arrays, lists or 
29
 
dictionaries. The trick is to truncate values, to hide collection contents 
30
 
(i.e. showing '<list @ address>' instead of list contents) and to *not* show 
31
 
mininum and maximum values for NumPy arrays (see context menu options on the 
32
 
screenshot at the top of this page).
33
 
 
34
 
However, most of the time, choosing the opposite options won't have too much 
35
 
effect on console's performance:
36
 
 
37
 
.. image:: images/variableexplorer2.png
38
 
 
39
 
 
40
 
Related plugins:
41
 
 
42
 
* :doc:`console`
43
 
* :doc:`internalconsole`
 
1
Variable Explorer
 
2
=================
 
3
 
 
4
The variable explorer shows the `globals()` namespace contents (i.e. all global 
 
5
object references) of the current console: it supports both the :doc:`console` 
 
6
(Python interpreter running in a remote process) 
 
7
and the :doc:`internalconsole`.
 
8
 
 
9
.. image:: images/variableexplorer1.png
 
10
 
 
11
The following screenshots show some interesting features such as editing 
 
12
lists, strings, dictionaries, NumPy arrays, or plotting/showing NumPy arrays
 
13
data.
 
14
 
 
15
.. image:: images/listeditor.png
 
16
 
 
17
.. image:: images/texteditor.png
 
18
 
 
19
.. image:: images/dicteditor.png
 
20
 
 
21
.. image:: images/arrayeditor.png
 
22
 
 
23
.. image:: images/variableexplorer-plot.png
 
24
 
 
25
.. image:: images/variableexplorer-imshow.png
 
26
 
 
27
The default variable explorer configuration allows to browse global variables 
 
28
without slowing the console even with very large NumPy arrays, lists or 
 
29
dictionaries. The trick is to truncate values, to hide collection contents 
 
30
(i.e. showing '<list @ address>' instead of list contents) and to *not* show 
 
31
mininum and maximum values for NumPy arrays (see context menu options on the 
 
32
screenshot at the top of this page).
 
33
 
 
34
However, most of the time, choosing the opposite options won't have too much 
 
35
effect on console's performance:
 
36
 
 
37
.. image:: images/variableexplorer2.png
 
38
 
 
39
 
 
40
Supported types
 
41
---------------
 
42
 
 
43
The variable explorer can't show all types of objects. The ones currently
 
44
supported are: integers, floats, complex, lists, dictionaries, tuples, strings,
 
45
`NumPy` arrays, `datetime` dates and `PIL/Pillow` images.
 
46
 
 
47
 
 
48
Related plugins:
 
49
 
 
50
* :doc:`console`
 
51
* :doc:`internalconsole`