varInspect

Print a table of your Python variables — name, datatype, and value — straight from the running program.

from varinspect import listVars

def check_order(symbol, qty, price):
    filled = False
    tags = ["intraday", "nifty"]
    risk = {"stop": 0.5, "target": 1.2}
    listVars()

check_order("NIFTY26OCT25000CE", 50, 123.45)

name    type   value
===========================================
filled  bool   False
price   float  123.45
qty     int    50
risk    dict   {'stop': 0.5, 'target': 1.2}
symbol  str    'NIFTY26OCT25000CE'
tags    list   ['intraday', 'nifty']

Install

pip install varInspect

The distribution is named varInspect; the importable module is lowercase varinspect (PEP 8):

from varinspect import listVars, formatVars, VarRow

API

listVars(target=..., *, scope="locals", ...)

Prints the table and returns the printed rows as a list of VarRow.

formatVars(...)

Same signature, but returns the table as a string instead of printing it.

VarRow(name, type, value)

A frozen dataclass for one inspected variable. It unpacks like a tuple:

for name, type_, value in listVars():
    ...

More examples

Inspect a module or an object instead of the local scope:

import json
from varinspect import listVars

listVars(json)            # everything bound in the json module
listVars(my_config_obj)   # instance attributes plus class attributes
listVars({"a": 1})        # any mapping

Tune the output:

listVars(style="box", max_width=60)
listVars(scope="both", include_dunder=True, sort_by="type")
listVars(max_value_len=0, max_width=0)   # never truncate

┌───────────────────────┐
│ name  │ type │ value  │
├───────────────────────┤
│ label │ str  │ '完了' │
│ ok    │ bool │ True   │
└───────────────────────┘

Wide (CJK) characters are measured by display width, so columns stay aligned.

Notes

• listVars skips itself, so from varinspect import listVars never shows up as a variable of its own.
• __name__, __doc__ and friends are hidden unless you ask for them.
• A value whose __repr__ raises is reported instead of crashing the table.
• Only the standard library is required.

Development

python -m pytest
python -m build
twine check dist/*

License

MIT