A system for anchoring metadata in external files to source code
A system for anchoring metadata in external files to source code.
spor lets you define metadata for elements of your source code. The metadata is kept in a separate file from your source code, meaning that you don’t need to clutter your source file with extra information encoded into comments. To accomplish this while dealing with the fact that source code changes over time, spor uses various “anchoring” techniques to keep the metadata in sync with the source code (or let you know when they become unmanageably out of sync).
My main motivation for this tool comes from my work on the mutation testing tool Cosmic Ray. CR users need to be able to specify sections of their source code which should not be mutated, or which should only be mutated in specific ways. Rather than having them embed these processing directives in the source code, I thought it would be cleaner and neater to let them do so with a separate metadata file.
spor needs support for the following functionality:
- Add/edit/delete metadata to a specific range of text in a source file
- Query existing metadata
- Automatically update metadata when possible, or report errors when not
- Provide facilities facilities for “updating” metadata with new anchoring data
The design needs to be sensitive to both human users (i.e. since they may need to manually work with the metadata from time to time) as well as programmatic users. I’m sure the design will evolve as we go, so I’m going to try to keep it simple and explicit at first.
Ideally spor will work on any programming language (and, really, any text document), though its initial target will be Python source code.
To run the tests, first install the test dependencies and then use tox:
pip install -e .[test] tox
The field of “anchoring” is not new, and there’s some existing work we need to pay attention to:
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size spor-1.0.0-py2.py3-none-any.whl (14.0 kB)||File type Wheel||Python version 3.6||Upload date||Hashes View hashes|