Mercurial > vim
annotate runtime/doc/if_pyth.txt @ 4700:0c25fa1dfd97 v7.3.1097
updated for version 7.3.1097
Problem: Python: a few recently added items are not documented.
Solution: Update the documentation. (ZyX)
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Sun, 02 Jun 2013 17:46:40 +0200 |
parents | 2db005052371 |
children | 542af01979be |
rev | line source |
---|---|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4639
diff
changeset
|
1 *if_pyth.txt* For Vim version 7.3. Last change: 2013 May 25 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Paul Moore | |
5 | |
6 | |
7 The Python Interface to Vim *python* *Python* | |
8 | |
3682 | 9 1. Commands |python-commands| |
10 2. The vim module |python-vim| | |
11 3. Buffer objects |python-buffer| | |
12 4. Range objects |python-range| | |
13 5. Window objects |python-window| | |
4496 | 14 6. Tab page objects |python-tabpage| |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
15 7. vim.bindeval objects |python-bindeval-objects| |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
16 8. pyeval(), py3eval() Vim functions |python-pyeval| |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
17 9. Dynamic loading |python-dynamic| |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
18 10. Python 3 |python3| |
7 | 19 |
20 {Vi does not have any of these commands} | |
21 | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
22 The Python 2.x interface is available only when Vim was compiled with the |
7 | 23 |+python| feature. |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
24 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
|
25 |+python3| feature. |
7 | 26 |
27 ============================================================================== | |
28 1. Commands *python-commands* | |
29 | |
30 *:python* *:py* *E205* *E263* *E264* | |
31 :[range]py[thon] {stmt} | |
3750 | 32 Execute Python statement {stmt}. A simple check if |
33 the `:python` command is working: > | |
34 :python print "Hello" | |
7 | 35 |
36 :[range]py[thon] << {endmarker} | |
37 {script} | |
38 {endmarker} | |
39 Execute Python script {script}. | |
40 Note: This command doesn't work when the Python | |
41 feature wasn't compiled in. To avoid errors, see | |
42 |script-here|. | |
43 | |
44 {endmarker} must NOT be preceded by any white space. If {endmarker} is | |
45 omitted from after the "<<", a dot '.' must be used after {script}, like | |
46 for the |:append| and |:insert| commands. | |
47 This form of the |:python| command is mainly useful for including python code | |
48 in Vim scripts. | |
49 | |
50 Example: > | |
51 function! IcecreamInitialize() | |
52 python << EOF | |
53 class StrawberryIcecream: | |
54 def __call__(self): | |
55 print 'EAT ME' | |
56 EOF | |
57 endfunction | |
58 < | |
4073 | 59 Note: Python is very sensitive to the indenting. Make sure the "class" line |
60 and "EOF" do not have any indent. | |
7 | 61 |
4435 | 62 *:pydo* |
63 :[range]pydo {body} Execute Python function "def _vim_pydo(line, linenr): | |
64 {body}" for each line in the [range], with the | |
65 function arguments being set to the text of each line | |
66 in turn, without a trailing <EOL>, and the current | |
67 line number. The function should return a string or | |
68 None. If a string is returned, it becomes the text of | |
69 the line in the current turn. The default for [range] | |
70 is the whole file: "1,$". | |
71 {not in Vi} | |
72 | |
73 Examples: | |
74 > | |
75 :pydo return "%s\t%d" % (line[::-1], len(line)) | |
76 :pydo if line: return "%4d: %s" % (linenr, line) | |
77 < | |
7 | 78 *:pyfile* *:pyf* |
79 :[range]pyf[ile] {file} | |
80 Execute the Python script in {file}. The whole | |
81 argument is used as a single file name. {not in Vi} | |
82 | |
83 Both of these commands do essentially the same thing - they execute a piece of | |
84 Python code, with the "current range" |python-range| set to the given line | |
85 range. | |
86 | |
87 In the case of :python, the code to execute is in the command-line. | |
88 In the case of :pyfile, the code to execute is the contents of the given file. | |
89 | |
90 Python commands cannot be used in the |sandbox|. | |
91 | |
92 To pass arguments you need to set sys.argv[] explicitly. Example: > | |
93 | |
94 :python import sys | |
95 :python sys.argv = ["foo", "bar"] | |
96 :pyfile myscript.py | |
97 | |
98 Here are some examples *python-examples* > | |
99 | |
100 :python from vim import * | |
101 :python from string import upper | |
102 :python current.line = upper(current.line) | |
103 :python print "Hello" | |
104 :python str = current.buffer[42] | |
105 | |
106 (Note that changes - like the imports - persist from one command to the next, | |
107 just like in the Python interpreter.) | |
108 | |
109 ============================================================================== | |
110 2. The vim module *python-vim* | |
111 | |
112 Python code gets all of its access to vim (with one exception - see | |
236 | 113 |python-output| below) via the "vim" module. The vim module implements two |
7 | 114 methods, three constants, and one error object. You need to import the vim |
115 module before using it: > | |
116 :python import vim | |
117 | |
118 Overview > | |
20 | 119 :py print "Hello" # displays a message |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
120 :py vim.command(cmd) # execute an Ex command |
20 | 121 :py w = vim.windows[n] # gets window "n" |
122 :py cw = vim.current.window # gets the current window | |
123 :py b = vim.buffers[n] # gets buffer "n" | |
124 :py cb = vim.current.buffer # gets the current buffer | |
125 :py w.height = lines # sets the window height | |
126 :py w.cursor = (row, col) # sets the window cursor position | |
127 :py pos = w.cursor # gets a tuple (row, col) | |
128 :py name = b.name # gets the buffer file name | |
129 :py line = b[n] # gets a line from the buffer | |
130 :py lines = b[n:m] # gets a list of lines | |
131 :py num = len(b) # gets the number of lines | |
132 :py b[n] = str # sets a line in the buffer | |
133 :py b[n:m] = [str1, str2, str3] # sets a number of lines at once | |
134 :py del b[n] # deletes a line | |
135 :py del b[n:m] # deletes a number of lines | |
7 | 136 |
137 | |
138 Methods of the "vim" module | |
139 | |
140 vim.command(str) *python-command* | |
236 | 141 Executes the vim (ex-mode) command str. Returns None. |
7 | 142 Examples: > |
20 | 143 :py vim.command("set tw=72") |
144 :py vim.command("%s/aaa/bbb/g") | |
7 | 145 < The following definition executes Normal mode commands: > |
146 def normal(str): | |
147 vim.command("normal "+str) | |
148 # Note the use of single quotes to delimit a string containing | |
149 # double quotes | |
150 normal('"a2dd"aP') | |
151 < *E659* | |
152 The ":python" command cannot be used recursively with Python 2.2 and | |
153 older. This only works with Python 2.3 and later: > | |
20 | 154 :py vim.command("python print 'Hello again Python'") |
7 | 155 |
156 vim.eval(str) *python-eval* | |
157 Evaluates the expression str using the vim internal expression | |
633 | 158 evaluator (see |expression|). Returns the expression result as: |
159 - a string if the Vim expression evaluates to a string or number | |
160 - a list if the Vim expression evaluates to a Vim list | |
856 | 161 - a dictionary if the Vim expression evaluates to a Vim dictionary |
633 | 162 Dictionaries and lists are recursively expanded. |
7 | 163 Examples: > |
20 | 164 :py text_width = vim.eval("&tw") |
165 :py str = vim.eval("12+12") # NB result is a string! Use | |
7 | 166 # string.atoi() to convert to |
167 # a number. | |
168 | |
856 | 169 :py tagList = vim.eval('taglist("eval_expr")') |
633 | 170 < The latter will return a python list of python dicts, for instance: |
171 [{'cmd': '/^eval_expr(arg, nextcmd)$/', 'static': 0, 'name': | |
172 'eval_expr', 'kind': 'f', 'filename': './src/eval.c'}] | |
173 | |
3682 | 174 vim.bindeval(str) *python-bindeval* |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
175 Like |python-eval|, but returns special objects described in |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
176 |python-bindeval-objects|. These python objects let you modify (|List| |
4698
2db005052371
updated for version 7.3.1096
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
177 or |Dictionary|) or call (|Funcref|) vim objects. |
633 | 178 |
4700
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
179 vim.strwidth(str) *python-strwidth* |
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
180 Like |strwidth()|: returns number of display cells str occupies, tab |
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
181 is counted as one cell. |
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
182 |
7 | 183 Error object of the "vim" module |
184 | |
185 vim.error *python-error* | |
186 Upon encountering a Vim error, Python raises an exception of type | |
187 vim.error. | |
188 Example: > | |
189 try: | |
190 vim.command("put a") | |
191 except vim.error: | |
192 # nothing in register a | |
193 | |
194 Constants of the "vim" module | |
195 | |
196 Note that these are not actually constants - you could reassign them. | |
197 But this is silly, as you would then lose access to the vim objects | |
198 to which the variables referred. | |
199 | |
200 vim.buffers *python-buffers* | |
4393 | 201 A mapping object providing access to the list of vim buffers. The |
7 | 202 object supports the following operations: > |
20 | 203 :py b = vim.buffers[i] # Indexing (read-only) |
204 :py b in vim.buffers # Membership test | |
205 :py n = len(vim.buffers) # Number of elements | |
4397 | 206 :py for b in vim.buffers: # Iterating over buffer list |
7 | 207 < |
208 vim.windows *python-windows* | |
236 | 209 A sequence object providing access to the list of vim windows. The |
7 | 210 object supports the following operations: > |
20 | 211 :py w = vim.windows[i] # Indexing (read-only) |
212 :py w in vim.windows # Membership test | |
213 :py n = len(vim.windows) # Number of elements | |
214 :py for w in vim.windows: # Sequential access | |
4698
2db005052371
updated for version 7.3.1096
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
215 < Note: vim.windows object always accesses current tab page. |
4401 | 216 |python-tabpage|.windows objects are bound to parent |python-tabpage| |
217 object and always use windows from that tab page (or throw vim.error | |
218 in case tab page was deleted). You can keep a reference to both | |
219 without keeping a reference to vim module object or |python-tabpage|, | |
4589
fa39483a1363
updated for version 7.3.1042
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
220 they will not lose their properties in this case. |
4401 | 221 |
222 vim.tabpages *python-tabpages* | |
223 A sequence object providing access to the list of vim tab pages. The | |
224 object supports the following operations: > | |
225 :py t = vim.tabpages[i] # Indexing (read-only) | |
226 :py t in vim.tabpages # Membership test | |
227 :py n = len(vim.tabpages) # Number of elements | |
228 :py for t in vim.tabpages: # Sequential access | |
7 | 229 < |
230 vim.current *python-current* | |
231 An object providing access (via specific attributes) to various | |
232 "current" objects available in vim: | |
233 vim.current.line The current line (RW) String | |
4407 | 234 vim.current.buffer The current buffer (RW) Buffer |
235 vim.current.window The current window (RW) Window | |
236 vim.current.tabpage The current tab page (RW) TabPage | |
7 | 237 vim.current.range The current line range (RO) Range |
238 | |
236 | 239 The last case deserves a little explanation. When the :python or |
7 | 240 :pyfile command specifies a range, this range of lines becomes the |
236 | 241 "current range". A range is a bit like a buffer, but with all access |
242 restricted to a subset of lines. See |python-range| for more details. | |
7 | 243 |
4407 | 244 Note: When assigning to vim.current.{buffer,window,tabpage} it expects |
245 valid |python-buffer|, |python-window| or |python-tabpage| objects | |
246 respectively. Assigning triggers normal (with |autocommand|s) | |
247 switching to given buffer, window or tab page. It is the only way to | |
248 switch UI objects in python: you can't assign to | |
249 |python-tabpage|.window attribute. To switch without triggering | |
250 autocommands use > | |
251 py << EOF | |
252 saved_eventignore = vim.options['eventignore'] | |
253 vim.options['eventignore'] = 'all' | |
254 try: | |
255 vim.current.buffer = vim.buffers[2] # Switch to buffer 2 | |
256 finally: | |
257 vim.options['eventignore'] = saved_eventignore | |
258 EOF | |
259 < | |
4323 | 260 vim.vars *python-vars* |
261 vim.vvars *python-vvars* | |
262 Dictionary-like objects holding dictionaries with global (|g:|) and | |
263 vim (|v:|) variables respectively. Identical to `vim.bindeval("g:")`, | |
264 but faster. | |
7 | 265 |
4350 | 266 vim.options *python-options* |
267 Object partly supporting mapping protocol (supports setting and | |
268 getting items) providing a read-write access to global options. | |
269 Note: unlike |:set| this provides access only to global options. You | |
270 cannot use this object to obtain or set local options' values or | |
271 access local-only options in any fashion. Raises KeyError if no global | |
272 option with such name exists (i.e. does not raise KeyError for | |
273 |global-local| options and global only options, but does for window- | |
274 and buffer-local ones). Use |python-buffer| objects to access to | |
275 buffer-local options and |python-window| objects to access to | |
276 window-local options. | |
277 | |
4496 | 278 Type of this object is available via "Options" attribute of vim |
279 module. | |
280 | |
7 | 281 Output from Python *python-output* |
282 Vim displays all Python code output in the Vim message area. Normal | |
283 output appears as information messages, and error output appears as | |
284 error messages. | |
285 | |
286 In implementation terms, this means that all output to sys.stdout | |
287 (including the output from print statements) appears as information | |
288 messages, and all output to sys.stderr (including error tracebacks) | |
289 appears as error messages. | |
290 | |
291 *python-input* | |
292 Input (via sys.stdin, including input() and raw_input()) is not | |
236 | 293 supported, and may cause the program to crash. This should probably be |
7 | 294 fixed. |
295 | |
296 ============================================================================== | |
297 3. Buffer objects *python-buffer* | |
298 | |
236 | 299 Buffer objects represent vim buffers. You can obtain them in a number of ways: |
7 | 300 - via vim.current.buffer (|python-current|) |
301 - from indexing vim.buffers (|python-buffers|) | |
302 - from the "buffer" attribute of a window (|python-window|) | |
303 | |
3312 | 304 Buffer objects have two read-only attributes - name - the full file name for |
305 the buffer, and number - the buffer number. They also have three methods | |
306 (append, mark, and range; see below). | |
7 | 307 |
236 | 308 You can also treat buffer objects as sequence objects. In this context, they |
7 | 309 act as if they were lists (yes, they are mutable) of strings, with each |
236 | 310 element being a line of the buffer. All of the usual sequence operations, |
7 | 311 including indexing, index assignment, slicing and slice assignment, work as |
236 | 312 you would expect. Note that the result of indexing (slicing) a buffer is a |
313 string (list of strings). This has one unusual consequence - b[:] is different | |
314 from b. In particular, "b[:] = None" deletes the whole of the buffer, whereas | |
7 | 315 "b = None" merely updates the variable b, with no effect on the buffer. |
316 | |
236 | 317 Buffer indexes start at zero, as is normal in Python. This differs from vim |
318 line numbers, which start from 1. This is particularly relevant when dealing | |
7 | 319 with marks (see below) which use vim line numbers. |
320 | |
4350 | 321 The buffer object attributes are: |
322 b.vars Dictionary-like object used to access | |
323 |buffer-variable|s. | |
324 b.options Mapping object (supports item getting, setting and | |
325 deleting) that provides access to buffer-local options | |
326 and buffer-local values of |global-local| options. Use | |
327 |python-window|.options if option is window-local, | |
328 this object will raise KeyError. If option is | |
329 |global-local| and local value is missing getting it | |
330 will return None. | |
4589
fa39483a1363
updated for version 7.3.1042
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
331 b.name String, RW. Contains buffer name (full path). |
fa39483a1363
updated for version 7.3.1042
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
332 Note: when assigning to b.name |BufFilePre| and |
fa39483a1363
updated for version 7.3.1042
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
333 |BufFilePost| autocommands are launched. |
fa39483a1363
updated for version 7.3.1042
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
334 b.number Buffer number. Can be used as |python-buffers| key. |
fa39483a1363
updated for version 7.3.1042
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
335 Read-only. |
4700
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
336 b.valid True or False. Buffer object becames invalid when |
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
337 corresponding buffer is wiped out. |
4350 | 338 |
7 | 339 The buffer object methods are: |
340 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
|
341 b.append(str, nr) Idem, below line "nr" |
7 | 342 b.append(list) Append a list of lines to the buffer |
343 Note that the option of supplying a list of strings to | |
344 the append method differs from the equivalent method | |
345 for Python's built-in list objects. | |
2391
f1d95a986dfb
Document extra argument for Python append().
Bram Moolenaar <bram@vim.org>
parents:
2366
diff
changeset
|
346 b.append(list, nr) Idem, below line "nr" |
7 | 347 b.mark(name) Return a tuple (row,col) representing the position |
348 of the named mark (can also get the []"<> marks) | |
349 b.range(s,e) Return a range object (see |python-range|) which | |
350 represents the part of the given buffer between line | |
351 numbers s and e |inclusive|. | |
352 | |
20 | 353 Note that when adding a line it must not contain a line break character '\n'. |
354 A trailing '\n' is allowed and ignored, so that you can do: > | |
355 :py b.append(f.readlines()) | |
356 | |
4496 | 357 Buffer object type is available using "Buffer" attribute of vim module. |
358 | |
7 | 359 Examples (assume b is the current buffer) > |
20 | 360 :py print b.name # write the buffer file name |
361 :py b[0] = "hello!!!" # replace the top line | |
362 :py b[:] = None # delete the whole buffer | |
363 :py del b[:] # delete the whole buffer | |
364 :py b[0:0] = [ "a line" ] # add a line at the top | |
365 :py del b[2] # delete a line (the third) | |
366 :py b.append("bottom") # add a line at the bottom | |
367 :py n = len(b) # number of lines | |
368 :py (row,col) = b.mark('a') # named mark | |
369 :py r = b.range(1,5) # a sub-range of the buffer | |
4323 | 370 :py b.vars["foo"] = "bar" # assign b:foo variable |
4350 | 371 :py b.options["ff"] = "dos" # set fileformat |
372 :py del b.options["ar"] # same as :set autoread< | |
7 | 373 |
374 ============================================================================== | |
375 4. Range objects *python-range* | |
376 | |
236 | 377 Range objects represent a part of a vim buffer. You can obtain them in a |
7 | 378 number of ways: |
379 - via vim.current.range (|python-current|) | |
380 - from a buffer's range() method (|python-buffer|) | |
381 | |
236 | 382 A range object is almost identical in operation to a buffer object. However, |
7 | 383 all operations are restricted to the lines within the range (this line range |
384 can, of course, change as a result of slice assignments, line deletions, or | |
385 the range.append() method). | |
386 | |
387 The range object attributes are: | |
388 r.start Index of first line into the buffer | |
389 r.end Index of last line into the buffer | |
390 | |
391 The range object methods are: | |
392 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
|
393 r.append(str, nr) Idem, after line "nr" |
7 | 394 r.append(list) Append a list of lines to the range |
395 Note that the option of supplying a list of strings to | |
396 the append method differs from the equivalent method | |
397 for Python's built-in list objects. | |
2391
f1d95a986dfb
Document extra argument for Python append().
Bram Moolenaar <bram@vim.org>
parents:
2366
diff
changeset
|
398 r.append(list, nr) Idem, after line "nr" |
7 | 399 |
4496 | 400 Range object type is available using "Range" attribute of vim module. |
401 | |
7 | 402 Example (assume r is the current range): |
403 # Send all lines in a range to the default printer | |
404 vim.command("%d,%dhardcopy!" % (r.start+1,r.end+1)) | |
405 | |
406 ============================================================================== | |
407 5. Window objects *python-window* | |
408 | |
236 | 409 Window objects represent vim windows. You can obtain them in a number of ways: |
7 | 410 - via vim.current.window (|python-current|) |
411 - from indexing vim.windows (|python-windows|) | |
4401 | 412 - from indexing "windows" attribute of a tab page (|python-tabpage|) |
413 - from the "window" attribute of a tab page (|python-tabpage|) | |
7 | 414 |
236 | 415 You can manipulate window objects only through their attributes. They have no |
7 | 416 methods, and no sequence or other interface. |
417 | |
418 Window attributes are: | |
419 buffer (read-only) The buffer displayed in this window | |
420 cursor (read-write) The current cursor position in the window | |
421 This is a tuple, (row,col). | |
422 height (read-write) The window height, in rows | |
423 width (read-write) The window width, in columns | |
4323 | 424 vars (read-only) The window |w:| variables. Attribute is |
425 unassignable, but you can change window | |
426 variables this way | |
4350 | 427 options (read-only) The window-local options. Attribute is |
428 unassignable, but you can change window | |
429 options this way. Provides access only to | |
430 window-local options, for buffer-local use | |
431 |python-buffer| and for global ones use | |
432 |python-options|. If option is |global-local| | |
433 and local value is missing getting it will | |
434 return None. | |
4379 | 435 number (read-only) Window number. The first window has number 1. |
436 This is zero in case it cannot be determined | |
437 (e.g. when the window object belongs to other | |
438 tab page). | |
4431 | 439 row, col (read-only) On-screen window position in display cells. |
4383 | 440 First position is zero. |
4431 | 441 tabpage (read-only) Window tab page. |
4700
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
442 valid (read-write) True or False. Window object becames invalid |
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
443 when corresponding window is closed. |
4383 | 444 |
7 | 445 The height attribute is writable only if the screen is split horizontally. |
446 The width attribute is writable only if the screen is split vertically. | |
447 | |
4496 | 448 Window object type is available using "Window" attribute of vim module. |
449 | |
7 | 450 ============================================================================== |
4401 | 451 6. Tab page objects *python-tabpage* |
452 | |
453 Tab page objects represent vim tab pages. You can obtain them in a number of | |
454 ways: | |
455 - via vim.current.tabpage (|python-current|) | |
456 - from indexing vim.tabpages (|python-tabpages|) | |
457 | |
458 You can use this object to access tab page windows. They have no methods and | |
459 no sequence or other interfaces. | |
460 | |
461 Tab page attributes are: | |
462 number The tab page number like the one returned by | |
463 |tabpagenr()|. | |
464 windows Like |python-windows|, but for current tab page. | |
465 vars The tab page |t:| variables. | |
466 window Current tabpage window. | |
4700
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
467 valid True or False. Tab page object becames invalid when |
0c25fa1dfd97
updated for version 7.3.1097
Bram Moolenaar <bram@vim.org>
parents:
4698
diff
changeset
|
468 corresponding tab page is closed. |
4401 | 469 |
4496 | 470 TabPage object type is available using "TabPage" attribute of vim module. |
471 | |
4401 | 472 ============================================================================== |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
473 7. vim.bindeval objects *python-bindeval-objects* |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
474 |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
475 vim.Dictionary object *python-Dictionary* |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
476 Dictionary-like object providing access to vim |Dictionary| type. |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
477 Attributes: |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
478 Attribute Description ~ |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
479 locked One of *python-.locked* |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
480 Value Description ~ |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
481 zero Variable is not locked |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
482 vim.VAR_LOCKED Variable is locked, but can be unlocked |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
483 vim.VAR_FIXED Variable is locked and can't be unlocked |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
484 Read-write. You can unlock locked variable by assigning |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
485 `True` or `False` to this attribute. No recursive locking |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
486 is supported. |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
487 scope One of |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
488 Value Description ~ |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
489 zero Dictionary is not a scope one |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
490 vim.VAR_DEF_SCOPE |g:| or |l:| dictionary |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
491 vim.VAR_SCOPE Other scope dictionary, |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
492 see |internal-variables| |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
493 Methods (note: methods do not support keyword arguments): |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
494 Method Description ~ |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
495 keys() Returns a list with dictionary keys. |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
496 values() Returns a list with dictionary values. |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
497 items() Returns a list of 2-tuples with dictionary contents. |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
498 update(iterable), update(dictionary), update(**kwargs) |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
499 Adds keys to dictionary. |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
500 get(key[, default=None]) |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
501 Obtain key from dictionary, returning the default if it is |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
502 not present. |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
503 pop(key[, default]) |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
504 Remove specified key from dictionary and return |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
505 corresponding value. If key is not found and default is |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
506 given returns the default, otherwise raises KeyError. |
4698
2db005052371
updated for version 7.3.1096
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
507 popitem() |
2db005052371
updated for version 7.3.1096
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
508 Remove random key from dictionary and return (key, value) |
2db005052371
updated for version 7.3.1096
Bram Moolenaar <bram@vim.org>
parents:
4681
diff
changeset
|
509 pair. |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
510 has_key(key) |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
511 Check whether dictionary contains specified key, similar |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
512 to `key in dict`. |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
513 |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
514 __new__(), __new__(iterable), __new__(dictionary), __new__(update) |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
515 You can use `vim.Dictionary()` to create new vim |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
516 dictionaries. `d=vim.Dictionary(arg)` is the same as |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
517 `d=vim.bindeval('{}');d.update(arg)`. Without arguments |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
518 constructs empty dictionary. |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
519 |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
520 Examples: > |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
521 d = vim.Dictionary(food="bar") # Constructor |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
522 d['a'] = 'b' # Item assignment |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
523 print d['a'] # getting item |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
524 d.update({'c': 'd'}) # .update(dictionary) |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
525 d.update(e='f') # .update(**kwargs) |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
526 d.update((('g', 'h'), ('i', 'j'))) # .update(iterable) |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
527 for key in d.keys(): # .keys() |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
528 for val in d.values(): # .values() |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
529 for key, val in d.items(): # .items() |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
530 print isinstance(d, vim.Dictionary) # True |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
531 for key in d: # Iteration over keys |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
532 class Dict(vim.Dictionary): # Subclassing |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
533 < |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
534 Note: when iterating over keys you should not modify dictionary. |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
535 |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
536 vim.List object *python-List* |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
537 Sequence-like object providing access to vim |List| type. |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
538 Supports `.locked` attribute, see |python-.locked|. Also supports the |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
539 following methods: |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
540 Method Description ~ |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
541 extend(item) Add items to the list. |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
542 |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
543 __new__(), __new__(iterable) |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
544 You can use `vim.List()` to create new vim lists. |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
545 `l=vim.List(iterable)` is the same as |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
546 `l=vim.bindeval('[]');l.extend(iterable)`. Without |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
547 arguments constructs empty list. |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
548 Examples: > |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
549 l = vim.List("abc") # Constructor, result: ['a', 'b', 'c'] |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
550 l.extend(['abc', 'def']) # .extend() method |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
551 print l[1:] # slicing |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
552 l[:0] = ['ghi', 'jkl'] # slice assignment |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
553 print l[0] # getting item |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
554 l[0] = 'mno' # assignment |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
555 for i in l: # iteration |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
556 print isinstance(l, vim.List) # True |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
557 class List(vim.List): # Subclassing |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
558 |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
559 vim.Function object *python-Function* |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
560 Function-like object, acting like vim |Funcref| object. Supports `.name` |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
561 attribute and is callable. Accepts special keyword argument `self`, see |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
562 |Dictionary-function|. You can also use `vim.Function(name)` constructor, |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
563 it is the same as `vim.bindeval('function(%s)'%json.dumps(name))`. |
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
564 |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
565 Examples: > |
4639
52a4f66ae1f5
updated for version 7.3.1067
Bram Moolenaar <bram@vim.org>
parents:
4627
diff
changeset
|
566 f = vim.Function('tr') # Constructor |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
567 print f('abc', 'a', 'b') # Calls tr('abc', 'a', 'b') |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
568 vim.command(''' |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
569 function DictFun() dict |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
570 return self |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
571 endfunction |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
572 ''') |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
573 f = vim.bindeval('function("DictFun")') |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
574 print f(self={}) # Like call('DictFun', [], {}) |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
575 print isinstance(f, vim.Function) # True |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
576 |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
577 ============================================================================== |
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
578 8. pyeval() and py3eval() Vim functions *python-pyeval* |
3682 | 579 |
580 To facilitate bi-directional interface, you can use |pyeval()| and |py3eval()| | |
581 functions to evaluate Python expressions and pass their values to VimL. | |
582 | |
583 ============================================================================== | |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
584 9. Dynamic loading *python-dynamic* |
557 | 585 |
586 On MS-Windows the Python library can be loaded dynamically. The |:version| | |
587 output then includes |+python/dyn|. | |
588 | |
589 This means that Vim will search for the Python DLL file only when needed. | |
590 When you don't use the Python interface you don't need it, thus you can use | |
591 Vim without this DLL file. | |
592 | |
593 To use the Python interface the Python DLL must be in your search path. In a | |
594 console window type "path" to see what directories are used. | |
595 | |
596 The name of the DLL must match the Python version Vim was compiled with. | |
597 Currently the name is "python24.dll". That is for Python 2.4. To know for | |
598 sure edit "gvim.exe" and search for "python\d*.dll\c". | |
599 | |
600 ============================================================================== | |
4627
18ba89e06fab
updated for version 7.3.1061
Bram Moolenaar <bram@vim.org>
parents:
4589
diff
changeset
|
601 10. Python 3 *python3* |
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
602 |
2560
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
603 *:py3* *:python3* |
4435 | 604 The `:py3` and `:python3` commands work similar to `:python`. A simple check |
4098 | 605 if the `:py3` command is working: > |
3750 | 606 :py3 print("Hello") |
607 < *:py3file* | |
4435 | 608 The `:py3file` command works similar to `:pyfile`. |
4431 | 609 *:py3do* *E863* |
4435 | 610 The `:py3do` command works similar to `:pydo`. |
4417 | 611 |
3682 | 612 |
2409
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2391
diff
changeset
|
613 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
|
614 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
|
615 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
|
616 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
|
617 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
|
618 |
2560
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
619 Some more details on the special case 4: |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
620 |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
621 When Python 2 and Python 3 are both supported they must be loaded dynamically. |
2540 | 622 |
2560
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
623 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
|
624 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
|
625 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
|
626 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
|
627 symbols to be provided by Vim. |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
628 *E836* *E837* |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
629 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
|
630 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
|
631 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
|
632 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
|
633 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
|
634 |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
635 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
|
636 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
|
637 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
|
638 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
|
639 libPython. |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
640 |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
641 To work around such problems there are these options: |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
642 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
|
643 libpython.so. |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
644 2. Vim is recompiled for only one Python version. |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
645 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
|
646 may crash Vim though. |
84ba6293f9d7
Preparations for 7.3f release.
Bram Moolenaar <bram@vim.org>
parents:
2554
diff
changeset
|
647 |
2826 | 648 *has-python* |
649 You can test what Python version is available with: > | |
650 if has('python') | |
3082 | 651 echo 'there is Python 2.x' |
2826 | 652 elseif has('python3') |
653 echo 'there is Python 3.x' | |
654 endif | |
655 | |
656 Note however, that when Python 2 and 3 are both available and loaded | |
657 dynamically, these has() calls will try to load them. If only one can be | |
658 loaded at a time, just checking if Python 2 or 3 are available will prevent | |
659 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
|
660 |
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
661 ============================================================================== |
7 | 662 vim:tw=78:ts=8:ft=help:norl: |