Install the following packages from PyPI:
machineout
plugin formats the nose
output so that Vim can parse it more easily;To run the unit tests for this project, you also need mock
:
vim
object in our test cases.Clone the git repository:
git clone git://github.com/nvie/vim-pyunit.git cd vim-pyunit
Copy the file ftplugin/python_pyunit.vim
to your ~/.vim/ftplugin
directory
test_<filename>.py
)<F8>
to run nosetests
on itIt shows the errors inside a quickfix window, which will allow your to quickly jump to the error locations by simply pressing [Enter]
.
vim-pyunit
assumes that you have a single test file for each Python source file. The settings PyUnitTestPrefix
, PyUnitSourceRoot
, PyUnitTestsRoot
, and PyUnitTestsStructure
determine how the plugin finds which test files belong to which source files.
The PyUnitTestsStructure
setting is the most important one, because it determines where the PyUnit plugin searches for source and test files. There are three options:
foo/bar.py
is called tests/test_foo_bar.py
.test_
. For example, the test file for the source file foo/bar.py
is called foo/test_bar.py
. Use this setting when testing Django apps.PyUnitTestsRoot
), but keep the same directory hierarchy as used in the source directory. For example, the test file for the source file foo/bar.py
is called tests/test_foo/test_bar.py
.PyUnitTestsRoot
), but keep the same directory hierarchy as used in the source directory. As opposed to the follow-hierarchy
layout, the intermediate directories are not prefixed with test_
, only the last (file part) component is. For example, the test file for the source file foo/bar.py
is called tests/foo/test_bar.py
.By default, the vim-pyunit
plugin defines the following keyboard mappings:
nosetests
for the current file. This mapping can be used on both the source file, and on its corresponding test file. Calls PyUnitRunTests()
Shift+F8 Run nosetests
for all test files in the project, this is equivalent to running nosetests
in the root of your project. Calls PyUnitRunAllTests()
F9 Switch between the source and the corresponding test file. If the source or test file is not yet open, it is opened. The setting tests_split_window
is used to determine where the file needs to be opened screen-wise. Calls PyUnitSwitchToCounterpart()
The plugin autodetects whether you have remapped the functions to custom keyboard mappings. If so, if does not register the default mappings. So to pick your own shortcut key mappings, simply add lines like this to your .vimrc
:
noremap ,t :call PyUnitRunTests()<CR> noremap! ,t <Esc>:call PyUnitRunTests()<CR>
(Which would map the test runner to comma-T. <F8>
then remains what it was.)
If you wish to disable any automatic keyboard mapping, simply set:
let no_pyunit_maps = 1
The plugin supports setting of the following variables:
Variable Description Values DefaultPyUnitShowTests
Shows the tests. 0 or 1 1 PyUnitCmd
The command to run the unit test. any string "nosetests -q --with-machineout" ProjRootIndicators
List of filenames indicating the project root. list of file names [".git", "setup.py", "setup.cfg"] ProjRootStopAtHomeDir
Stop the search for the project root at the user's home dir. 0 or 1 1 PyUnitTestPrefix
The filename prefix to use for test files. any string "test_" PyUnitTestSuffix
Not implemented yet 0 or 1 n/a PyUnitSourceRoot
The relative location where all source files live. directory spec, or empty "" PyUnitTestsRoot
The relative location where all tests live. directory spec "tests" PyUnitTestsStructure
Specifies how you wish to organise your tests. flat, follow-hierarchy, side-by-side "follow-hierarchy" PyUnitTestsSplitWindow
Specifies where test files should be opened, when oopened next to the source file. When set to no
, doesn't open a new window at all, but reuses the current buffer. left, right, top, bottom, no "right" PyUnitConfirmTestCreation
Ask to confirm creation of new test files. 0 or 1 1
This plugin goes well together with the following plugin:
<F7>
)RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4