Skip to main content

vigil... as a python package

Project description

https://github.com/munificent/vigil but as a python package

To quote the above, “Vigil is truly vigilant about not allowing code that fails to pass programmatic specifications.”

Implore

Functions can state the oaths they promise to uphold via vigil.implore:

import math
import vigil

# The 0th argument to sqrt must always be greater than or equal to zero.
@vigil.implore(">=", 0, 0)
def sqrt(x):
    return math.sqrt(x)

If a caller fails to meet the requirement, a VigilError will be thrown and the caller will be punished as defined in the vigil.conf.

Swear

Functions can state the oaths they promise to uphold via vigil.swear:

import math
import vigil

# The output must be greater than 0
@vigil.swear(">=", 0)
def sqr(x):
    return x*x

If a function fails to meet its oath, a VigilError will be thrown and the function will be punished as defined in the vigil.conf.

Punishment

The punishment for misbehaving functions is defined in a vigil.conf. vigil.conf can either say deleteFunctions = False or deleteFunctions = True.

FAQ

Is this serious?

Eternal moral vigilance is no laughing matter.

But isn’t a language that deletes code crazy?

No, wanting to keep code that demonstrably has bugs according to its own specifications is crazy. What good could it possibly serve? It is corrupted and must be cleansed from your codebase.

Vigil will do this for you automatically.

Vigil deleted a function. Won’t that cause the functions that call it to fail?

It would seem that those functions appear to be corrupted as well. Run Vigil again and it will take care of that for you. Several invocations may be required to fully excise all bugs from your code.

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

vigil-1.0.tar.gz (15.0 kB view hashes)

Uploaded Source

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