How to get path to the current vimscript being executed

Question

In my vim plugin, I have two files:

myplugin/plugin.vim
myplugin/plugin_helpers.py

I would like to import plugin_helpers from plugin.vim (using the vim python support), so I believe I first need to put the directory of my plugin on python's sys.path.

How can I (in vimscript) get the path to the currently executing script? In python, this is __file__. In ruby, it's __FILE__. I couldn't find anything similar for vim by googling, can it be done?

Note: I am not looking for the currently edited file ("%:p" and friends).

Source with path relative to the current script: `execute 'source ' . expand(':p:h') . '/another.vim'` — Ciro Santilli Путлер Капут 六四事, Jun 25 '15 at 08:44

score 106 · Accepted Answer · answered Sep 11 '13 at 06:55

" 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')

I use that last one often because my ~/.vimrc is a symbolic link to a script in a git repository.

Thanks! The question was already long answered, but I'll take this one now since the extra info is likely to be useful. — gfxmonk, Sep 12 '13 at 10:53

score 37 · Answer 2 · answered Feb 12 '11 at 07:50

37

Found it:

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

answered Feb 12 '11 at 07:50

gfxmonk

8,332
4
38
53

20

Incase it helps anyone else. Make sure to do this at the top level scope. If you try to run it inside of a function you'll end up getting the function name rather than the path to the file containing the function. – Mat Schaffer Feb 12 '12 at 21:54
4

I'm amazed how hard it was to find this information on the internet, thanks a bunch! – Jesse the Game Jan 15 '13 at 06:53
3

`:p` for an absolute path. `:p:h` for the directory in which the script resides. – Zenexer May 10 '13 at 12:56
3

Another note: You might want to enclose this in `resolve()`, as `` could be a symbolic link. – Zenexer Jun 11 '13 at 03:38

edthedev · Answer 3 · 2014-01-24T16:55:38.717

It is worth mentioning that the above solution will only work outside of a function.

This will not give the desired result:

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

But this will:

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

Here's a full solution to OP's original question:

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

Thanks! After reading a few 'sources', this finally gave me enough insight to get it right. I used it in ruby, and use `load` rather than `require` to reload the script every time, which makes it much easier when making changes to the lib. — Emile Vrijdags, Jul 30 '17 at 10:44

How to get path to the current vimscript being executed

3 Answers3

Linked