Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anki-code/xunter
Tracing and profiling for the xonsh shell based on python-hunter.
https://github.com/anki-code/xunter
debugger python-hunter tracer xonsh xonsh-dev
Last synced: 6 days ago
JSON representation
Tracing and profiling for the xonsh shell based on python-hunter.
- Host: GitHub
- URL: https://github.com/anki-code/xunter
- Owner: anki-code
- License: mit
- Created: 2021-03-20T15:37:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-22T09:19:41.000Z (4 months ago)
- Last Synced: 2024-10-12T15:56:38.213Z (22 days ago)
- Topics: debugger, python-hunter, tracer, xonsh, xonsh-dev
- Language: Python
- Homepage:
- Size: 64.5 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
xunter is to tracing and profiling xonsh shell using hunter. Time tracking is on board.
If you like the idea click ⭐ on the repo and tweet.
## Install
Install xunter into the environment where xonsh you want to trace resides.
```xsh
pip install xunter
# or: pip install git+https://github.com/anki-code/xunter
```
## Usage
Xunter is working as drop-in replacement of `xonsh` with additional arguments:
```xsh
xonsh --no-rc -c "2+2"
xunter --no-rc -c "2+2" ++depth-lt 5
# ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^
# xonsh xunter
```
Simple examples:
```xsh
xunter --no-rc -c "2+2" ++depth-lt 10
xunter --no-rc ++depth-lt 5 ++output /tmp/22.xun
xunter --no-rc -c '2+2' ++filter 'Q(filename_endswith="main.py")'
```
To set `++filter` read about [filters](https://python-hunter.readthedocs.io/en/latest/filtering.html)
and take a look into the [cookbook](https://python-hunter.readthedocs.io/en/latest/cookbook.html).
Use `./playground/trace.py` to experiment with the tracing filters and understand how it works.
#### Trace xonsh in the current directory
```xsh
mkdir -p ~/git/ && cd ~/git/
git clone git+https://github.com/xonsh/xonsh
cd xonsh
xunter --no-rc -c '1+1' ++cwd ++filter 'Q(filename_has="procs/")' ++output /tmp/out.xun
# Trace ./xonsh
# In another terminal:
tail -f /tmp/out.xun
```
#### Find function calls
```xsh
xunter --no-rc -c 'echo 1' ++filter 'Q(filename_has="specs.py")' ++output /tmp/specs.xun
cat /tmp/specs.xun | grep run_subproc
# [...]/site-packages/xonsh/procs/specs.py:910:run_subproc
# <= xonsh/built_ins.py:206:subproc_captured_hiddenobject
# <= :1: <= xonsh/codecache.py:64:run_compiled_code
# <= xonsh/codecache.py:218:run_code_with_cache
# <= xonsh/main.py:519:main_xonsh
# <= xonsh/main.py:470:main
# <= xunter/xunter:91:
# - time_sec=[0.1505]
# Don't forget about xonsh`s awesome macro call:
xunter --no-rc -c 'echo 1' ++printer call ++filter! Q(filename_has="specs.py"),Q(function="run_subproc")
```
#### Filter code from prompt-toolkit and unwanted libs
```xsh
# These `filename` filters will be applied to the code that executed at the end.
# i.e. `filename="a.py"` will filter `a.py:func <= b.py:func <= c.py:func`
# but `c.py:func <= a.py:func <= b.py:func` case (`a.py` in the middle) wont be filtered.
filters = [
'~Q(filename_has="prompt_toolkit/")',
'~Q(filename_has="prompt/")',
'~Q(filename_has="ptk_shell/")',
'~Q(filename_has="pygments")',
'~Q(filename_has="_distutils_hack")',
'~Q(filename_has="lazyasd")',
'~Q(filename_has="environ")',
'~Q(filename_has="layout")',
]
xunter --no-rc ++filter @(','.join(filters)) ++output /tmp/1.xun
# Run in another terminal to monitor the activity:
tail -f /tmp/1.xun # | grep -i func
```
#### Time profiling
```xsh
xunter --no-rc -c 'echo 1' ++time-sec-gt 0.1 ++depth-lt 2
# ... - time_sec=[1.3710]
```
#### Convert log to table
```python
xunter --no-rc -c "2+2" ++depth-lt 10 ++printer stack ++output /tmp/22.xun
xunter2excel /tmp/22.xun
```
## Known issues
If you see the unexpected exceptions try to install xonsh from the main branch first:
```xsh
xpip install -U --force-reinstall git+https://github.com/xonsh/xonsh
# restart xonsh
xunter ++output /tmp/xonsh.xun
```
## See also
* [xonsh-cheatsheet](https://github.com/anki-code/xonsh-cheatsheet)
* [xonsh-install](https://github.com/anki-code/xonsh-install)
* [How to debug xonsh interactively in IDE PyCharm](https://github.com/xonsh/xonsh/issues/3090#issuecomment-2068043223)
* By putting `import ipdb; ipdb.set_trace()` into any place of code you can investigate the environment interactively.
* xonsh builtin [`trace`](https://xon.sh/aliases.html#trace)