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