peek-python 24.0.3__tar.gz → 24.0.5__tar.gz

{peek_python-24.0.3/peek_python.egg-info → peek_python-24.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.3
+Version: 24.0.5
 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
@@ -44,6 +44,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Configuration](#configuration)
 
+* [Use peek.print to use peek like print with extras](#use-peek.print-to-to use peek like-with-extras)
+
 * [Return a string instead of sending to output](#return-a-string-instead-of-sending-to-output)
 
 * [Disabling peek's output](#disabling-peeks-output)
@@ -325,7 +327,7 @@ context_separator       cs              " ==> "
 depth                   -               1000000
 delta                   -               0
 enabled                 -               True
-enforce_line_length     -               False
+end						-				"\n"
 equals_separator        -               "="
 filter                  f               ""
 indent                  -               1
@@ -333,9 +335,11 @@ level                   lvl             0
 line_length             ll              80
 output                  -               "stdout"
 prefix                  pr              ""
+print_like              print           False
 quote_string			qs				True
 return_none             -               False
 separator               sep             ", "
+separator_print         sepp            "" "
 serialize               -               pprint.pformat
 show_delta              sd              False
 show_enter              se              True
@@ -820,7 +824,7 @@ Note that under Python <=3.7, numbers are never underscored.
 
 ## seperator / sep
 
-By default, pairs (on one line) are separated by `, `.
+By default, pairs (on one line) are separated by `", ""`.
 It is possible to change this with the attribute ` separator`:
 
 ```
@@ -833,8 +837,8 @@ peek(a, (b, c), d, separator=" | ")
 ```
 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']
+a='abcd', (b,c)=(1, 1000), d=['p', 'e', 'e', 'k']
+a='abcd' | (b,c)=(1, 1000) | d=['p', 'e', 'e', 'k']
 ```
 
 ## context_separator
@@ -898,8 +902,6 @@ prints
 hello='world', 2 * hello='worldworld'
 'world', 'worldworld'
 ```
-The values=True version of peek can be seen as a supercharged print/pprint.
-
 
 ## values_only_for_fstrings / voff
 If False (the default), both the original f-string and the
@@ -920,6 +922,31 @@ x=1.230e+01
 ```
 Note that if `values_only` is True, f-string will be suppressed, regardless of `values_only_for_fstrings`.
 
+
+## end
+
+The `end` attribute works like the end parameter of print. By default, `end` is "\n".
+This can be useful to have several peek outputs on one line, like:
+
+```
+for i in range(5):
+    peek(i*i, end=' ')
+peek('')
+```
+Maybe more useful is to show the output change on the same line, e.g. a status.
+```
+import time
+for i in range(50):
+  peek(f"time {time.time()}",end="\r")
+  time.sleep(0.1)
+peek('')
+```
+The `end` parameter will be only applied when output is stdout, stdout_nocolor or stderr.
+
+> [!NOTE]
+>
+> `\r` does not work under Pythonista.
+
 ## return_none
 Normally, `peek()`returns the values passed directly, which is usually fine. However, when used in a notebook
 or REPL, that value will be shown, and that can be annoying. Therefore, if `return_none`is True, `peek()`will
@@ -940,9 +967,6 @@ a=3, b=4
 None
 ```
 
-## enforce_line_length
-If enforce_line_length is True, all output lines are explicitly truncated to the given line_length, even those that are not truncated by pformat.
-
 ## delta
 The delta attribute can be used to (re)set the current delta, e.g.
 ```
@@ -951,6 +975,76 @@ print(peek.delta)
 ```
 prints a value that id slightly more than 0.
 
+## print_like / print
+When print_like (or print) is False, peek will work by expanding the arguments to description/serialized value pairs.
+But, when print_like is True, peek becomes a kind of supercharged print:
+
+```
+peek.print_like = True
+peek(12, f"{min(1, 2)=}", list(range(4), color="yellow")
+```
+will print
+```
+12 min(1, 2)=1 [0, 1, 2, 3]
+```
+in yellow, but only if peek.enabled is False, nothing will be printed.
+
+You can also use peek.print (see below).
+
+> [!TIP]
+>
+> Of course, print_only can be put in a **peek.toml** file.
+
+# Use peek.print to use peek like print with extras
+The method `peek.print` allows peek to be used as alternative to print. Note that `peek.print` applies the `color`, `context_separator`, `enabled`, `filter` and `output`, `show_delta` and `show_time`. It is also possible to redirect the output to as string with `as_str`.
+
+So,
+
+```
+peek.filter = "level==1"
+peek.print(f"{max(1, 2)=}", color="blue")  # default level is 0, so this will be suppressed
+peek.print(f"{min(1, 2)=}", color="red",level=1)
+```
+
+will print
+
+  ```
+min(1, 2)=1
+  ```
+
+in red, but only if peek.enabled is True (which is the default).
+
+The `peek.print`() method applies the prefix, show_delta, show_line_number, show_time, show_ end attributes to the output.
+
+In order to behave similar to print, `peek` has an extra attribute, `separator_print` (alias: `sepp`). This attribute (default " ") will be used when `peek.printing`.
+When calling `peek.print`, `sep` may be used instead. So
+
+```
+peek.sepp = "|"
+peek.print("test")
+```
+
+Has the same effect as
+
+```
+peek.print("test", sep="|")
+```
+
+and
+
+```
+peek.print("test", sepp="|")
+```
+
+but not the same as
+
+```
+peek.sep = "|"  # sets the 'normal' peek separator
+```
+> [!NOTE]
+>
+> `peek.print` does not obey the line length and will always return None (unless as_str is True). 
+
 # 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
@@ -1014,7 +1108,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 alo say
+As an alternative to `enabled` we can also say
 ```
 peek.filter = "False"
 ```
@@ -1136,14 +1230,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
 *    by using `peek.new(ignore_toml=True)`
 
-     With this a new peekobject is created with the default attibutes. Any peek.toml files are ignored.
+     With this a new peekobject is created with the default attributes. 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.
@@ -1273,6 +1367,8 @@ usable without installation       yes                         no
 can be used as a decorator        yes                         no
 can be used as a context manager  yes                         no
 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
 sorts dicts                       no by default, optional *)  yes
 supports compact, indent,