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