Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gaogaotiantian/coredumpy
coredumpy saves your crash site for post-mortem debugging
https://github.com/gaogaotiantian/coredumpy
coredump debugging postmortem python tools
Last synced: 13 days ago
JSON representation
coredumpy saves your crash site for post-mortem debugging
- Host: GitHub
- URL: https://github.com/gaogaotiantian/coredumpy
- Owner: gaogaotiantian
- License: apache-2.0
- Created: 2024-04-21T19:19:34.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-03T01:24:38.000Z (6 months ago)
- Last Synced: 2024-10-18T13:49:29.621Z (26 days ago)
- Topics: coredump, debugging, postmortem, python, tools
- Language: Python
- Homepage:
- Size: 55.7 KB
- Stars: 47
- Watchers: 4
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coredumpy
[](https://github.com/gaogaotiantian/coredumpy/actions/workflows/build_test.yaml) [](https://codecov.io/gh/gaogaotiantian/coredumpy) [](https://pypi.org/project/coredumpy/) [](https://img.shields.io/pypi/pyversions/coredumpy) [](https://github.com/sponsors/gaogaotiantian)
coredumpy saves your crash site for post-mortem debugging.
## Highlights
* Easy to use
* Native support for unittest, pytest and run-time exceptions
* Portable and safe dump
* Utilizes pdb interface
## Usage
### dump
For `pytest`, you can use `coredumpy` as a plugin
```
# Create a dump in "./dumps" when there's a pytest failure/error
pytest --enable-coredumpy --coredumpy-dir ./dumps
```
For `Exception` and `unittest`, you can use `coredumpy run` command.
A dump will be generated when there's an unhandled exception or a test failure
```
# with no argument coredumpy run will generate the dump in the current dir
coredumpy run my_script.py
coredumpy run my_script.py --directory ./dumps
coredumpy run -m unittest --directory ./dumps
```
Or you can patch explicitly in your code and execute the script/module as usual
```python
import coredumpy
# Create a dump in "./dumps" when there's an unhandled exception
coredumpy.patch_except(directory='./dumps')
# Create a dump in "./dumps" when there's a unittest failure/error
coredumpy.patch_unittest(directory='./dumps')
```
Or you can dump the current frame stack manually
```python
import coredumpy
# Without frame argument, top frame will be the caller of coredumpy.dump()
coredumpy.dump()
# Specify a specific frame as the top frame to dump
coredumpy.dump(frame)
# Specify a filename to save the dump, without it a unique name will be generated
coredumpy.dump(path='coredumpy.dump')
# You can use a function for path
coredumpy.dump(path=lambda: f"coredumpy_{time.time()}.dump")
# Specify a directory to keep the dump
coredumpy.dump(directory='./dumps')
# Specify the description of the dump for peek
coredumpy.dump(description="a random dump")
```
### load
Load your dump with
```
coredumpy load
```
A [pdb](https://docs.python.org/3/library/pdb.html) debugger will be brought up
and of course not everything is supported.
### peek
If you only need some very basic information of the dump (to figure out which dump
you actually need), you can use `peek` command.
```
coredumpy peek
coredumpy peek
```
## About the data
Besides a couple of builtin types, coredumpy treats almost every object as an
Python object with attributes, and that's what it records in the dump.
It does not use `pickle` so you don't need to have the same run-time environment
when you load the dump. It's also safer to open an arbitrary dump without the
unsafe pickling process.
That being said, most of the objects will not be "restored" as they were when
being dumped. You are in an observer mode where you can inspect attributes of
all objects. None of the methods of the objects would work, nor would any
dymanic features.
## License
Copyright 2024 Tian Gao.
Distributed under the terms of the [Apache 2.0 license](https://github.com/gaogaotiantian/coredumpy/blob/master/LICENSE).