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