peek-python 24.0.1__tar.gz → 24.0.2__tar.gz

{peek_python-24.0.1 → peek_python-24.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.1
+Version: 24.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
@@ -18,8 +18,7 @@ Requires-Dist: pyperclip>=1.9.0
 Requires-Dist: six>=1.17.0
 Requires-Dist: tomli>=2.2.1
 
-- [ ]  <img src="https://www.salabim.org/peek/peek_logo1.png">
-
+ <img src="https://www.salabim.org/peek/peek_logo1.png">
 
 # Introduction
 
@@ -49,7 +48,9 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using filter to control peek output](#Using-filter-to-control-peek-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)
 
 * [Copying to the clipboard](#Copying-to-the-clipboard)
 
@@ -63,14 +64,12 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Using peek in a REPL](#using-peek-in-a-repl)
 
-* [Alternative to `peek`](#alternative-to-peek)
-
 * [Limitations](#limitations)
 
-* [Acknowledgement](#acknowledgement)
-
 * [Changelog](#changelog)
 
+* [Acknowledgement](#acknowledgement)
+
 * [Differences with IceCream](#differences-with-icecream)
 
 
@@ -85,9 +84,10 @@ or when you want to upgrade,
 pip install peek-python --upgrade
 ```
 
-Alternatively, peek.py can be just copied into you current work directory from GitHub (https://github.com/salabim/peek).
+Alternatively, peek.py can be just copied into you current work directory from GitHub
+(https://github.com/salabim/peek).
 
-Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed with pip.
+Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed.
 
 # Importing peek
 
@@ -103,9 +103,8 @@ import peek
 from peek import peek
 ```
 
-> [!NOTE]
->
-> After this, `peek` is automatically a builtin and can thus be used in any module without importing it there.
+Note that after this, `peek` is automatically a builtin and can thus be used in any module without
+importing it there.
 
 # Inspect variables and expressions
 
@@ -155,7 +154,7 @@ prints
 ```
 world={"EN": "world ", "NL": "wereld", "FR": "monde", "DE": "Welt"}, X.a: 3
 ```
-Just give `peek()` a variable or expression and you're done. Easy, or what?
+Just give `peek()` a variable or expression and you're done.
 
 
 # Inspect execution
@@ -189,8 +188,6 @@ prints something like
 #5 in add2()
 add2(1000)=1002
 ```
-Just call `peek()` and you're done. Isn't that easy?
-
 
 # Return Value
 
@@ -322,9 +319,9 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value             col_val         "-"
-context_separator       cs              " ==> "
+color_value				col_val	        "-"
 compact                 -               False
+context_separator       cs              " ==> "
 depth                   -               1000000
 delta                   -               0
 enabled                 -               True
@@ -348,10 +345,10 @@ show_time               st              False
 show_traceback          -               False
 sort_dicts              -               False
 to_clipboard            clip            False
-underscore_numbers      un              False
-wrap_indent             -               "     "   
+underscore_numbers      un              False   
 values_only             vo              False
 value_only_for_fstrings voff            False 
+wrap_indent             -               "     "
 ------------------------------------------------------
 ```
 It is perfectly ok to set/get any of these attributes directly, like
@@ -362,7 +359,6 @@ print(peek.prefix)
 
 But, it is also possible to apply configuration directly, only here, in the call to `peek`:
 So, it is possible to say
-
 ```
 peek(12, prefix="==> ")
 ```
@@ -370,23 +366,25 @@ peek(12, prefix="==> ")
 ```
 ==> 12
 ```
-It is also possible to configure peek permanently with the configure method. 
+It is also possible to configure several attributes permanently with the configure method. 
 ```
-peek.configure(prefix="==> ")
+peek.configure(prefix="==> ", color="blue")
 peek(12)
 ```
-will print
+will print in blue
 ```
 ==> 12
 ```
 It is arguably easier to say:
 ```
 peek.prefix = "==> "
+peek.color = "blue"
 peek(12)
 ```
 or even
 ```
 peek.pr = "==> "
+peek.col = "blue"
 peek(12)
 ```
 to print
@@ -395,7 +393,7 @@ to print
 ```
 Yet another way to configure peek is to get a new instance of peek with peek.new() and the required configuration:
 ```
-z = peek.new(prefix="==> ")
+z = peek.new(prefix="==> ", color="blue")
 z(12)
 ```
 will print
@@ -620,7 +618,7 @@ prints
 The `show_traceback` functionality is also available when peek is used as a decorator or context manager. 
 
 ## line_length / ll
-This attribute is used to specify the line length (for wrapping). The default is 160.
+This attribute is used to specify the line length (for wrapping). The default is 80.
 Peek tries to keep all output on one line, but if it can't it will wrap:
 
 ```
@@ -637,7 +635,7 @@ d=
      'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
 ```
 
-## color / col and color_value / col_val
+## color / col and color_value / colv
 The color attribute is used to specify the color of the output.
 There's a choice of black, white, red, green, blue, cyan, magenta and yellow.
 To set the color to 'nothing', use "-".
@@ -665,7 +663,7 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 >
 > The color and color_value attributes are only applied when using stdout as output.
 > 
-> Colors can be ignored completely by using `peek.output = "stdout_nocolor"`.
+> Colors can be ignored completely by using `peek.output = "stdout_nocolor`.
 
 ## compact
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -818,6 +816,8 @@ numbers={'one': 1, 'thousand': 1_000, 'million': 1_000_000, 'x1234567890': 1_234
 numbers={'one': 1, 'thousand': 1000, 'million': 1000000, 'x1234567890': 1234567890}
 ```
 
+Note that under Python <=3.7, numbers are never underscored.
+
 ## seperator / sep
 
 By default, pairs (on one line) are separated by `, `.
@@ -836,7 +836,6 @@ prints
 a='abcd', (b,c)=(1, 1000), d=['peek', 'c', 'e', 'c', 'r', 'e', 'a', 'm']
 a='abcd' | (b,c)=(1, 1000) | d=['peek', 'c', 'e', 'c', 'r', 'e', 'a', 'm']
 ```
-Note that under Python <=3.7, numbers are never printed with underscores.
 
 ## context_separator
 
@@ -909,14 +908,15 @@ If True, the left_hand side will be suppressed in case of an f-string:
 
 ```
 x = 12.3
-peek(f"{x:0.3e}")
+peek.quote_string = False
+peek(f"{x=:0.3e}")
 peek.values_only_for_fstrings = True
-peek(f"{x:0.3e}")
+peek(f"{x=:0.3e}")
 ```
 prints
 ```
-f"{x:0.3e}"='1.230e+01'
-'1.230e+01'
+f"{x=:0.3e}"=x=1.230e+01
+x=1.230e+01
 ```
 Note that if `values_only` is True, f-string will be suppressed, regardless of `values_only_for_fstrings`.
 
@@ -990,7 +990,7 @@ delta=0.011826 ==> 2
 delta=0.044893 ==> 6
 True
 ```
-Of course `peek()` continues to return its arguments when disabled, of course.
+Of course `peek()` continues to return its arguments when disabled.
 
 It is also possible to suppress output with the provided attribute (see above).
 
@@ -1014,7 +1014,7 @@ It is possible to use more than one attribute, like
 ```
 peek.filter = "color == 'blue' and delta > 5"
 ```
-As an alternative to `enabled` we can also say
+As an alternative to `enabled` we can alo say
 ```
 peek.filter = "False"
 ```
@@ -1023,7 +1023,7 @@ peek.filter = "False"
 
 It is possible to copy a value to the clipboard. There are two ways:
 
-### With peek(*args, to_clipboard=True)
+### With peek(to_clipboard=True)
 
 With the optional keyword argument, *to_clipboard*:
 
@@ -1089,22 +1089,22 @@ The parent function can be suppressed by setting `show_line_number` or `sln` to
 
 It can be useful to configure peek at import time. This can be done by providing a `peek.toml` file which
 can contain any attribute configuration overriding the standard settings.
-E.g. if there is an `peek.toml` file with the following contents
+E.g. if there is a `peek.toml` file with the following contents
 
 ```
 outpout = "stderr"
 show_time = true
 ll = 160
-compact = true
+quote_string = false
 ```
 in the same folder as the application, this program:
 ```
 hello = "world"
 peek(hello)
 ```
-will print to stderr (rather than stdout):
+will print something like this to stderr (rather than stdout):
 ```
-@ 14:53:41.392190 ==> hello='world'
+@ 14:53:41.392190 ==> hello=world
 ```
 At import time current directory will be searched for `peek.toml` and if not found, one level up, etc. until the root directory is reached.
 
@@ -1136,15 +1136,14 @@ Normally, only the `peek` object is used.
 It can be useful to have multiple instances, e.g. when some of the debugging has to be done with context information
 and others requires an alternative prefix.
 
-There are several ways to obtain a new instance of peek:
+THere are several ways to obtain a new instance of peek:
 
 *    by using `peek.new()`
      
      With this a new peek object is created with the default attributes
-     and possibly peek.toml overrides.
 *    by using `peek.new(ignore_toml=True)`
 
-     With this a new peek object is created with the default attributes. Any peek.toml files are ignored.
+     With this a new peekobject is created with the default attibutes. Any peek.toml files are ignored.
 *    by using `peek.fork()`
      
      With this a new peek object is created with the same attributes as the object it is created ('the parent') from. Note that any non set attributes are copied (propagated) from the parent.
@@ -1232,15 +1231,9 @@ Peek may be used in a REPL, but with limited functionality:
 * use as a decorator is not supported
 * use as a context manager is not supported
 
-# Alternative to `peek`
-
-Sometimes, even peek is too long during a debug session or it is not suitable to use the name peek.
-
-In that case, it is possible to use p instead
-```
-from peek import p
-```
-The `p` object is a *fork* of peek. That means that attributes of `peek` are propagated to `p`, unless overridden.
+> [!NOTE]
+>
+> Under Python >=3.13 most of the normal peek functionality is available in the REPL. A reason to upgrade!
 
 
 # Limitations
@@ -1259,12 +1252,11 @@ The changelog can be found here:
 
 # Acknowledgement
 
-The **peek** package is inspired by the **IceCream** package, but is a 
-nearly complete rewrite. See https://github.com/gruns/icecream
+The **peek** package is inspired by the **IceCream** package, but is a nearly complete rewrite. See https://github.com/gruns/icecream
 
 Many thanks to the author Ansgar Grunseid / grunseid.com / grunseid@gmail.com .
 
-The peek package is a rebrand of the **ycecream** package, with enhancements.
+The peek package is a rebrand of the **ycecream** package, with many enhancements.
 
 # Differences with IceCream
 
@@ -1299,7 +1291,7 @@ colorize ***)                     yes, off by default         yes, on by default
 -----------------------------------------------------------------------------------------
 *)   under Python <= 3.7, dicts are always sorted
 **)  under Python <= 3.7, numbers are never underscored
-***) peek allows selection of a color, whereas IceCream does coloring based on contents
+***) peek allows selection of colors, whereas IceCream does coloring based on contents.
 
 ```
 ![PyPI](https://img.shields.io/pypi/v/peek-python) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/peek-python) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/peek)

{peek_python-24.0.1 → peek_python-24.0.2}/README.md

@@ -1,5 +1,4 @@
-- [ ]  <img src="https://www.salabim.org/peek/peek_logo1.png">
-
+ <img src="https://www.salabim.org/peek/peek_logo1.png">
 
 # Introduction
 
@@ -29,7 +28,9 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using filter to control peek output](#Using-filter-to-control-peek-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)
 
 * [Copying to the clipboard](#Copying-to-the-clipboard)
 
@@ -43,14 +44,12 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Using peek in a REPL](#using-peek-in-a-repl)
 
-* [Alternative to `peek`](#alternative-to-peek)
-
 * [Limitations](#limitations)
 
-* [Acknowledgement](#acknowledgement)
-
 * [Changelog](#changelog)
 
+* [Acknowledgement](#acknowledgement)
+
 * [Differences with IceCream](#differences-with-icecream)
 
 
@@ -65,9 +64,10 @@ or when you want to upgrade,
 pip install peek-python --upgrade
 ```
 
-Alternatively, peek.py can be just copied into you current work directory from GitHub (https://github.com/salabim/peek).
+Alternatively, peek.py can be just copied into you current work directory from GitHub
+(https://github.com/salabim/peek).
 
-Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed with pip.
+Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed.
 
 # Importing peek
 
@@ -83,9 +83,8 @@ import peek
 from peek import peek
 ```
 
-> [!NOTE]
->
-> After this, `peek` is automatically a builtin and can thus be used in any module without importing it there.
+Note that after this, `peek` is automatically a builtin and can thus be used in any module without
+importing it there.
 
 # Inspect variables and expressions
 
@@ -135,7 +134,7 @@ prints
 ```
 world={"EN": "world ", "NL": "wereld", "FR": "monde", "DE": "Welt"}, X.a: 3
 ```
-Just give `peek()` a variable or expression and you're done. Easy, or what?
+Just give `peek()` a variable or expression and you're done.
 
 
 # Inspect execution
@@ -169,8 +168,6 @@ prints something like
 #5 in add2()
 add2(1000)=1002
 ```
-Just call `peek()` and you're done. Isn't that easy?
-
 
 # Return Value
 
@@ -302,9 +299,9 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value             col_val         "-"
-context_separator       cs              " ==> "
+color_value				col_val	        "-"
 compact                 -               False
+context_separator       cs              " ==> "
 depth                   -               1000000
 delta                   -               0
 enabled                 -               True
@@ -328,10 +325,10 @@ show_time               st              False
 show_traceback          -               False
 sort_dicts              -               False
 to_clipboard            clip            False
-underscore_numbers      un              False
-wrap_indent             -               "     "   
+underscore_numbers      un              False   
 values_only             vo              False
 value_only_for_fstrings voff            False 
+wrap_indent             -               "     "
 ------------------------------------------------------
 ```
 It is perfectly ok to set/get any of these attributes directly, like
@@ -342,7 +339,6 @@ print(peek.prefix)
 
 But, it is also possible to apply configuration directly, only here, in the call to `peek`:
 So, it is possible to say
-
 ```
 peek(12, prefix="==> ")
 ```
@@ -350,23 +346,25 @@ peek(12, prefix="==> ")
 ```
 ==> 12
 ```
-It is also possible to configure peek permanently with the configure method. 
+It is also possible to configure several attributes permanently with the configure method. 
 ```
-peek.configure(prefix="==> ")
+peek.configure(prefix="==> ", color="blue")
 peek(12)
 ```
-will print
+will print in blue
 ```
 ==> 12
 ```
 It is arguably easier to say:
 ```
 peek.prefix = "==> "
+peek.color = "blue"
 peek(12)
 ```
 or even
 ```
 peek.pr = "==> "
+peek.col = "blue"
 peek(12)
 ```
 to print
@@ -375,7 +373,7 @@ to print
 ```
 Yet another way to configure peek is to get a new instance of peek with peek.new() and the required configuration:
 ```
-z = peek.new(prefix="==> ")
+z = peek.new(prefix="==> ", color="blue")
 z(12)
 ```
 will print
@@ -600,7 +598,7 @@ prints
 The `show_traceback` functionality is also available when peek is used as a decorator or context manager. 
 
 ## line_length / ll
-This attribute is used to specify the line length (for wrapping). The default is 160.
+This attribute is used to specify the line length (for wrapping). The default is 80.
 Peek tries to keep all output on one line, but if it can't it will wrap:
 
 ```
@@ -617,7 +615,7 @@ d=
      'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
 ```
 
-## color / col and color_value / col_val
+## color / col and color_value / colv
 The color attribute is used to specify the color of the output.
 There's a choice of black, white, red, green, blue, cyan, magenta and yellow.
 To set the color to 'nothing', use "-".
@@ -645,7 +643,7 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 >
 > The color and color_value attributes are only applied when using stdout as output.
 > 
-> Colors can be ignored completely by using `peek.output = "stdout_nocolor"`.
+> Colors can be ignored completely by using `peek.output = "stdout_nocolor`.
 
 ## compact
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -798,6 +796,8 @@ numbers={'one': 1, 'thousand': 1_000, 'million': 1_000_000, 'x1234567890': 1_234
 numbers={'one': 1, 'thousand': 1000, 'million': 1000000, 'x1234567890': 1234567890}
 ```
 
+Note that under Python <=3.7, numbers are never underscored.
+
 ## seperator / sep
 
 By default, pairs (on one line) are separated by `, `.
@@ -816,7 +816,6 @@ prints
 a='abcd', (b,c)=(1, 1000), d=['peek', 'c', 'e', 'c', 'r', 'e', 'a', 'm']
 a='abcd' | (b,c)=(1, 1000) | d=['peek', 'c', 'e', 'c', 'r', 'e', 'a', 'm']
 ```
-Note that under Python <=3.7, numbers are never printed with underscores.
 
 ## context_separator
 
@@ -889,14 +888,15 @@ If True, the left_hand side will be suppressed in case of an f-string:
 
 ```
 x = 12.3
-peek(f"{x:0.3e}")
+peek.quote_string = False
+peek(f"{x=:0.3e}")
 peek.values_only_for_fstrings = True
-peek(f"{x:0.3e}")
+peek(f"{x=:0.3e}")
 ```
 prints
 ```
-f"{x:0.3e}"='1.230e+01'
-'1.230e+01'
+f"{x=:0.3e}"=x=1.230e+01
+x=1.230e+01
 ```
 Note that if `values_only` is True, f-string will be suppressed, regardless of `values_only_for_fstrings`.
 
@@ -970,7 +970,7 @@ delta=0.011826 ==> 2
 delta=0.044893 ==> 6
 True
 ```
-Of course `peek()` continues to return its arguments when disabled, of course.
+Of course `peek()` continues to return its arguments when disabled.
 
 It is also possible to suppress output with the provided attribute (see above).
 
@@ -994,7 +994,7 @@ It is possible to use more than one attribute, like
 ```
 peek.filter = "color == 'blue' and delta > 5"
 ```
-As an alternative to `enabled` we can also say
+As an alternative to `enabled` we can alo say
 ```
 peek.filter = "False"
 ```
@@ -1003,7 +1003,7 @@ peek.filter = "False"
 
 It is possible to copy a value to the clipboard. There are two ways:
 
-### With peek(*args, to_clipboard=True)
+### With peek(to_clipboard=True)
 
 With the optional keyword argument, *to_clipboard*:
 
@@ -1069,22 +1069,22 @@ The parent function can be suppressed by setting `show_line_number` or `sln` to
 
 It can be useful to configure peek at import time. This can be done by providing a `peek.toml` file which
 can contain any attribute configuration overriding the standard settings.
-E.g. if there is an `peek.toml` file with the following contents
+E.g. if there is a `peek.toml` file with the following contents
 
 ```
 outpout = "stderr"
 show_time = true
 ll = 160
-compact = true
+quote_string = false
 ```
 in the same folder as the application, this program:
 ```
 hello = "world"
 peek(hello)
 ```
-will print to stderr (rather than stdout):
+will print something like this to stderr (rather than stdout):
 ```
-@ 14:53:41.392190 ==> hello='world'
+@ 14:53:41.392190 ==> hello=world
 ```
 At import time current directory will be searched for `peek.toml` and if not found, one level up, etc. until the root directory is reached.
 
@@ -1116,15 +1116,14 @@ Normally, only the `peek` object is used.
 It can be useful to have multiple instances, e.g. when some of the debugging has to be done with context information
 and others requires an alternative prefix.
 
-There are several ways to obtain a new instance of peek:
+THere are several ways to obtain a new instance of peek:
 
 *    by using `peek.new()`
      
      With this a new peek object is created with the default attributes
-     and possibly peek.toml overrides.
 *    by using `peek.new(ignore_toml=True)`
 
-     With this a new peek object is created with the default attributes. Any peek.toml files are ignored.
+     With this a new peekobject is created with the default attibutes. Any peek.toml files are ignored.
 *    by using `peek.fork()`
      
      With this a new peek object is created with the same attributes as the object it is created ('the parent') from. Note that any non set attributes are copied (propagated) from the parent.
@@ -1212,15 +1211,9 @@ Peek may be used in a REPL, but with limited functionality:
 * use as a decorator is not supported
 * use as a context manager is not supported
 
-# Alternative to `peek`
-
-Sometimes, even peek is too long during a debug session or it is not suitable to use the name peek.
-
-In that case, it is possible to use p instead
-```
-from peek import p
-```
-The `p` object is a *fork* of peek. That means that attributes of `peek` are propagated to `p`, unless overridden.
+> [!NOTE]
+>
+> Under Python >=3.13 most of the normal peek functionality is available in the REPL. A reason to upgrade!
 
 
 # Limitations
@@ -1239,12 +1232,11 @@ The changelog can be found here:
 
 # Acknowledgement
 
-The **peek** package is inspired by the **IceCream** package, but is a 
-nearly complete rewrite. See https://github.com/gruns/icecream
+The **peek** package is inspired by the **IceCream** package, but is a nearly complete rewrite. See https://github.com/gruns/icecream
 
 Many thanks to the author Ansgar Grunseid / grunseid.com / grunseid@gmail.com .
 
-The peek package is a rebrand of the **ycecream** package, with enhancements.
+The peek package is a rebrand of the **ycecream** package, with many enhancements.
 
 # Differences with IceCream
 
@@ -1279,7 +1271,7 @@ colorize ***)                     yes, off by default         yes, on by default
 -----------------------------------------------------------------------------------------
 *)   under Python <= 3.7, dicts are always sorted
 **)  under Python <= 3.7, numbers are never underscored
-***) peek allows selection of a color, whereas IceCream does coloring based on contents
+***) peek allows selection of colors, whereas IceCream does coloring based on contents.
 
 ```
 ![PyPI](https://img.shields.io/pypi/v/peek-python) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/peek-python) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/peek)

{peek_python-24.0.1 → peek_python-24.0.2}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "24.0.1"
+__version__ = "24.0.2"
 
 """
 See https://github.com/salabim/peek for details
@@ -42,6 +42,7 @@ if Pythonista:
     import clipboard
 else:
     import colorama
+
     colorama.just_fix_windows_console()
     import pyperclip
 
@@ -160,21 +161,6 @@ def check_validity(name, value):
     raise AttributeError(f"incorrect {name_org}: {repr(value)}{in_read_toml_message}")
 
 
-class Source(executing.Source):
-    def get_text_with_indentation(self, node):
-        result = self.asttokens().get_text(node)
-        if "\n" in result:
-            result = " " * node.first_token.start[1] + result
-            result = textwrap.dedent(result)
-        result = result.strip()
-        return result
-
-
-def change_path(new_path):  # used in tests
-    global Path
-    Path = new_path
-
-
 _fixed_perf_counter = None
 
 
@@ -260,7 +246,7 @@ class _Peek:
             return self.__getattribute__(item)
 
     def __setattr__(self, item, value):
-        if item in ("_parent", "is_context_manager", "line_number_with_filename_and_parent", "save_traceback", "enter_time", "as_str", "_attributes"):
+        if item in ("_parent", "_is_context_manager", "_line_number_with_filename_and_parent", "_save_traceback", "_enter_time", "_as_str", "_attributes"):
             return super().__setattr__(item, value)
         self._attributes.update(spec_to_attributes({item: value}))
 
@@ -290,14 +276,14 @@ class _Peek:
         codes = {}
         this = self.fork(**kwargs)
 
-        this.as_str = as_str
+        this._as_str = as_str
         if len(args) != 0 and not this.do_show():
             if as_str:
                 return ""
             else:
                 return return_args(args, this.return_none)
 
-        self.is_context_manager = False
+        self._is_context_manager = False
 
         Pair = collections.namedtuple("Pair", "left right")
 
@@ -340,7 +326,7 @@ class _Peek:
             frame_info = inspect.getframeinfo(call_frame, context=1)
 
             #            parent_function = frame_info.function
-            parent_function = Source.executing(call_frame).code_qualname()  # changed in version 1.3.10 to include class name
+            parent_function = executing.Source.executing(call_frame).code_qualname()  # changed in version 1.3.10 to include class name
             parent_function = parent_function.replace(".<locals>.", ".")
             if parent_function == "<module>" or str(this.show_line_number) in ("n", "no parent"):
                 parent_function = ""
@@ -365,7 +351,7 @@ class _Peek:
                     break
             else:
                 line_number += 1
-            this.line_number_with_filename_and_parent = f"#{line_number}{filename_name}{parent_function}"
+            this._line_number_with_filename_and_parent = f"#{line_number}{filename_name}{parent_function}"
 
             def real_decorator(function):
                 @functools.wraps(function)
@@ -395,15 +381,15 @@ class _Peek:
             return real_decorator
 
         if filename in ("<stdin>", "<string>"):
-            this.line_number_with_filename_and_parent = ""
+            this._line_number_with_filename_and_parent = ""
         else:
-            call_node = Source.executing(call_frame).node
+            call_node = executing.Source.executing(call_frame).node
             if call_node is None:
                 no_source_error()
             line_number = call_node.lineno
             this_line = code[line_number - 1].strip()
 
-            this.line_number_with_filename_and_parent = f"#{line_number}{filename_name}{parent_function}"
+            this._line_number_with_filename_and_parent = f"#{line_number}{filename_name}{parent_function}"
 
         if this_line.startswith("with ") or this_line.startswith("with\t"):
             if as_str:
@@ -411,7 +397,7 @@ class _Peek:
             if args:
                 raise TypeError("non-keyword arguments are not allowed when peek used as context manager")
 
-            this.is_context_manager = True
+            this._is_context_manager = True
             return this
 
         if not this.do_show():
@@ -426,7 +412,7 @@ class _Peek:
                 for right in args:
                     pairs.append(Pair(left="", right=right))
             else:
-                source = Source.for_frame(call_frame)
+                source = executing.Source.for_frame(call_frame)
                 for node, right in zip(call_node.args, args):
                     left = source.asttokens().get_text(node)
                     if "\n" in left:
@@ -456,6 +442,7 @@ class _Peek:
             if not (len(pairs) > 1 and this.separator == ""):
                 if not any("\n" in pair.left for pair in pairs):
                     as_one_line = context + this.separator.join(pair.left + this.serialize_kwargs(obj=pair.right, width=10000) for pair in pairs)
+                    #                    as_one_line = context + this.separator.join(pair.left + (this.serialize_kwargs(obj=pair.right, width=10000)) for pair in pairs)
                     if len(as_one_line) <= this.line_length and "\n" not in as_one_line:
                         out = as_one_line
                         just_one_line = True
@@ -531,25 +518,25 @@ class _Peek:
         self._attributes = save
 
     def __enter__(self):
-        if not hasattr(self, "is_context_manager"):
+        if not hasattr(self, "_is_context_manager"):
             raise ValueError("not allowed as context_manager")
-        self.save_traceback = self.traceback()
-        self.enter_time = perf_counter()
+        self._save_traceback = self.traceback()
+        self._enter_time = perf_counter()
         if self.show_enter:
             context = self.context()
-            self.do_output(context + "enter" + self.save_traceback)
+            self.do_output(context + "enter" + self._save_traceback)
         return self
 
     def __exit__(self, *args):
         if self.show_exit:
             context = self.context()
-            duration = perf_counter() - self.enter_time
-            self.do_output(f"{context}exit in {duration:.6f} seconds{self.save_traceback}")
-        self.is_context_manager = False
+            duration = perf_counter() - self._enter_time
+            self.do_output(f"{context}exit in {duration:.6f} seconds{self._save_traceback}")
+        self._is_context_manager = False
 
     def context(self, omit_context_separator=False):
-        if self.show_line_number and self.line_number_with_filename_and_parent != "":
-            parts = [self.line_number_with_filename_and_parent]
+        if self.show_line_number and self._line_number_with_filename_and_parent != "":
+            parts = [self._line_number_with_filename_and_parent]
         else:
             parts = []
         if self.show_time:
@@ -565,7 +552,7 @@ class _Peek:
         return str(self.prefix() if callable(self.prefix) else self.prefix) + context
 
     def add_color_value(self, s):
-        if self.output != "stdout" or self.as_str:
+        if self.output != "stdout" or self._as_str:
             return s
         if self.color_value.lower() not in (self.color.lower(), ""):
             return colors[self.color_value.lower()] + s + colors[self.color.lower()]
@@ -646,8 +633,9 @@ class _Peek:
             return ""
 
     def serialize_kwargs(self, obj, width):
-        if isinstance(obj, str) and not self.quote_string:
-            return self.add_color_value(obj)
+        if isinstance(obj, str):
+            if not self.quote_string:
+                return str(self.add_color_value(obj))
         kwargs = {
             key: getattr(self, key)
             for key in ("sort_dicts", "compact", "indent", "depth", "underscore_numbers")
@@ -705,6 +693,7 @@ in_read_toml_message = ""
 peek = peek_toml.new()
 builtins.peek = peek
 
+
 class PeekModule(types.ModuleType):
     def __call__(self, *args, **kwargs):
         return peek(*args, **kwargs)
@@ -724,4 +713,3 @@ class PeekModule(types.ModuleType):
 
 if __name__ != "__main__":
     sys.modules["peek"].__class__ = PeekModule
-

{peek_python-24.0.1 → peek_python-24.0.2}/peek_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.1
+Version: 24.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
@@ -18,8 +18,7 @@ Requires-Dist: pyperclip>=1.9.0
 Requires-Dist: six>=1.17.0
 Requires-Dist: tomli>=2.2.1
 
-- [ ]  <img src="https://www.salabim.org/peek/peek_logo1.png">
-
+ <img src="https://www.salabim.org/peek/peek_logo1.png">
 
 # Introduction
 
@@ -49,7 +48,9 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using filter to control peek output](#Using-filter-to-control-peek-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)
 
 * [Copying to the clipboard](#Copying-to-the-clipboard)
 
@@ -63,14 +64,12 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Using peek in a REPL](#using-peek-in-a-repl)
 
-* [Alternative to `peek`](#alternative-to-peek)
-
 * [Limitations](#limitations)
 
-* [Acknowledgement](#acknowledgement)
-
 * [Changelog](#changelog)
 
+* [Acknowledgement](#acknowledgement)
+
 * [Differences with IceCream](#differences-with-icecream)
 
 
@@ -85,9 +84,10 @@ or when you want to upgrade,
 pip install peek-python --upgrade
 ```
 
-Alternatively, peek.py can be just copied into you current work directory from GitHub (https://github.com/salabim/peek).
+Alternatively, peek.py can be just copied into you current work directory from GitHub
+(https://github.com/salabim/peek).
 
-Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed with pip.
+Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed.
 
 # Importing peek
 
@@ -103,9 +103,8 @@ import peek
 from peek import peek
 ```
 
-> [!NOTE]
->
-> After this, `peek` is automatically a builtin and can thus be used in any module without importing it there.
+Note that after this, `peek` is automatically a builtin and can thus be used in any module without
+importing it there.
 
 # Inspect variables and expressions
 
@@ -155,7 +154,7 @@ prints
 ```
 world={"EN": "world ", "NL": "wereld", "FR": "monde", "DE": "Welt"}, X.a: 3
 ```
-Just give `peek()` a variable or expression and you're done. Easy, or what?
+Just give `peek()` a variable or expression and you're done.
 
 
 # Inspect execution
@@ -189,8 +188,6 @@ prints something like
 #5 in add2()
 add2(1000)=1002
 ```
-Just call `peek()` and you're done. Isn't that easy?
-
 
 # Return Value
 
@@ -322,9 +319,9 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value             col_val         "-"
-context_separator       cs              " ==> "
+color_value				col_val	        "-"
 compact                 -               False
+context_separator       cs              " ==> "
 depth                   -               1000000
 delta                   -               0
 enabled                 -               True
@@ -348,10 +345,10 @@ show_time               st              False
 show_traceback          -               False
 sort_dicts              -               False
 to_clipboard            clip            False
-underscore_numbers      un              False
-wrap_indent             -               "     "   
+underscore_numbers      un              False   
 values_only             vo              False
 value_only_for_fstrings voff            False 
+wrap_indent             -               "     "
 ------------------------------------------------------
 ```
 It is perfectly ok to set/get any of these attributes directly, like
@@ -362,7 +359,6 @@ print(peek.prefix)
 
 But, it is also possible to apply configuration directly, only here, in the call to `peek`:
 So, it is possible to say
-
 ```
 peek(12, prefix="==> ")
 ```
@@ -370,23 +366,25 @@ peek(12, prefix="==> ")
 ```
 ==> 12
 ```
-It is also possible to configure peek permanently with the configure method. 
+It is also possible to configure several attributes permanently with the configure method. 
 ```
-peek.configure(prefix="==> ")
+peek.configure(prefix="==> ", color="blue")
 peek(12)
 ```
-will print
+will print in blue
 ```
 ==> 12
 ```
 It is arguably easier to say:
 ```
 peek.prefix = "==> "
+peek.color = "blue"
 peek(12)
 ```
 or even
 ```
 peek.pr = "==> "
+peek.col = "blue"
 peek(12)
 ```
 to print
@@ -395,7 +393,7 @@ to print
 ```
 Yet another way to configure peek is to get a new instance of peek with peek.new() and the required configuration:
 ```
-z = peek.new(prefix="==> ")
+z = peek.new(prefix="==> ", color="blue")
 z(12)
 ```
 will print
@@ -620,7 +618,7 @@ prints
 The `show_traceback` functionality is also available when peek is used as a decorator or context manager. 
 
 ## line_length / ll
-This attribute is used to specify the line length (for wrapping). The default is 160.
+This attribute is used to specify the line length (for wrapping). The default is 80.
 Peek tries to keep all output on one line, but if it can't it will wrap:
 
 ```
@@ -637,7 +635,7 @@ d=
      'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
 ```
 
-## color / col and color_value / col_val
+## color / col and color_value / colv
 The color attribute is used to specify the color of the output.
 There's a choice of black, white, red, green, blue, cyan, magenta and yellow.
 To set the color to 'nothing', use "-".
@@ -665,7 +663,7 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 >
 > The color and color_value attributes are only applied when using stdout as output.
 > 
-> Colors can be ignored completely by using `peek.output = "stdout_nocolor"`.
+> Colors can be ignored completely by using `peek.output = "stdout_nocolor`.
 
 ## compact
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -818,6 +816,8 @@ numbers={'one': 1, 'thousand': 1_000, 'million': 1_000_000, 'x1234567890': 1_234
 numbers={'one': 1, 'thousand': 1000, 'million': 1000000, 'x1234567890': 1234567890}
 ```
 
+Note that under Python <=3.7, numbers are never underscored.
+
 ## seperator / sep
 
 By default, pairs (on one line) are separated by `, `.
@@ -836,7 +836,6 @@ prints
 a='abcd', (b,c)=(1, 1000), d=['peek', 'c', 'e', 'c', 'r', 'e', 'a', 'm']
 a='abcd' | (b,c)=(1, 1000) | d=['peek', 'c', 'e', 'c', 'r', 'e', 'a', 'm']
 ```
-Note that under Python <=3.7, numbers are never printed with underscores.
 
 ## context_separator
 
@@ -909,14 +908,15 @@ If True, the left_hand side will be suppressed in case of an f-string:
 
 ```
 x = 12.3
-peek(f"{x:0.3e}")
+peek.quote_string = False
+peek(f"{x=:0.3e}")
 peek.values_only_for_fstrings = True
-peek(f"{x:0.3e}")
+peek(f"{x=:0.3e}")
 ```
 prints
 ```
-f"{x:0.3e}"='1.230e+01'
-'1.230e+01'
+f"{x=:0.3e}"=x=1.230e+01
+x=1.230e+01
 ```
 Note that if `values_only` is True, f-string will be suppressed, regardless of `values_only_for_fstrings`.
 
@@ -990,7 +990,7 @@ delta=0.011826 ==> 2
 delta=0.044893 ==> 6
 True
 ```
-Of course `peek()` continues to return its arguments when disabled, of course.
+Of course `peek()` continues to return its arguments when disabled.
 
 It is also possible to suppress output with the provided attribute (see above).
 
@@ -1014,7 +1014,7 @@ It is possible to use more than one attribute, like
 ```
 peek.filter = "color == 'blue' and delta > 5"
 ```
-As an alternative to `enabled` we can also say
+As an alternative to `enabled` we can alo say
 ```
 peek.filter = "False"
 ```
@@ -1023,7 +1023,7 @@ peek.filter = "False"
 
 It is possible to copy a value to the clipboard. There are two ways:
 
-### With peek(*args, to_clipboard=True)
+### With peek(to_clipboard=True)
 
 With the optional keyword argument, *to_clipboard*:
 
@@ -1089,22 +1089,22 @@ The parent function can be suppressed by setting `show_line_number` or `sln` to
 
 It can be useful to configure peek at import time. This can be done by providing a `peek.toml` file which
 can contain any attribute configuration overriding the standard settings.
-E.g. if there is an `peek.toml` file with the following contents
+E.g. if there is a `peek.toml` file with the following contents
 
 ```
 outpout = "stderr"
 show_time = true
 ll = 160
-compact = true
+quote_string = false
 ```
 in the same folder as the application, this program:
 ```
 hello = "world"
 peek(hello)
 ```
-will print to stderr (rather than stdout):
+will print something like this to stderr (rather than stdout):
 ```
-@ 14:53:41.392190 ==> hello='world'
+@ 14:53:41.392190 ==> hello=world
 ```
 At import time current directory will be searched for `peek.toml` and if not found, one level up, etc. until the root directory is reached.
 
@@ -1136,15 +1136,14 @@ Normally, only the `peek` object is used.
 It can be useful to have multiple instances, e.g. when some of the debugging has to be done with context information
 and others requires an alternative prefix.
 
-There are several ways to obtain a new instance of peek:
+THere are several ways to obtain a new instance of peek:
 
 *    by using `peek.new()`
      
      With this a new peek object is created with the default attributes
-     and possibly peek.toml overrides.
 *    by using `peek.new(ignore_toml=True)`
 
-     With this a new peek object is created with the default attributes. Any peek.toml files are ignored.
+     With this a new peekobject is created with the default attibutes. Any peek.toml files are ignored.
 *    by using `peek.fork()`
      
      With this a new peek object is created with the same attributes as the object it is created ('the parent') from. Note that any non set attributes are copied (propagated) from the parent.
@@ -1232,15 +1231,9 @@ Peek may be used in a REPL, but with limited functionality:
 * use as a decorator is not supported
 * use as a context manager is not supported
 
-# Alternative to `peek`
-
-Sometimes, even peek is too long during a debug session or it is not suitable to use the name peek.
-
-In that case, it is possible to use p instead
-```
-from peek import p
-```
-The `p` object is a *fork* of peek. That means that attributes of `peek` are propagated to `p`, unless overridden.
+> [!NOTE]
+>
+> Under Python >=3.13 most of the normal peek functionality is available in the REPL. A reason to upgrade!
 
 
 # Limitations
@@ -1259,12 +1252,11 @@ The changelog can be found here:
 
 # Acknowledgement
 
-The **peek** package is inspired by the **IceCream** package, but is a 
-nearly complete rewrite. See https://github.com/gruns/icecream
+The **peek** package is inspired by the **IceCream** package, but is a nearly complete rewrite. See https://github.com/gruns/icecream
 
 Many thanks to the author Ansgar Grunseid / grunseid.com / grunseid@gmail.com .
 
-The peek package is a rebrand of the **ycecream** package, with enhancements.
+The peek package is a rebrand of the **ycecream** package, with many enhancements.
 
 # Differences with IceCream
 
@@ -1299,7 +1291,7 @@ colorize ***)                     yes, off by default         yes, on by default
 -----------------------------------------------------------------------------------------
 *)   under Python <= 3.7, dicts are always sorted
 **)  under Python <= 3.7, numbers are never underscored
-***) peek allows selection of a color, whereas IceCream does coloring based on contents
+***) peek allows selection of colors, whereas IceCream does coloring based on contents.
 
 ```
 ![PyPI](https://img.shields.io/pypi/v/peek-python) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/peek-python) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/peek)

{peek_python-24.0.1 → peek_python-24.0.2}/pyproject.toml

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