References¶

This page provides a quick navigation by the documentation in case if you’re looking for something specific.

Decorators¶

decorator	reference	documentation
`@deal.chain`	`deal.chain`	More on writing contracts / deal.chain
`@deal.dispatch`	`deal.dispatch`	Dispatch
`@deal.ensure`	`deal.ensure`	Values / deal.ensure
`@deal.example`	`deal.example`	Documentation / deal.example
`@deal.has`	`deal.has`	Side-effects
`@deal.inherit`	`deal.inherit`	More on writing contracts / deal.inherit
`@deal.inv`	`deal.inv`	Values / deal.inv
`@deal.post`	`deal.post`	Values / deal.post
`@deal.pre`	`deal.pre`	Values / deal.pre
`@deal.pure`	`deal.pure`	–
`@deal.raises`	`deal.raises`	Exceptions / deal.raises
`@deal.reason`	`deal.reason`	Exceptions / deal.reason
`@deal.safe`	`deal.safe`	Exceptions / deal.safe

decorator	reference	documentation
`deal.activate`	`deal.activate`	Contracts for modules
`deal.autodoc`	`deal.autodoc`	Documentation / Sphinx autodoc
`deal.cases`	`deal.cases`	Tests
`deal.catch`	`deal.catch`	Documentation / deal.example
`deal.disable`	`deal.disable`	Runtime / Contracts on production
`deal.enable`	`deal.enable`	Runtime / Contracts on production
`deal.implies`	`deal.implies`	–
`deal.module_load`	`deal.module_load`	Contracts for modules
`deal.reset`	`deal.reset`	Runtime / Contracts on production

command	reference	documentation
`decorate`	decorate	More on writing contracts / Generating contracts
`lint`	lint	Linter / Built-in CLI command
`memtest`	memtest	More on testing / Finding memory leaks
`prove`	prove	Formal verification
`stub`	stub	Stubs
`test`	test	Tests / CLI

tool	github	integration docs
atheris	google/atheris	More on testing / Fuzzing
flake8	PyCQA/flake8	Linter / flake8
hypothesis	HypothesisWorks/hypothesis	More on testing / Custom strategies
mypy	python/mypy	More on writing contracts / Typing
pytest	pytest-dev/pytest	Tests
sphinx	sphinx-doc/sphinx	Documentation / Sphinx autodoc