From 6a55a66dcdd53ec4ba10bede6edc9661850c0a68 Mon Sep 17 00:00:00 2001 From: Tian Gao Date: Sun, 28 Apr 2024 20:19:26 -0700 Subject: [PATCH] Polish readme (#24) --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c755317..9dedce9 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ coredumpy saves your crash site for post-mortem debugging. ## Highlights * Easy to use -* Native support for unittest, pytest and exceptions +* Native support for unittest, pytest and run-time exceptions * Portable and safe dump * Utilizes pdb interface @@ -30,10 +30,15 @@ coredumpy.patch_unittest(directory='./dumps') 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 ``` +
+ + Or you can dump the current frame stack manually + ```python import coredumpy @@ -52,6 +57,8 @@ coredumpy.dump(directory='./dumps') coredumpy.dump(description="a random dump") ``` +
+ ### load Load your dump with @@ -63,11 +70,6 @@ coredumpy load A [pdb](https://docs.python.org/3/library/pdb.html) debugger will be brought up and of course not everything is supported. -Objects are not "recreated" in the load process, which makes it safe to even -open an unknown dump (not recommended though). You will be in an "observer" -mode where you can access certain types of value of the variables and attributes, -but none of the user-created objects will have the actual functionality. - ### peek If you only need some very basic information of the dump (to figure out which dump