annotate runtime/doc/if_pyth.txt @ 3682:11d40fc82f11

Updated runtime files.
author Bram Moolenaar <bram@vim.org>
date Thu, 12 Jul 2012 22:01:11 +0200
parents b7811ab264bf
children 536aa8b0c934
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3312
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
1 *if_pyth.txt* For Vim version 7.3. Last change: 2012 Feb 04
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Paul Moore
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 The Python Interface to Vim *python* *Python*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
9 1. Commands |python-commands|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
10 2. The vim module |python-vim|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
11 3. Buffer objects |python-buffer|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
12 4. Range objects |python-range|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
13 5. Window objects |python-window|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
14 6. pyeval(), py3eval() Vim functions |python-pyeval|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
15 7. Dynamic loading |python-dynamic|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
16 8. Python 3 |python3|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 {Vi does not have any of these commands}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19
2350
06feaf4fe36a Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
20 The Python 2.x interface is available only when Vim was compiled with the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 |+python| feature.
2350
06feaf4fe36a Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
22 The Python 3 interface is available only when Vim was compiled with the
06feaf4fe36a Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
23 |+python3| feature.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 1. Commands *python-commands*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 *:python* *:py* *E205* *E263* *E264*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 :[range]py[thon] {stmt}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 Execute Python statement {stmt}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 :[range]py[thon] << {endmarker}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 {script}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 {endmarker}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 Execute Python script {script}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 Note: This command doesn't work when the Python
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 feature wasn't compiled in. To avoid errors, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 |script-here|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 {endmarker} must NOT be preceded by any white space. If {endmarker} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 omitted from after the "<<", a dot '.' must be used after {script}, like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 for the |:append| and |:insert| commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 This form of the |:python| command is mainly useful for including python code
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 in Vim scripts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 function! IcecreamInitialize()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 python << EOF
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 class StrawberryIcecream:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 def __call__(self):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 print 'EAT ME'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 EOF
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 Note: Python is very sensitive to the indenting. Also make sure the "class"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 line and "EOF" do not have any indent.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 *:pyfile* *:pyf*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 :[range]pyf[ile] {file}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 Execute the Python script in {file}. The whole
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 argument is used as a single file name. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 Both of these commands do essentially the same thing - they execute a piece of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 Python code, with the "current range" |python-range| set to the given line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 range.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 In the case of :python, the code to execute is in the command-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 In the case of :pyfile, the code to execute is the contents of the given file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 Python commands cannot be used in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 To pass arguments you need to set sys.argv[] explicitly. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 :python import sys
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 :python sys.argv = ["foo", "bar"]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 :pyfile myscript.py
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 Here are some examples *python-examples* >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 :python from vim import *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 :python from string import upper
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 :python current.line = upper(current.line)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 :python print "Hello"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 :python str = current.buffer[42]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 (Note that changes - like the imports - persist from one command to the next,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 just like in the Python interpreter.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 2. The vim module *python-vim*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 Python code gets all of its access to vim (with one exception - see
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
93 |python-output| below) via the "vim" module. The vim module implements two
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 methods, three constants, and one error object. You need to import the vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 module before using it: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 :python import vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 Overview >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
99 :py print "Hello" # displays a message
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
100 :py vim.command(cmd) # execute an Ex command
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
101 :py w = vim.windows[n] # gets window "n"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
102 :py cw = vim.current.window # gets the current window
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
103 :py b = vim.buffers[n] # gets buffer "n"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
104 :py cb = vim.current.buffer # gets the current buffer
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
105 :py w.height = lines # sets the window height
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
106 :py w.cursor = (row, col) # sets the window cursor position
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
107 :py pos = w.cursor # gets a tuple (row, col)
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
108 :py name = b.name # gets the buffer file name
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
109 :py line = b[n] # gets a line from the buffer
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
110 :py lines = b[n:m] # gets a list of lines
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
111 :py num = len(b) # gets the number of lines
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
112 :py b[n] = str # sets a line in the buffer
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
113 :py b[n:m] = [str1, str2, str3] # sets a number of lines at once
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
114 :py del b[n] # deletes a line
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
115 :py del b[n:m] # deletes a number of lines
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 Methods of the "vim" module
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 vim.command(str) *python-command*
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
121 Executes the vim (ex-mode) command str. Returns None.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 Examples: >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
123 :py vim.command("set tw=72")
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
124 :py vim.command("%s/aaa/bbb/g")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 < The following definition executes Normal mode commands: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 def normal(str):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127 vim.command("normal "+str)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 # Note the use of single quotes to delimit a string containing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 # double quotes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 normal('"a2dd"aP')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 < *E659*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 The ":python" command cannot be used recursively with Python 2.2 and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 older. This only works with Python 2.3 and later: >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
134 :py vim.command("python print 'Hello again Python'")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 vim.eval(str) *python-eval*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 Evaluates the expression str using the vim internal expression
633
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
138 evaluator (see |expression|). Returns the expression result as:
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
139 - a string if the Vim expression evaluates to a string or number
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
140 - a list if the Vim expression evaluates to a Vim list
856
8cd729851562 updated for version 7.0g
vimboss
parents: 842
diff changeset
141 - a dictionary if the Vim expression evaluates to a Vim dictionary
633
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
142 Dictionaries and lists are recursively expanded.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 Examples: >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
144 :py text_width = vim.eval("&tw")
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
145 :py str = vim.eval("12+12") # NB result is a string! Use
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 # string.atoi() to convert to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 # a number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148
856
8cd729851562 updated for version 7.0g
vimboss
parents: 842
diff changeset
149 :py tagList = vim.eval('taglist("eval_expr")')
633
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
150 < The latter will return a python list of python dicts, for instance:
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
151 [{'cmd': '/^eval_expr(arg, nextcmd)$/', 'static': 0, 'name':
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
152 'eval_expr', 'kind': 'f', 'filename': './src/eval.c'}]
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
153
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
154 vim.bindeval(str) *python-bindeval*
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
155 Like |python-eval|, but
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
156 1. if expression evaluates to |List| or |Dictionary| it is returned as
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
157 vimlist or vimdictionary python type that are connected to original
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
158 list or dictionary. Thus modifications to these objects imply
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
159 modifications of the original.
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
160 2. if expression evaluates to a function reference, then it returns
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
161 callable vimfunction object. Use self keyword argument to assign
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
162 |self| object for dictionary functions.
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
163
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
164 Note: this function has the same behavior as |lua-eval| (except that
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
165 lua does not support running vim functions), |python-eval| is
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
166 kept for backwards compatibility in order not to make scripts
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
167 relying on outputs of vim.eval() being a copy of original or
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
168 vim.eval("1") returning a string.
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
169
633
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
170
7437be625546 updated for version 7.0183
vimboss
parents: 557
diff changeset
171
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 Error object of the "vim" module
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 vim.error *python-error*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 Upon encountering a Vim error, Python raises an exception of type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176 vim.error.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 try:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 vim.command("put a")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 except vim.error:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 # nothing in register a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 Constants of the "vim" module
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 Note that these are not actually constants - you could reassign them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186 But this is silly, as you would then lose access to the vim objects
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187 to which the variables referred.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189 vim.buffers *python-buffers*
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
190 A sequence object providing access to the list of vim buffers. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 object supports the following operations: >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
192 :py b = vim.buffers[i] # Indexing (read-only)
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
193 :py b in vim.buffers # Membership test
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
194 :py n = len(vim.buffers) # Number of elements
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
195 :py for b in vim.buffers: # Sequential access
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197 vim.windows *python-windows*
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
198 A sequence object providing access to the list of vim windows. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 object supports the following operations: >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
200 :py w = vim.windows[i] # Indexing (read-only)
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
201 :py w in vim.windows # Membership test
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
202 :py n = len(vim.windows) # Number of elements
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
203 :py for w in vim.windows: # Sequential access
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 vim.current *python-current*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206 An object providing access (via specific attributes) to various
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 "current" objects available in vim:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 vim.current.line The current line (RW) String
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209 vim.current.buffer The current buffer (RO) Buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 vim.current.window The current window (RO) Window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
211 vim.current.range The current line range (RO) Range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
213 The last case deserves a little explanation. When the :python or
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 :pyfile command specifies a range, this range of lines becomes the
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
215 "current range". A range is a bit like a buffer, but with all access
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
216 restricted to a subset of lines. See |python-range| for more details.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 Output from Python *python-output*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220 Vim displays all Python code output in the Vim message area. Normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221 output appears as information messages, and error output appears as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 error messages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224 In implementation terms, this means that all output to sys.stdout
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 (including the output from print statements) appears as information
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 messages, and all output to sys.stderr (including error tracebacks)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 appears as error messages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 *python-input*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230 Input (via sys.stdin, including input() and raw_input()) is not
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
231 supported, and may cause the program to crash. This should probably be
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 fixed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
233
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 3. Buffer objects *python-buffer*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
237 Buffer objects represent vim buffers. You can obtain them in a number of ways:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 - via vim.current.buffer (|python-current|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239 - from indexing vim.buffers (|python-buffers|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
240 - from the "buffer" attribute of a window (|python-window|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
241
3312
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
242 Buffer objects have two read-only attributes - name - the full file name for
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
243 the buffer, and number - the buffer number. They also have three methods
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
244 (append, mark, and range; see below).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
246 You can also treat buffer objects as sequence objects. In this context, they
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 act as if they were lists (yes, they are mutable) of strings, with each
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
248 element being a line of the buffer. All of the usual sequence operations,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249 including indexing, index assignment, slicing and slice assignment, work as
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
250 you would expect. Note that the result of indexing (slicing) a buffer is a
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
251 string (list of strings). This has one unusual consequence - b[:] is different
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
252 from b. In particular, "b[:] = None" deletes the whole of the buffer, whereas
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 "b = None" merely updates the variable b, with no effect on the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
255 Buffer indexes start at zero, as is normal in Python. This differs from vim
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
256 line numbers, which start from 1. This is particularly relevant when dealing
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 with marks (see below) which use vim line numbers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
259 The buffer object methods are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260 b.append(str) Append a line to the buffer
2391
f1d95a986dfb Document extra argument for Python append().
Bram Moolenaar <bram@vim.org>
parents: 2366
diff changeset
261 b.append(str, nr) Idem, below line "nr"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
262 b.append(list) Append a list of lines to the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 Note that the option of supplying a list of strings to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
264 the append method differs from the equivalent method
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 for Python's built-in list objects.
2391
f1d95a986dfb Document extra argument for Python append().
Bram Moolenaar <bram@vim.org>
parents: 2366
diff changeset
266 b.append(list, nr) Idem, below line "nr"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267 b.mark(name) Return a tuple (row,col) representing the position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 of the named mark (can also get the []"<> marks)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 b.range(s,e) Return a range object (see |python-range|) which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 represents the part of the given buffer between line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
271 numbers s and e |inclusive|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
273 Note that when adding a line it must not contain a line break character '\n'.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
274 A trailing '\n' is allowed and ignored, so that you can do: >
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
275 :py b.append(f.readlines())
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
276
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 Examples (assume b is the current buffer) >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
278 :py print b.name # write the buffer file name
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
279 :py b[0] = "hello!!!" # replace the top line
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
280 :py b[:] = None # delete the whole buffer
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
281 :py del b[:] # delete the whole buffer
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
282 :py b[0:0] = [ "a line" ] # add a line at the top
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
283 :py del b[2] # delete a line (the third)
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
284 :py b.append("bottom") # add a line at the bottom
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
285 :py n = len(b) # number of lines
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
286 :py (row,col) = b.mark('a') # named mark
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
287 :py r = b.range(1,5) # a sub-range of the buffer
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
288
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 4. Range objects *python-range*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
292 Range objects represent a part of a vim buffer. You can obtain them in a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 number of ways:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 - via vim.current.range (|python-current|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295 - from a buffer's range() method (|python-buffer|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
297 A range object is almost identical in operation to a buffer object. However,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298 all operations are restricted to the lines within the range (this line range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299 can, of course, change as a result of slice assignments, line deletions, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300 the range.append() method).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 The range object attributes are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 r.start Index of first line into the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304 r.end Index of last line into the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306 The range object methods are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307 r.append(str) Append a line to the range
2391
f1d95a986dfb Document extra argument for Python append().
Bram Moolenaar <bram@vim.org>
parents: 2366
diff changeset
308 r.append(str, nr) Idem, after line "nr"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309 r.append(list) Append a list of lines to the range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
310 Note that the option of supplying a list of strings to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311 the append method differs from the equivalent method
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
312 for Python's built-in list objects.
2391
f1d95a986dfb Document extra argument for Python append().
Bram Moolenaar <bram@vim.org>
parents: 2366
diff changeset
313 r.append(list, nr) Idem, after line "nr"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
314
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 Example (assume r is the current range):
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316 # Send all lines in a range to the default printer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317 vim.command("%d,%dhardcopy!" % (r.start+1,r.end+1))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 5. Window objects *python-window*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
322 Window objects represent vim windows. You can obtain them in a number of ways:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323 - via vim.current.window (|python-current|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 - from indexing vim.windows (|python-windows|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 20
diff changeset
326 You can manipulate window objects only through their attributes. They have no
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 methods, and no sequence or other interface.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329 Window attributes are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 buffer (read-only) The buffer displayed in this window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331 cursor (read-write) The current cursor position in the window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332 This is a tuple, (row,col).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 height (read-write) The window height, in rows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 width (read-write) The window width, in columns
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335 The height attribute is writable only if the screen is split horizontally.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 The width attribute is writable only if the screen is split vertically.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338 ==============================================================================
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
339 6. pyeval() and py3eval() Vim functions *python-pyeval*
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
340
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
341 To facilitate bi-directional interface, you can use |pyeval()| and |py3eval()|
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
342 functions to evaluate Python expressions and pass their values to VimL.
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
343
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
344 ==============================================================================
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
345 7. Dynamic loading *python-dynamic*
557
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
346
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
347 On MS-Windows the Python library can be loaded dynamically. The |:version|
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
348 output then includes |+python/dyn|.
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
349
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
350 This means that Vim will search for the Python DLL file only when needed.
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
351 When you don't use the Python interface you don't need it, thus you can use
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
352 Vim without this DLL file.
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
353
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
354 To use the Python interface the Python DLL must be in your search path. In a
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
355 console window type "path" to see what directories are used.
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
356
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
357 The name of the DLL must match the Python version Vim was compiled with.
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
358 Currently the name is "python24.dll". That is for Python 2.4. To know for
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
359 sure edit "gvim.exe" and search for "python\d*.dll\c".
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
360
862863033fdd updated for version 7.0158
vimboss
parents: 236
diff changeset
361 ==============================================================================
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
362 8. Python 3 *python3*
2340
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
363
2560
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
364 *:py3* *:python3*
2409
0ca06a92adfb Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents: 2391
diff changeset
365 The |:py3| and |:python3| commands work similar to |:python|.
2560
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
366 *:py3file*
2409
0ca06a92adfb Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents: 2391
diff changeset
367 The |:py3file| command works similar to |:pyfile|.
2340
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
368
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
369
2409
0ca06a92adfb Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents: 2391
diff changeset
370 Vim can be built in four ways (:version output):
2560
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
371 1. No Python support (-python, -python3)
2409
0ca06a92adfb Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents: 2391
diff changeset
372 2. Python 2 support only (+python or +python/dyn, -python3)
0ca06a92adfb Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents: 2391
diff changeset
373 3. Python 3 support only (-python, +python3 or +python3/dyn)
0ca06a92adfb Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents: 2391
diff changeset
374 4. Python 2 and 3 support (+python/dyn, +python3/dyn)
2340
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
375
2560
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
376 Some more details on the special case 4:
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
377
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
378 When Python 2 and Python 3 are both supported they must be loaded dynamically.
2540
9397d2d76340 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2527
diff changeset
379
2560
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
380 When doing this on Linux/Unix systems and importing global symbols, this leads
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
381 to a crash when the second Python version is used. So either global symbols
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
382 are loaded but only one Python version is activated, or no global symbols are
2608
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
383 loaded. The latter makes Python's "import" fail on libraries that expect the
2560
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
384 symbols to be provided by Vim.
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
385 *E836* *E837*
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
386 Vim's configuration script makes a guess for all libraries based on one
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
387 standard Python library (termios). If importing this library succeeds for
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
388 both Python versions, then both will be made available in Vim at the same
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
389 time. If not, only the version first used in a session will be enabled.
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
390 When trying to use the other one you will get the E836 or E837 error message.
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
391
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
392 Here Vim's behavior depends on the system in which it was configured. In a
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
393 system where both versions of Python were configured with --enable-shared,
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
394 both versions of Python will be activated at the same time. There will still
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
395 be problems with other third party libraries that were not linked to
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
396 libPython.
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
397
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
398 To work around such problems there are these options:
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
399 1. The problematic library is recompiled to link to the according
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
400 libpython.so.
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
401 2. Vim is recompiled for only one Python version.
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
402 3. You undefine PY_NO_RTLD_GLOBAL in auto/config.h after configuration. This
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
403 may crash Vim though.
84ba6293f9d7 Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents: 2554
diff changeset
404
2826
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
405 *has-python*
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
406 You can test what Python version is available with: >
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
407 if has('python')
3082
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2826
diff changeset
408 echo 'there is Python 2.x'
2826
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
409 elseif has('python3')
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
410 echo 'there is Python 3.x'
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
411 endif
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
412
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
413 Note however, that when Python 2 and 3 are both available and loaded
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
414 dynamically, these has() calls will try to load them. If only one can be
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
415 loaded at a time, just checking if Python 2 or 3 are available will prevent
3c7da93eb7f9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
416 the other one from being available.
2340
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
417
99c1eba60b2d Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
418 ==============================================================================
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
419 vim:tw=78:ts=8:ft=help:norl: