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