Skip to main content

Some scripts to help manipulate Coq developments and minimize error-producing Coq code

Project description

Build Status PyPI version

coq-tools

Some scripts to help manipulate Coq developments

coq-bug-minimizer

Some scripts to help construct small reproducing examples of bugs.

The script find-bug.py is the main program; run find-bug.py -h to see the options. The script will ask you two questions: whether or not it successfully determined the error you're seeking to reproduce, and whether or not it created a regular expression which captures that error. After that, it will run without user input until it finishes.

Usage

Standard usage is to invoke with the buggy file name and the output (minimized) file name:

python find-bug.py BUGGY_FILE.v OUTPUT_FILE.v

You can add -v for a more verbose output.

If you are using a non-system version of Coq, you can pass --coqtop /path/to/coqtop and --coqc /path/to/coqc. If you pass -R . Foo to, say, coq_makefile, you can inform find-bug.py of this fact using -R . Foo.

Examples

There is an example in the examples directory. You can run run-example-01.sh to see how the program works. You can pass this script the arguments -v, -vv, or -vvv for different levels of verbosity. Look at the contents of run-example-01.sh to see how to invoke the program.

Known Bugs

Note that this program can fail in mysterious ways when run using Windows Python 2.7 under cygwin; it seems that buffering and stdin and stderr and Popen are screwed up. To work around this, there is a coqtop.bat file which is chosen as the default coqtop program. Somehow running via a .bat file makes things work. You will probably have to use a similar wrapper if you use a custom coqtop executable.

Additionally, quirks in module name resolution can result in inlining failures (see https://github.com/JasonGross/coq-tools/issues/16), and global side effects of Require can also result in failures (see https://github.com/JasonGross/coq-tools/issues/41).

Publications

minimize-requires

The script minimize-requires.py can be used to remove unneeded Require statements. Run minimize-requires.py -h to see the options.

Usage

Standard usage is to run

minimize-requires.py some-file1.v some-file2.v ... --in-place .bak

or, if you want to minimize an entire project,

minimize-requires.py --all -f _CoqProject

(you can add --in-place .bak if you want to save backup files)

proof-using-helper

The script proof-using-helper.py is the main program; run proof-using-helper.py -h to see the options.

Usage

Standard usage is to invoke with the any -R arguments passed to Coq, and either pipe the output of make quick with Global Set Suggest Proof Using on, to this script, or to give it a file containing said output.

make quick -j -k | tee -a proof_using.log
python /path/to/proof-using-helper.py proof_using.log

You can add -v for a more verbose output.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coq-tools-0.0.4.tar.gz (95.5 kB view details)

Uploaded Source

Built Distribution

coq_tools-0.0.4-py3-none-any.whl (107.7 kB view details)

Uploaded Python 3

File details

Details for the file coq-tools-0.0.4.tar.gz.

File metadata

  • Download URL: coq-tools-0.0.4.tar.gz
  • Upload date:
  • Size: 95.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for coq-tools-0.0.4.tar.gz
Algorithm Hash digest
SHA256 7d982f1d6deccc46d5f61d1adf123679162f0f24aae2e7a33fdceb36ac6747db
MD5 f4987f01e8d1dbd020de445c9862d49a
BLAKE2b-256 78262797871232e8a47800253537109a19933759cc45bacaa43a0de8f5e16af2

See more details on using hashes here.

File details

Details for the file coq_tools-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: coq_tools-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 107.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for coq_tools-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 97425670e446ea6f1a6c270eeedc72124308776a2fdd07bb080a09e65a729602
MD5 1bb415c78aa5d2df1022767a6e0f3d2e
BLAKE2b-256 7635af5cc71116789d2fa63269bb7dbf190cf1e51788c028499552a7fc7bec4e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page