peek-python 25.0.1__tar.gz → 25.0.2__tar.gz

{peek_python-25.0.1 → peek_python-25.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: peek-python
-Version: 25.0.1
+Version: 25.0.2
 Summary: peek - debugging and benchmarking made easy
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/peek
@@ -46,13 +46,13 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Use peek.print to use peek like print with extras](#use-peekprint-to-use-peek-like-print-with-extras)
 
+* [Peeking locals and globals](#peeking-locals-and-globals)
+
 * [Return a string instead of sending to output](#return-a-string-instead-of-sending-to-output)
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using level to control peek output](#using-level-to-control-peek-output)
-
-* [Using color to control peek output](#using-color-to-control-peek-output)
+* [Using filter to control peek output](#using-filter-to-control-peek-output)
 
 * [Copying to the clipboard](#copying-to-the-clipboard)
 
@@ -1098,6 +1098,35 @@ peek.sep = "|"  # sets the 'normal' peek separator
 >
 > `peek.print` does not obey the line length and will always return None (unless as_str is True). 
 
+
+# Peeking locals and globals
+It is possible to get the name and values of all local or global variables.
+
+To do that, just put `locals` or `globals` in the call to peek, e.g.:
+
+```
+def my_func():
+    a = 10
+    b = a * a
+    peek(locals)
+my_func()
+```
+
+will print all local variables, apart from those starting with `__`, so:
+```
+a=10, b=100
+```
+
+Likewise,
+```
+peek(globals)
+```
+will print all global variables, apart from those starting with `__`  
+
+> [!IMPORTANT]
+>
+> You should not add parentheses after `locals` or `globals` for peek to work properly!
+
 # Return a string instead of sending to output
 
 `peek(*args, as_str=True)` is like `peek(*args)` but the output is returned as a string instead
@@ -1423,6 +1452,7 @@ can show traceback                yes                         no
 can be used like print w/extras   yes (with peek.print)       no
 allows non linefeed printing      yes (via end parameter)     requires patching
 PEP8 (Pythonic) API               yes                         no
+format specification              optional                    no
 sorts dicts                       no by default, optional *)  yes
 supports compact, indent,
 and underscore_numbers

{peek_python-25.0.1 → peek_python-25.0.2}/README.md

@@ -26,13 +26,13 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Use peek.print to use peek like print with extras](#use-peekprint-to-use-peek-like-print-with-extras)
 
+* [Peeking locals and globals](#peeking-locals-and-globals)
+
 * [Return a string instead of sending to output](#return-a-string-instead-of-sending-to-output)
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using level to control peek output](#using-level-to-control-peek-output)
-
-* [Using color to control peek output](#using-color-to-control-peek-output)
+* [Using filter to control peek output](#using-filter-to-control-peek-output)
 
 * [Copying to the clipboard](#copying-to-the-clipboard)
 
@@ -1078,6 +1078,35 @@ peek.sep = "|"  # sets the 'normal' peek separator
 >
 > `peek.print` does not obey the line length and will always return None (unless as_str is True). 
 
+
+# Peeking locals and globals
+It is possible to get the name and values of all local or global variables.
+
+To do that, just put `locals` or `globals` in the call to peek, e.g.:
+
+```
+def my_func():
+    a = 10
+    b = a * a
+    peek(locals)
+my_func()
+```
+
+will print all local variables, apart from those starting with `__`, so:
+```
+a=10, b=100
+```
+
+Likewise,
+```
+peek(globals)
+```
+will print all global variables, apart from those starting with `__`  
+
+> [!IMPORTANT]
+>
+> You should not add parentheses after `locals` or `globals` for peek to work properly!
+
 # Return a string instead of sending to output
 
 `peek(*args, as_str=True)` is like `peek(*args)` but the output is returned as a string instead
@@ -1403,6 +1432,7 @@ can show traceback                yes                         no
 can be used like print w/extras   yes (with peek.print)       no
 allows non linefeed printing      yes (via end parameter)     requires patching
 PEP8 (Pythonic) API               yes                         no
+format specification              optional                    no
 sorts dicts                       no by default, optional *)  yes
 supports compact, indent,
 and underscore_numbers

{peek_python-25.0.1 → peek_python-25.0.2}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "25.0.1"
+__version__ = "25.0.2"
 
 """
 See https://github.com/salabim/peek for details
@@ -111,6 +111,9 @@ class _Peek:
     colors["-"] = "\033[0m"
     colors[""] = "\033[0m"
 
+    LOCALS=object()
+    GLOBALS=object()
+
     codes = {}
 
     ansi_to_rgb = {
@@ -523,7 +526,13 @@ class _Peek:
                             pass
                     if left:
                         left += this.equals_separator
-                    pairs.append(Pair(left=left, right=right))
+                    if right in (locals, globals,vars):
+                            frame = inspect.currentframe().f_back.f_back
+                            for name, value in {locals: frame.f_locals, globals: frame.f_globals, vars:frame.f_locals}[right].items():
+                                if not (isinstance(value,PeekModule) or name.startswith("__")):
+                                    pairs.append(Pair(left=name+this.equals_separator,right=value))
+                    else:
+                        pairs.append(Pair(left=left, right=right))
 
             just_one_line = False
             if not (len(pairs) > 1 and this.separator == ""):
@@ -713,9 +722,9 @@ class _Peek:
     def serialize_kwargs(self, obj, width):
         if self.format:
             if isinstance(self.format, str):
-                iterator=iter([self.format])
+                iterator = iter([self.format])
             else:
-                iterator=iter(self.format)
+                iterator = iter(self.format)
             for sub_format in iterator:
                 format_string = "{" + sub_format + "}" if sub_format.startswith(":") or sub_format.startswith("!") else "{:" + sub_format + "}"
                 try:

{peek_python-25.0.1 → peek_python-25.0.2}/peek_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: peek-python
-Version: 25.0.1
+Version: 25.0.2
 Summary: peek - debugging and benchmarking made easy
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/peek
@@ -46,13 +46,13 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Use peek.print to use peek like print with extras](#use-peekprint-to-use-peek-like-print-with-extras)
 
+* [Peeking locals and globals](#peeking-locals-and-globals)
+
 * [Return a string instead of sending to output](#return-a-string-instead-of-sending-to-output)
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using level to control peek output](#using-level-to-control-peek-output)
-
-* [Using color to control peek output](#using-color-to-control-peek-output)
+* [Using filter to control peek output](#using-filter-to-control-peek-output)
 
 * [Copying to the clipboard](#copying-to-the-clipboard)
 
@@ -1098,6 +1098,35 @@ peek.sep = "|"  # sets the 'normal' peek separator
 >
 > `peek.print` does not obey the line length and will always return None (unless as_str is True). 
 
+
+# Peeking locals and globals
+It is possible to get the name and values of all local or global variables.
+
+To do that, just put `locals` or `globals` in the call to peek, e.g.:
+
+```
+def my_func():
+    a = 10
+    b = a * a
+    peek(locals)
+my_func()
+```
+
+will print all local variables, apart from those starting with `__`, so:
+```
+a=10, b=100
+```
+
+Likewise,
+```
+peek(globals)
+```
+will print all global variables, apart from those starting with `__`  
+
+> [!IMPORTANT]
+>
+> You should not add parentheses after `locals` or `globals` for peek to work properly!
+
 # Return a string instead of sending to output
 
 `peek(*args, as_str=True)` is like `peek(*args)` but the output is returned as a string instead
@@ -1423,6 +1452,7 @@ can show traceback                yes                         no
 can be used like print w/extras   yes (with peek.print)       no
 allows non linefeed printing      yes (via end parameter)     requires patching
 PEP8 (Pythonic) API               yes                         no
+format specification              optional                    no
 sorts dicts                       no by default, optional *)  yes
 supports compact, indent,
 and underscore_numbers

{peek_python-25.0.1 → peek_python-25.0.2}/pyproject.toml

@@ -10,7 +10,7 @@ authors = [
     { name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com" },
 ]
 description = "peek - debugging and benchmarking made easy"
-version = "25.0.1"
+version = "25.0.2"
 readme = "README.md"
 requires-python = ">=3.6"
 dependencies = [

{peek_python-25.0.1 → peek_python-25.0.2}/tests/test_peek.py

@@ -122,6 +122,7 @@ def test_time_delta():
     time.sleep(0.1)
     assert 10.05 < peek.delta < 11
 
+  
 
 def test_dynamic_prefix(capsys):
     g.i = 0
@@ -307,7 +308,8 @@ def test_print(capsys):
 
     result=peek.print(1,2)
     assert result is None
-
+    out, err = capsys.readouterr()
+    assert out == "1 2\n"
 
     with pytest.raises(AttributeError):
         peek.print(sep="|", sepp="/")