Skip to main content

A silent alternative to debugging

Project description

`hushbugger` is an alternative to a debugger. Instead of helping you find bugs and remove them, it will do its best to make bugs invisible.

# Example

Imagine you have the following code (as featured in the [Hypothesis docs](https://hypothesis.readthedocs.io/en/latest/quickstart.html)):

```py
def encode(input_string):
count = 1
prev = ''
lst = []
for character in input_string:
if character != prev:
if prev:
entry = (prev, count)
lst.append(entry)
count = 1
prev = character
else:
count += 1
else:
entry = (character, count)
lst.append(entry)
return lst
```

It has a fatal flaw: it crashes if you give it an empty string:

```
>>> encode('')
Traceback (most recent call last):
...
UnboundLocalError: local variable 'character' referenced before assignment
```

To hide the bug, simply apply the `hush` decorator:

```py
from hushbugger import hush

@hush
def encode(input_string):
count = 1
prev = ''
lst = []
for character in input_string:
if character != prev:
if prev:
entry = (prev, count)
lst.append(entry)
count = 1
prev = character
else:
count += 1
else:
entry = (character, count)
lst.append(entry)
return lst
```

Now it works!

```
>>> encode('')
[]
```

# How it works

If the function raises an exception, its bytecode is disassembled and inspected to look for return statements. If a constant value is returned (e.g. `return True`), that value is used. If a variable is returned (e.g. `return x`), and that variable had a value at the time of the exception, that value is used.

If no usable return statements are found, a `Dummy` object is returned. It responds to almost any operation you throw at it (calling it, adding it, iterating over it, etcetera), so hopefully it gets discarded before visibly breaking anything. Its `repr` is also disguised, as if it belonged to a random module.

```py
@hush
def double(x):
return 2 * x
```

```
>>> double([1, 2, 3])
[1, 2, 3, 1, 2, 3]
>>> ret = double({})
>>> ret
<errno.Coalescer object at 0x7f96708cb438>
>>> len(list(ret.invert()))
51
```

# Installing

```
pip install hushbugger
```


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

hushbugger-0.0.1.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

hushbugger-0.0.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file hushbugger-0.0.1.tar.gz.

File metadata

  • Download URL: hushbugger-0.0.1.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.1 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for hushbugger-0.0.1.tar.gz
Algorithm Hash digest
SHA256 998e5027b61945c3bcd7341ab93052dc521aaeb15c7251069f8c077b16d89306
MD5 6e072f4d8d936f79f6b90f1f1d3fcf61
BLAKE2b-256 605b156a8db230ef79ba0c67ad1ac97a55006c71aea954d53afc23878aaa9019

See more details on using hashes here.

File details

Details for the file hushbugger-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: hushbugger-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.1 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for hushbugger-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 130732b6fda7f744ce28583f9a1b33cf335856945d10f52bfcef3c24e77156d3
MD5 4057af8ee6974d73f468f36149d5c811
BLAKE2b-256 d62bbb30ff6951591c178d81ba262bd197d1da59eeb151edfb25a64069eecc81

See more details on using hashes here.

Supported by

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