improve examples, fix tests

Author: samuelcolvin

Makefile

@@ -10,6 +10,7 @@ install-dev:
 install-test:
 	pip install -U setuptools pip
 	pip install -r tests/requirements.txt
+	pip install -r docs/requirements.txt
 	pip install -U .
 
 .PHONY: isort

devtools/debug.py

@@ -18,7 +18,7 @@
 pformat = PrettyFormat(
     indent_step=int(os.getenv('PY_DEVTOOLS_INDENT', 4)),
     simple_cutoff=int(os.getenv('PY_DEVTOOLS_SIMPLE_CUTOFF', 10)),
-    width=int(os.getenv('PY_DEVTOOLS_SIMPLE_TERM_WIDTH', 120)),
+    width=int(os.getenv('PY_DEVTOOLS_WIDTH', 120)),
     yield_from_generators=env_true('PY_DEVTOOLS_YIELD_FROM_GEN', True),
 )
 

devtools/prettier.py

@@ -21,6 +21,7 @@
     (frozenset, 'frozenset({', '})'),
 ]
 __all__ = ['PrettyFormat', 'pformat', 'pprint']
+DEFAULT_WIDTH = int(os.getenv('PY_DEVTOOLS_WIDTH', 120))
 
 
 def env_true(var_name, alt=None):

docs/examples/ex1.py

@@ -0,0 +1,8 @@
+from devtools import debug
+
+v1 = {
+    'bar': ['apple', 'banana', 'carrot', 'grapefruit'],
+    'foo': {1: 'nested', 2: 'dict'},
+}
+
+debug(v1, sum(range(5)))

docs/examples/ex2.py

@@ -0,0 +1,24 @@
+import numpy as np
+
+foo = {
+    'foo': np.array(range(20)),
+    'bar': {'apple', 'banana', 'carrot', 'grapefruit'},
+    'spam': [{'a': i, 'b': {j for j in range(1 + i * 2)}} for i in range(3)],
+    'gen': (i for i in ['i', 'am', 'a', 'generator']),
+}
+bar = {1: 2, 11: 12}
+
+debug(foo)
+
+# kwargs can be used as keys for what you are printing
+debug(
+    long_string='long strings get wrapped ' * 10,
+    new_line_sring='wraps also on newline\n' * 3,
+)
+
+# debug can also show the output of expressions
+debug(
+    len(foo),
+    bar[1],
+    foo == bar
+)

docs/examples/example1.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3.6
+#!/usr/bin/env python
 import os
 import subprocess
 import sys
@@ -7,17 +7,19 @@
 from ansi2html import Ansi2HTMLConverter
 
 EX_DIR = Path(__file__).parent / 'examples'
-os.environ['PY_DEVTOOLS_HIGHLIGHT'] = 'true'
+os.environ.update(
+    PY_DEVTOOLS_HIGHLIGHT='true',
+)
 conv = Ansi2HTMLConverter()
 
 
 def gen_html(name):
-    p = subprocess.run((sys.executable, str(EX_DIR / f'{name}.py')), stdout=subprocess.PIPE, check=True)
+    p = subprocess.run((sys.executable, str(EX_DIR / '{}.py'.format(name))), stdout=subprocess.PIPE, check=True)
     html = conv.convert(p.stdout.decode(), full=False).strip('\r\n')
     html = '<pre class="ansi2html-content">\n{}\n</pre>'.format(html)
-    (EX_DIR / f'{name}.html').write_text(html)
+    (EX_DIR / '{}.html'.format(name)).write_text(html)
 
 
-gen_html('ex1')
-gen_html('ex2')
+gen_html('example1')
+gen_html('example2')
 gen_html('prettier')

docs/examples/example2.py

@@ -31,36 +31,36 @@ and readable way to print stuff during development. (If you know why this is, I'
 
 The wait is over:
 
-.. literalinclude:: examples/ex1.py
+.. literalinclude:: examples/example1.py
 
 .. rst-class:: divider
 
 🡣
 
 .. raw:: html
-   :file: ./examples/ex1.html
+   :file: ./examples/example1.html
 
 ``debug`` is like ``print`` on steroids, and coffee, and some orange pills
 you found down the back of a chair on the tube:
 
 * each output is prefixed with the file, line number and function where ``debug`` was called
 * the variable name or expression being printed is shown
 * each argument is printed "pretty" on a new line
-* if ``pygments`` is installed the output will be highlighted
+* if ``pygments`` is installed the output is highlighted
 
 Complex usage
 .............
 
 a more complex example of ``debug`` shows more of what it can do.
 
-.. literalinclude:: examples/ex2.py
+.. literalinclude:: examples/example2.py
 
 .. rst-class:: divider
 
 🡣
 
 .. raw:: html
-   :file: ./examples/ex2.html
+   :file: ./examples/example2.html
 
 Usage without import
 ....................