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