https://github.com/zestyping/q

Quick and dirty debugging output for tired programmers. ⛺
https://github.com/zestyping/q

Last synced: 6 days ago
JSON representation

Quick and dirty debugging output for tired programmers. ⛺

• Host: GitHub
• URL: https://github.com/zestyping/q
• Owner: zestyping
• License: apache-2.0
• Created: 2013-03-18T20:22:52.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-12-18T23:10:02.000Z (about 1 year ago)
• Last Synced: 2025-02-07T07:11:24.423Z (14 days ago)
• Language: Python
• Size: 85 KB
• Stars: 1,302
• Watchers: 28
• Forks: 62
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# q

[![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/)

Quick and dirty debugging output for tired programmers.

For a short demo, watch the [Lightning Talk](http://pyvideo.org/video/1858/sunday-evening-lightning-talks#t=25m15s) from PyCon 2013.

Install q with `pip install -U q`.

All output goes to `/tmp/q` (or on Windows, to `$HOME/tmp/q`).  You can

watch the output with this shell command while your program is running:

    tail -f /tmp/q

To print the value of foo, insert this into your program:

    import q; q(foo)

To print the value of something in the middle of an expression, you can

wrap it with `q()`.  You can also insert `q/` or `q|` into the expression;

`q/` binds tightly whereas `q|` binds loosely.  For example, given this

statement:

    file.write(prefix + (sep or '').join(items))

you can print out various values without using any temporary variables:

    file.write(prefix + q(sep or '').join(items))  # prints (sep or '')

    file.write(q/prefix + (sep or '').join(items))  # prints prefix

    file.write(q|prefix + (sep or '').join(items))  # prints the arg to write

To trace a function (showing its arguments, return value, and running time),

insert this above the def:

    import q

    @q

To start an interactive console at any point in your code, call q.d():

    import q; q.d()

By default the output of q is not truncated, but it can be truncated by calling:

    q.short

Truncation can be reversed by:

```python

q.long # Truncates output to 1,000,000

q.long = 2000000 # Truncates output to 2,000,000

```

# Other projects inspired by this one

* [`q` for golang](https://github.com/y0ssar1an/q)

* [`qq` for elixir](https://github.com/mandarvaze/q)

* [`ic` for Python](https://github.com/gruns/icecream) - Similar library for Python, inspired by `q`.

The following

[Lightning Talk](http://pyvideo.org/video/1858/sunday-evening-lightning-talks#t=25m15s)

shows how powerful using q can be.