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

{peek_python-25.0.0 → 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.0
+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,15 +46,15 @@ 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)
+* [Copying to the clipboard](#copying-to-the-clipboard)
 
 * [Interpreting the line number information](#interpreting-the-line-number-information)
 
@@ -346,6 +346,7 @@ enabled                 -               True
 end                     -               "\n"
 equals_separator        -               "="
 filter                  f               ""
+format                  fmt             ""
 indent                  -               1
 level                   lvl             0
 line_length             ll              80
@@ -905,7 +906,42 @@ This will print:
 >
 > This setting does not influence how strings are displayed within other data structures, like dicts and lists.
 
+## format / fmt
+With the format attribute, it is possible to apply a format specifier to each of the values to be printed, like
+```
+test_float = 1.3
+peek(test_float, format="06.3f")
+```
+This will print
+```
+test_float=01.300
+```
+
+The format should be like the Python format specifiers, with or without the `:` prefix, like `"6.3f"`, `">10"`, `"06d"`, `:6.3d`.
+It is also possible to use the `!` format specifier: `"!r"`, `"!r:>10"`.
+
+If format is the null string (`""`) (the default), this functionality is skipped completely.
+
+It is also possible to use a list (or tuple) of format specifiers, which are tried in succession. If they all fail, the 'normal' serializer will be used.
+
+```
+test_float = 1.3
+test_integer=10
+test_string = "test"
+test_dict=dict(one=1, two=2)
+peek(test_float, test_integer, test_string, test_dict, format=["04d", "06.3f", ">10"])
+```
+
+will result in
+
+```
+test_float=01.300, test_integer=0010, test_string=      test, test_dict={'one': 1, 'two': 2}
+```
+
+Of course, format may be put in a peek.toml file.
+
 ## values_only / vo
+
 If False (the default), both the left-hand side (if possible) and the
 value will be printed. If True, the left hand side will be suppressed:
 
@@ -1062,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
@@ -1387,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.0 → peek_python-25.0.2}/README.md

@@ -26,15 +26,15 @@ 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)
+* [Copying to the clipboard](#copying-to-the-clipboard)
 
 * [Interpreting the line number information](#interpreting-the-line-number-information)
 
@@ -326,6 +326,7 @@ enabled                 -               True
 end                     -               "\n"
 equals_separator        -               "="
 filter                  f               ""
+format                  fmt             ""
 indent                  -               1
 level                   lvl             0
 line_length             ll              80
@@ -885,7 +886,42 @@ This will print:
 >
 > This setting does not influence how strings are displayed within other data structures, like dicts and lists.
 
+## format / fmt
+With the format attribute, it is possible to apply a format specifier to each of the values to be printed, like
+```
+test_float = 1.3
+peek(test_float, format="06.3f")
+```
+This will print
+```
+test_float=01.300
+```
+
+The format should be like the Python format specifiers, with or without the `:` prefix, like `"6.3f"`, `">10"`, `"06d"`, `:6.3d`.
+It is also possible to use the `!` format specifier: `"!r"`, `"!r:>10"`.
+
+If format is the null string (`""`) (the default), this functionality is skipped completely.
+
+It is also possible to use a list (or tuple) of format specifiers, which are tried in succession. If they all fail, the 'normal' serializer will be used.
+
+```
+test_float = 1.3
+test_integer=10
+test_string = "test"
+test_dict=dict(one=1, two=2)
+peek(test_float, test_integer, test_string, test_dict, format=["04d", "06.3f", ">10"])
+```
+
+will result in
+
+```
+test_float=01.300, test_integer=0010, test_string=      test, test_dict={'one': 1, 'two': 2}
+```
+
+Of course, format may be put in a peek.toml file.
+
 ## values_only / vo
+
 If False (the default), both the left-hand side (if possible) and the
 value will be printed. If True, the left hand side will be suppressed:
 
@@ -1042,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
@@ -1367,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.0 → peek_python-25.0.2}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "25.0.0"
+__version__ = "25.0.2"
 
 """
 See https://github.com/salabim/peek for details
@@ -65,6 +65,7 @@ class _Peek:
         ("end", "", "\n"),
         ("equals_separator", "", "="),
         ("filter", "f", ""),
+        ("format", "fmt", ""),
         ("indent", "", 1),
         ("level", "lvl", 0),
         ("line_length", "ll", 80),
@@ -110,6 +111,9 @@ class _Peek:
     colors["-"] = "\033[0m"
     colors[""] = "\033[0m"
 
+    LOCALS=object()
+    GLOBALS=object()
+
     codes = {}
 
     ansi_to_rgb = {
@@ -180,6 +184,15 @@ class _Peek:
                 if value > 0:
                     return
 
+        elif name == "format":
+            if isinstance(value, str):
+                return
+            try:
+                if all(isinstance(sub_format, str) for sub_format in value):
+                    return
+            except TypeError:
+                ...
+
         elif name == "filter":
             if value.strip() == "":
                 return
@@ -513,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 == ""):
@@ -701,6 +720,17 @@ class _Peek:
             return ""
 
     def serialize_kwargs(self, obj, width):
+        if self.format:
+            if isinstance(self.format, str):
+                iterator = iter([self.format])
+            else:
+                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:
+                    return format_string.format(obj)
+                except Exception:
+                    ...
         if isinstance(obj, str):
             if not self.quote_string:
                 return str(self.add_color_value(obj))

{peek_python-25.0.0 → 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.0
+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,15 +46,15 @@ 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)
+* [Copying to the clipboard](#copying-to-the-clipboard)
 
 * [Interpreting the line number information](#interpreting-the-line-number-information)
 
@@ -346,6 +346,7 @@ enabled                 -               True
 end                     -               "\n"
 equals_separator        -               "="
 filter                  f               ""
+format                  fmt             ""
 indent                  -               1
 level                   lvl             0
 line_length             ll              80
@@ -905,7 +906,42 @@ This will print:
 >
 > This setting does not influence how strings are displayed within other data structures, like dicts and lists.
 
+## format / fmt
+With the format attribute, it is possible to apply a format specifier to each of the values to be printed, like
+```
+test_float = 1.3
+peek(test_float, format="06.3f")
+```
+This will print
+```
+test_float=01.300
+```
+
+The format should be like the Python format specifiers, with or without the `:` prefix, like `"6.3f"`, `">10"`, `"06d"`, `:6.3d`.
+It is also possible to use the `!` format specifier: `"!r"`, `"!r:>10"`.
+
+If format is the null string (`""`) (the default), this functionality is skipped completely.
+
+It is also possible to use a list (or tuple) of format specifiers, which are tried in succession. If they all fail, the 'normal' serializer will be used.
+
+```
+test_float = 1.3
+test_integer=10
+test_string = "test"
+test_dict=dict(one=1, two=2)
+peek(test_float, test_integer, test_string, test_dict, format=["04d", "06.3f", ">10"])
+```
+
+will result in
+
+```
+test_float=01.300, test_integer=0010, test_string=      test, test_dict={'one': 1, 'two': 2}
+```
+
+Of course, format may be put in a peek.toml file.
+
 ## values_only / vo
+
 If False (the default), both the left-hand side (if possible) and the
 value will be printed. If True, the left hand side will be suppressed:
 
@@ -1062,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
@@ -1387,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.0 → 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.0"
+version = "25.0.2"
 readme = "README.md"
 requires-python = ">=3.6"
 dependencies = [

{peek_python-25.0.0 → 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="/")