如何获取当前正在执行的vim脚本的路径

Question

在我的vim插件中，我有两个文件：

myplugin/plugin.vim
myplugin/plugin_helpers.py

我想从plugin.vim导入plugin_helpers（使用vim python支持），所以我相信我首先需要将我的插件的目录放在python的sys.path上。

我如何（在 vimscript 中）获取当前正在执行的脚本的路径？在Python中，这是__file__。在 ruby​​ 中，它是 __FILE__。我通过谷歌搜索找不到类似 vim 的东西，可以吗？

注意：我不是在寻找当前编辑的文件（“%:p”和朋友）。

Answer 1

" Relative path of script file:
let s:path = expand('<sfile>')

" Absolute path of script file:
let s:path = expand('<sfile>:p')

" Absolute path of script file with symbolic links resolved:
let s:path = resolve(expand('<sfile>:p'))

" Folder in which script resides: (not safe for symlinks)
let s:path = expand('<sfile>:p:h')

" If you're using a symlink to your script, but your resources are in
" the same directory as the actual script, you'll need to do this:
"   1: Get the absolute path of the script
"   2: Resolve all symbolic links
"   3: Get the folder of the resolved absolute file
let s:path = fnamemodify(resolve(expand('<sfile>:p')), ':h')

我经常使用最后一个，因为我的 ~/.vimrc 是 git 存储库中脚本的符号链接。

Answer 2

找到了：

let s:current_file=expand("<sfile>")

Answer 3

值得一提的是，上述解决方案只能在函数之外工作。

这不会给出预期的结果：

function! MyFunction()
let s:current_file=expand('<sfile>:p:h')
echom s:current_file
endfunction

但这会：

let s:current_file=expand('<sfile>')
function! MyFunction()
echom s:current_file
endfunction

这是OP原始问题的完整解决方案：

let s:path = expand('<sfile>:p:h')

function! MyPythonFunction()
import sys
import os
script_path = vim.eval('s:path')

lib_path = os.path.join(script_path, '.') 
sys.path.insert(0, lib_path)                                       

import vim
import plugin_helpers
plugin_helpers.do_some_cool_stuff_here()
vim.command("badd %(result)s" % {'result':plugin_helpers.get_result()})

EOF
endfunction

Answer 4

如果您确实想获取函数内的脚本路径（这就是我想要的），您仍然可以使用 的第二个语义，或其等效的 < expand() 内的;stack>。

 ; ...
              执行遗留函数时，被替换为调用
              堆栈，与  一样
              ...
                                                   :<堆栈> <堆栈>
   <堆栈>替换为调用堆栈，使用
              函数行的“function {function-name}[{lnum}]”
              和“script {file-name}[{lnum}]”作为脚本行，以及
              项目之间用“..”表示。例如：
              “函数{函数名1}[{lnum}]..{函数名2}[{lnum}]”
              如果没有调用堆栈，您会收到错误 E489 。

但是，您可能不想在插件中使用它，因为您可以使用此 relative#path#to#plugin#root#script 表示法在插件中使用自动加载函数。

我将其用于采购目的：

function! s:SourceLocal(script)
  let l:callstack = expand("<stack>")
  let l:list = split(l:callstack, '\.\.')
  " list[-1] is SourceLocal function itself
  " list[-2] is the calling script
  let l:script_name = matchstr(l:list[-2], '^\(script \)\=\zs.\+\ze\[\d\+\]
然后您可以在任何脚本内 SourceLocal 来获取与其相关的另一个脚本。
)
  let l:script_path = fnamemodify(l:script_name, ":p:h")
  " l:script_path is the path where the script calling this function resides
  execute printf("source %s/%s", l:script_path, a:script)
endfunction

command! -nargs=1 SourceLocal :call s:SourceLocal(<f-args>)

然后您可以在任何脚本内 SourceLocal 来获取与其相关的另一个脚本。