https://github.com/flying-sheep/fine-coverage

https://github.com/flying-sheep/fine-coverage

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/flying-sheep/fine-coverage
• Owner: flying-sheep
• License: gpl-3.0
• Created: 2022-12-09T19:14:02.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T06:43:49.000Z (2 months ago)
• Last Synced: 2024-10-23T09:40:02.658Z (2 months ago)
• Language: Python
• Size: 157 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
fine-coverage

=============

..

    TODO: add to PyPI?

    |PyPI Version| |PyPI Python Version|

A simple experiment to trace coverage at a granularity finer than lines,

using Python 3.11’s new debug ranges information (`PEP 657`_).

Table of Contents

-----------------

- Usage_

- Installation_

- License_

Usage

-----

After installation, use ``fine-coverage`` or ``python -m fine_coverage``.

It accepts the ``--cov`` CLI option telling it what Python module to track coverage for,

as well as a module name to run and its options:

.. code:: console

   fine-coverage --cov=mypackage pytest -v

In the above example, it will report which code in `mypackage` got executed

while running the equivalent of `python -m pytest -v`.

Below you see an excerpt from the output when run on its own code.

So far only tracks `and`, `or`, and `if else` expressions.

.. image:: ./screenshot.png

   :alt: Screenshot

Installation

------------

.. code:: console

   rm -rf dist

   python -m build

   pip install dist/*.whl

License

-------

``fine-coverage`` is distributed under the terms of the GPL_ license.

.. |PyPI Version| image:: https://img.shields.io/pypi/v/fine-coverage.svg

   :target: https://pypi.org/project/fine-coverage

.. |PyPI Python Version| image:: https://img.shields.io/pypi/pyversions/fine-coverage.svg

   :target: https://pypi.org/project/fine-coverage

.. _PEP 657: https://peps.python.org/pep-0657/

.. _GPL: https://spdx.org/licenses/GPL.html