Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sr-lab/coqpyt
Python client for coq-lsp
https://github.com/sr-lab/coqpyt
coq language-server-protocol lsp-client
Last synced: 3 months ago
JSON representation
Python client for coq-lsp
- Host: GitHub
- URL: https://github.com/sr-lab/coqpyt
- Owner: sr-lab
- License: mit
- Created: 2023-05-17T20:34:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-20T09:46:44.000Z (4 months ago)
- Last Synced: 2024-09-30T20:44:07.329Z (4 months ago)
- Topics: coq, language-server-protocol, lsp-client
- Language: Python
- Homepage:
- Size: 637 KB
- Stars: 23
- Watchers: 2
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Interact with Coq files and navigate through your proofs using our Python client for [coq-lsp](https://github.com/ejgallego/coq-lsp).
Execute Coq files, retrieve the generated context and edit proofs through insertion and removal of steps.
## Installation
[coq-lsp](https://github.com/ejgallego/coq-lsp) must be installed on version >= 0.1.7. Follow the installation instructions provided [here](https://github.com/ejgallego/coq-lsp#%EF%B8%8F-installation).
```bash
pip install -r requirements.txt
```
```bash
python -m pip install -e .
```
## Usage
Import classes from the ``coqpyt`` package.
```py
from coqpyt.coq.structs import TermType
from coqpyt.coq.base_file import CoqFile
from coqpyt.coq.proof_file import ProofFile
from coqpyt.coq.changes import ProofAppend, ProofPop
from coqpyt.coq.exceptions import InvalidChangeException
```
### Interaction with Coq
Create a CoqFile object, execute the file and extract the generated context.
```py
# Open Coq file
with CoqFile(os.path.join(os.getcwd(), "examples/readme.v")) as coq_file:
coq_file.exec(nsteps=2)
# Get all terms defined until now
print("Number of terms:", len(coq_file.context.terms))
# Filter by Tactics
print(
"Number of tactics:",
len(
list(
filter(
lambda term: term.type == TermType.TACTIC,
coq_file.context.terms.values(),
)
)
),
)
# Save compiled file
coq_file.save_vo()
print("Compiled file exists:", os.path.exists("examples/readme.vo"))
os.remove("examples/readme.vo")
# Run remaining file
coq_file.run()
print("Checked:", coq_file.checked)
# Get all terms defined until now
print("Number of terms:", len(coq_file.context.terms))
```
Create a ProofFile object (a CoqFile instance) and interact with the proofs.
```py
# Open Proof file
with ProofFile(os.path.join(os.getcwd(), "examples/readme.v")) as proof_file:
# Enter proof
proof_file.exec(nsteps=4)
print("In proof:", proof_file.in_proof)
# Get current goals
print(proof_file.current_goals)
# Run remaining file
proof_file.run()
# Number of proofs in the file
print("Number of proofs:", len(proof_file.proofs))
print("Proof:", proof_file.proofs[0].text)
# Print steps of proof
for step in proof_file.proofs[0].steps:
print(step.text, end="")
print()
# Get the context used in the third step
print(proof_file.proofs[0].steps[2].context)
# Print the goals in the third step
print(proof_file.proofs[0].steps[2].goals)
# Print number of terms in context
print("Number of terms:", len(proof_file.context.terms))
# Filter for Notations only
print(
"Number of notations:",
len(
list(
filter(
lambda term: term.type == TermType.NOTATION,
proof_file.context.terms.values(),
)
)
),
)
```
### Proof Modification
Given an admitted proof:
```coq
Lemma rev_append: forall {a} (l1 l2: list a),
rev (l1 ++ l2) = rev l2 ++ rev l1.
Proof.
intros a l1 l2. induction l1; intros.
- simpl. rewrite app_nil_r. reflexivity.
- simpl. rewrite IHl1.
Admitted.
```
Perform step-wise changes to the proof.
```py
with ProofFile(os.path.join(os.getcwd(), "examples/readme.v")) as proof_file:
proof_file.run()
# Get the first admitted proof
unproven = proof_file.unproven_proofs[0]
# Steps for an incorrect proof
incorrect = [" reflexivity.", "\nQed."]
# Steps for a correct proof
correct = [" rewrite app_assoc."] + incorrect
# Loop through both attempts
for attempt in [incorrect, correct]:
# Remove the "\nAdmitted." step
proof_file.pop_step(unproven)
try:
# Append all steps in the attempt
for i, s in enumerate(attempt):
proof_file.append_step(unproven, s)
print("Proof succeeded!")
break
except InvalidChangeException:
# Some step was invalid, so we rollback the previous changes
[proof_file.pop_step(unproven) for _ in range(i)]
proof_file.append_step(unproven, "\nAdmitted.")
print("Proof attempt not valid.")
```
Perform changes to the proof transactionally.
```py
with ProofFile(os.path.join(os.getcwd(), "examples/readme.v")) as proof_file:
proof_file.run()
# Get the first admitted proof
unproven = proof_file.unproven_proofs[0]
# Steps for an incorrect proof
incorrect = [" reflexivity.", "\nQed."]
# Steps for a correct proof
correct = [" rewrite app_assoc."] + incorrect
# Loop through both attempts
for attempt in [incorrect, correct]:
# Schedule the removal of the "\nAdmitted." step
changes = [ProofPop()]
# Schedule the addition of each step in the attempt
for s in attempt:
changes.append(ProofAppend(s))
try:
# Apply all changes in one batch
proof_file.change_proof(unproven, changes)
print("Proof succeeded!")
break
except InvalidChangeException:
# Some batch of changes was invalid
# Rollback is automatic, so no rollback needed
print("Proof attempt not valid.")
```
## Tests
To run the tests for CoqPyt go to the folder ``coqpyt`` and run:
```bash
pytest tests -s
```
## Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Credits
Special thanks to the developers of the [pylspclient](https://github.com/yeger00/pylspclient) project, which served as the initial template for CoqPyt. Additionally, we express our gratitude to [Kyle Thompson](https://github.com/rkthomps/) for his precious feedback, which has greatly contributed to the refinement of CoqPyt.
## License
[MIT](https://choosealicense.com/licenses/mit/)