emacs support for highighting python coverage results
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cov2emacs
Cask
LICENSE
README.md
pycoverage.el
screenie.png

README.md

pycoverage.el

An emacs minor mode for reporting inline on coverage stats for Python

Screenshot

Dependencies

  • python-coverage>=4.0

Installation

Put something like this in your .emacs

(require 'linum)
(require 'pycoverage)

(defun my-coverage ()
  (interactive)
  (when (derived-mode-p 'python-mode)
    (progn
      (linum-mode)
      (pycoverage-mode))))

I like to create a per project virtualenv. Use pip to install cov2emacs in that virtualenv.

$ source path/to/env/bin/activate
(env) $ cd pycoverage.el/cov2emacs
(env) $ pip install .

Use pyvenv mode to activate your virtualenv and you should be good to go.

Running

Enable the mode by running:

M-x pycoverage-mode

There should be .coverage file in the directory of the module you want coverage reporting on (or the parents of that directory). Note that if your file has been modified later than the .coverage file, it will be considered as stale and ignore it.

Red highlights mean that lines were missed (Coverage percent for file is in mode line).

The mode-line should have one of the following updates:

  • pycov(...) - Tool is running
  • pycov:NUM% - Percentage covered. Should see red in fringe where coverage is missing
  • pycov(OLD) - .coverage file is older than current buffer. See refreshing results below
  • pycov(Err:no .coverage file) - There is no .coverage file. See refreshing results below

Refreshing Results

After you change buffer and save it, the coverage results are invalidated.

Re-gen the .coverage file (ie by running tests with coverage turned on.) Run pycoverage-refresh to update coverage results.

Hint

There is a .cov2emacs log file that should give hints as to what is going on

License

Copyright (c) 2017 Matt Harrison

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.