pyflyby 1.9.6__tar.gz → 1.9.7__tar.gz

{pyflyby-1.9.6/lib/python/pyflyby.egg-info → pyflyby-1.9.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflyby
-Version: 1.9.6
+Version: 1.9.7
 Summary: pyflyby - Python development productivity tools, in particular automatic import management
 Home-page: https://pypi.org/project/pyflyby/
 Author: Karl Chen
@@ -481,6 +481,38 @@ Emacs support
 - Pyflyby.el doesn't yet work with XEmacs; patches welcome.
 
 
+saveframe: A utility for debugging / reproducing an issue
+=========================================================
+
+PyFlyBy provides a utility named **saveframe** which can be used to save 
+information for debugging / reproducing an issue.
+
+**Usage**: If you have a piece of code or a script that is failing due an issue 
+originating from upstream code, and you cannot share your private code as a reproducer, 
+use this utility to save relevant information to a file. Share the generated file with 
+the upstream team, enabling them to reproduce and diagnose the issue independently.
+
+**Information saved in the file**: This utility captures and saves *error stack frames* 
+to a file. It includes the values of local variables from each stack frame, as well 
+as metadata about each frame and the exception raised by your code.
+
+This utility comes with 2 interfaces:
+
+1. **A function**: For interactive usages such as IPython, Jupyter Notebook, or a
+   debugger (pdb/ipdb), use **pyflyby.saveframe** function. To know how to use this 
+   function, checkout it's documentation:
+
+.. code::
+
+   In [1]: saveframe?
+
+2. **A script**: For cli usages (like a failing script), use **pyflyby/bin/saveframe** 
+   script. To know how to use this script, checkout its documentation:
+
+.. code::
+
+   $ saveframe --help
+
 Authorship
 ==========
 

{pyflyby-1.9.6 → pyflyby-1.9.7}/README.rst

@@ -460,6 +460,38 @@ Emacs support
 - Pyflyby.el doesn't yet work with XEmacs; patches welcome.
 
 
+saveframe: A utility for debugging / reproducing an issue
+=========================================================
+
+PyFlyBy provides a utility named **saveframe** which can be used to save 
+information for debugging / reproducing an issue.
+
+**Usage**: If you have a piece of code or a script that is failing due an issue 
+originating from upstream code, and you cannot share your private code as a reproducer, 
+use this utility to save relevant information to a file. Share the generated file with 
+the upstream team, enabling them to reproduce and diagnose the issue independently.
+
+**Information saved in the file**: This utility captures and saves *error stack frames* 
+to a file. It includes the values of local variables from each stack frame, as well 
+as metadata about each frame and the exception raised by your code.
+
+This utility comes with 2 interfaces:
+
+1. **A function**: For interactive usages such as IPython, Jupyter Notebook, or a
+   debugger (pdb/ipdb), use **pyflyby.saveframe** function. To know how to use this 
+   function, checkout it's documentation:
+
+.. code::
+
+   In [1]: saveframe?
+
+2. **A script**: For cli usages (like a failing script), use **pyflyby/bin/saveframe** 
+   script. To know how to use this script, checkout its documentation:
+
+.. code::
+
+   $ saveframe --help
+
 Authorship
 ==========
 

{pyflyby-1.9.6 → pyflyby-1.9.7}/bin/pyflyby/__init__.py

@@ -32,6 +32,7 @@ from   pyflyby._interactive     import (disable_auto_importer,
 from   pyflyby._livepatch       import livepatch, xreload
 from   pyflyby._log             import logger
 from   pyflyby._parse           import PythonBlock, PythonStatement
+from   pyflyby._saveframe       import saveframe
 from   pyflyby._version         import __version__
 
 # Deprecated:

{pyflyby-1.9.6/lib/python → pyflyby-1.9.7/bin}/pyflyby/_importdb.py

@@ -284,7 +284,7 @@ class ImportDB:
         target_path = Path(target_filename).resolve()
 
         parents: List[Path]
-        if not target_path.is_dir():
+        if target_path.is_dir():
             parents = [target_path]
         else:
             parents = []