peek-python 24.0.2.post2__tar.gz → 24.0.4__tar.gz

{peek_python-24.0.2.post2 → peek_python-24.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.2.post2
+Version: 24.0.4
 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 mimic print with extras](#use-peek.print-to-mimic-print-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
@@ -336,6 +338,7 @@ prefix                  pr              ""
 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 +823,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 +836,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 +901,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 +921,29 @@ 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 +964,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 +972,58 @@ print(peek.delta)
 ```
 prints a value that id slightly more than 0.
 
+# Use peek.print to mimic print with extras
+The method `peek.print` allows peek to be used as alternative to print. Note that `peek.print` obeys the `color`, `enabled`, `filter` and `output`. It is also possible to redirect the output to as stringg with `as_str`.
+
+So,
+
+```
+peek.color = "red"
+peek.filter = "level==1"
+peek.print(f"{max(1, 2)=}")  # default level is 0, so this will be suppressed
+peek.print(f"{min(1, 2)=}", level=1)
+```
+
+will print
+
+  ```
+min(1, 2)=1
+  ```
+
+in red.
+
+The `peek.print`() method applies the prefix and end attributes to the ouput.
+
+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]
+>
+> The value of the attributes `color_value`, `compact`, `context_separator`, `depth`, `delta`,  `equals_separator`, `indent`, `line_length`, `quote_string`, `return_none`, `serialize`, `show_delta`, `show_enter`, `show_exit`, `show_time`, `show_traceback`, `sort_dicts`, `to_clipboard`,  `underscore_numbers`, `values_only`, `values_only_for_fstrings` are ignored when using `peek.print`.
+
 # 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
@@ -1273,6 +1346,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
+mimics print() with extras        yes (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,

{peek_python-24.0.2.post2 → peek_python-24.0.4}/README.md

@@ -24,6 +24,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Configuration](#configuration)
 
+* [Use peek.print to mimic print with extras](#use-peek.print-to-mimic-print-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)
@@ -305,7 +307,7 @@ context_separator       cs              " ==> "
 depth                   -               1000000
 delta                   -               0
 enabled                 -               True
-enforce_line_length     -               False
+end						-				"\n"
 equals_separator        -               "="
 filter                  f               ""
 indent                  -               1
@@ -316,6 +318,7 @@ prefix                  pr              ""
 quote_string			qs				True
 return_none             -               False
 separator               sep             ", "
+separator_print         sepp            "" "
 serialize               -               pprint.pformat
 show_delta              sd              False
 show_enter              se              True
@@ -800,7 +803,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`:
 
 ```
@@ -813,8 +816,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
@@ -878,8 +881,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
@@ -900,6 +901,29 @@ 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
@@ -920,9 +944,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.
 ```
@@ -931,6 +952,58 @@ print(peek.delta)
 ```
 prints a value that id slightly more than 0.
 
+# Use peek.print to mimic print with extras
+The method `peek.print` allows peek to be used as alternative to print. Note that `peek.print` obeys the `color`, `enabled`, `filter` and `output`. It is also possible to redirect the output to as stringg with `as_str`.
+
+So,
+
+```
+peek.color = "red"
+peek.filter = "level==1"
+peek.print(f"{max(1, 2)=}")  # default level is 0, so this will be suppressed
+peek.print(f"{min(1, 2)=}", level=1)
+```
+
+will print
+
+  ```
+min(1, 2)=1
+  ```
+
+in red.
+
+The `peek.print`() method applies the prefix and end attributes to the ouput.
+
+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]
+>
+> The value of the attributes `color_value`, `compact`, `context_separator`, `depth`, `delta`,  `equals_separator`, `indent`, `line_length`, `quote_string`, `return_none`, `serialize`, `show_delta`, `show_enter`, `show_exit`, `show_time`, `show_traceback`, `sort_dicts`, `to_clipboard`,  `underscore_numbers`, `values_only`, `values_only_for_fstrings` are ignored when using `peek.print`.
+
 # 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
@@ -1253,6 +1326,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
+mimics print() with extras        yes (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,

{peek_python-24.0.2.post2 → peek_python-24.0.4}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "24.0.2"
+__version__ = "24.0.4"
 
 """
 See https://github.com/salabim/peek for details
@@ -56,6 +56,7 @@ def perf_counter():
     return time.perf_counter() if _fixed_perf_counter is None else _fixed_perf_counter
 
 
+codes = {}
 colors = dict(
     black="\033[0;30m",
     red="\033[0;31m",
@@ -67,6 +68,7 @@ colors = dict(
     white="\033[0;37m",
 )
 colors["-"] = "\033[0m"
+colors[""] = "\033[0m"
 
 
 ansi_to_rgb = {
@@ -111,8 +113,6 @@ def check_validity(name, value):
             return
 
     if name in ("color", "color_value"):
-        if name == "color_value" and value == "":
-            return
         if isinstance(value, str) and value.lower() in colors:
             return
 
@@ -120,13 +120,6 @@ def check_validity(name, value):
             if isinstance(value, numbers.Number):
                 return
 
-    elif name == "enforce_line_length":
-        if value:
-            if isinstance(value, numbers.Number) and value > 0:
-                return
-        else:
-            return
-
     elif name == "line_length":
         if isinstance(value, numbers.Number) and value > 0:
             return
@@ -164,9 +157,11 @@ def check_validity(name, value):
 _fixed_perf_counter = None
 
 
-def spec_to_attributes(d):
+def spec_to_attributes(**kwargs):
     result = {}
-    for name, value in d.items():
+    for name, value in kwargs.items():
+        if alias_name.get(name, "") in kwargs:
+            raise AttributeError(f"not allowed to use {name} and {alias_name.get(name)} both.")
         check_validity(name, value)
         name = de_alias(name)
         if name == "delta" and value is not None:
@@ -188,6 +183,19 @@ def read_toml():
     return {}
 
 
+def print_pythonista_color(s, end="\n"):
+    while s:
+        for ansi, rgb in ansi_to_rgb.items():
+            if s.startswith(ansi):
+                console.set_color(*rgb)
+                s = s[len(ansi) :]
+                break
+        else:
+            print(s[0], end="")
+            s = s[1:]
+    print("", end=end)
+
+
 def no_source_error():
     raise NotImplementedError(
         """
@@ -210,7 +218,7 @@ def return_args(args, return_none):
 
 class _Peek:
     def __init__(self, parent=None, **kwargs):
-        self._attributes = spec_to_attributes(kwargs)
+        self._attributes = spec_to_attributes(**kwargs)
         self._parent = parent
 
     def new(self, ignore_toml=False, **kwargs):
@@ -224,11 +232,11 @@ class _Peek:
 
     def clone(self, **kwargs):
         clone = _Peek(parent=self._parent)
-        clone._attributes = {**self._attributes, **spec_to_attributes(kwargs)}
+        clone._attributes = {**self._attributes, **spec_to_attributes(**kwargs)}
         return clone
 
     def configure(self, **kwargs):
-        self._attributes.update(spec_to_attributes(kwargs))
+        self._attributes.update(spec_to_attributes(**kwargs))
 
     def __getattr__(self, item, spec=False):
         item = de_alias(item)
@@ -240,6 +248,9 @@ class _Peek:
                 return perf_counter() - node._attributes["perf_counter"] + node._attributes["delta"]
             elif item == "perf_counter":
                 return node._attributes["delta"]
+            elif item == "prefix":
+                prefix = node._attributes[item]
+                return str(prefix() if callable(prefix) else prefix)
             else:
                 return node._attributes[item]
         else:
@@ -248,7 +259,7 @@ class _Peek:
     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"):
             return super().__setattr__(item, value)
-        self._attributes.update(spec_to_attributes({item: value}))
+        self._attributes.update(spec_to_attributes(**{item: value}))
 
     def __repr__(self):
         pairs = [
@@ -272,8 +283,31 @@ class _Peek:
                 return False
         return self.enabled
 
+    def print(self, *args, as_str=False, **kwargs):
+        diff = {"sep", "separator", "sepp", "separator_print"} & set(kwargs)
+        if len(diff) >= 2:
+            raise AttributeError(f"multiple keyword for separator found: {diff}")
+        if "sep" in kwargs:
+            kwargs["separator_print"] = kwargs["sep"]
+        if "separator" in kwargs:
+            kwargs["separator_print"] = kwargs["separator"]
+
+        this = self.fork(**kwargs)
+
+        if not this.do_show():
+            if as_str:
+                return ""
+            else:
+                return return_args(args, this.return_none)
+
+        s = this.prefix + this.separator_print.join(map(str, args))
+
+        if as_str:
+            return s + this.end
+
+        this.do_output(s)
+
     def __call__(self, *args, as_str=False, **kwargs):
-        codes = {}
         this = self.fork(**kwargs)
 
         this._as_str = as_str
@@ -500,9 +534,7 @@ class _Peek:
 
         if as_str:
             if this.do_show():
-                if this.enforce_line_length:
-                    out = "\n".join(line[: this.line_length] for line in out.splitlines())
-                return out + "\n"
+                return out + this.end
             else:
                 return ""
         if this.to_clipboard:
@@ -549,7 +581,7 @@ class _Peek:
         if not omit_context_separator and context:
             context += self.context_separator
 
-        return str(self.prefix() if callable(self.prefix) else self.prefix) + context
+        return self.prefix + context
 
     def add_color_value(self, s):
         if self.output != "stdout" or self._as_str:
@@ -560,33 +592,26 @@ class _Peek:
             return s
 
     def do_output(self, s):
-        if self.enforce_line_length:
-            s = "\n".join(line[: self.line_length] for line in s.splitlines())
         if self.do_show():
             if callable(self.output):
-                self.output(s)
+                if self.output == builtins.print or "end" in inspect.signature(self.output).parameters:
+                    # test for builtins.print is required as for Python <= 3.10, builtins.print has no signature
+                    self.output(s, end=self.end)
+                else:
+                    self.output(s + self.end)
             elif self.output == "stderr":
-                print(s, file=sys.stderr)
+                print(s, file=sys.stderr, end=self.end)
             elif self.output == "stdout":
-                if self.color != "-" or self.color_value != "-":
-                    s = colors[self.color.lower()] + s + colors["-"]
+                if self.color not in ["", "-"]:
+                    s = colors[self.color.lower()] + s + self.end + colors["-"]
                     if Pythonista:
-                        while s:
-                            for ansi, rgb in ansi_to_rgb.items():
-                                if s.startswith(ansi):
-                                    console.set_color(*rgb)
-                                    s = s[len(ansi) :]
-                                    break
-                            else:
-                                print(s[0], end="")
-                                s = s[1:]
-                        print()
+                        print_pythonista_color(s, end="")
                     else:
-                        print(s)
+                        print(s, end="")
                 else:
-                    print(s)
+                    print(s, end=self.end)
             elif self.output == "stdout_nocolor":
-                print(s)
+                print(s, end=self.end)
             elif self.output == "logging.debug":
                 logging.debug(s)
             elif self.output == "logging.info":
@@ -601,12 +626,12 @@ class _Peek:
                 pass
             elif isinstance(self.output, str):
                 with open(self.output, "a+", encoding="utf-8") as f:
-                    print(s, file=f)
+                    print(s, file=f, end=self.end)
             elif isinstance(self.output, Path):
                 with self.output.open("a+", encoding="utf-8") as f:
-                    print(s, file=f)
+                    print(s, file=f, end=self.end)
             else:
-                print(s, file=self.output)
+                print(s, file=self.output, end=self.end)
 
     def copy_to_clipboard(self, value, confirm=True):
         if Pythonista:
@@ -656,7 +681,7 @@ name_alias_default = (
     ("delta", "", 0),
     ("depth", "", 1000000),
     ("enabled", "", True),
-    ("enforce_line_length", "", False),
+    ("end", "", "\n"),
     ("equals_separator", "", "="),
     ("filter", "f", ""),
     ("indent", "", 1),
@@ -667,6 +692,7 @@ name_alias_default = (
     ("quote_string", "qs", True),
     ("return_none", "", False),
     ("separator", "sep", ", "),
+    ("separator_print", "sepp", " "),
     ("serialize", "", pprint.pformat),
     ("show_delta", "sd", False),
     ("show_enter", "se", True),

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.2.post2
+Version: 24.0.4
 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 mimic print with extras](#use-peek.print-to-mimic-print-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
@@ -336,6 +338,7 @@ prefix                  pr              ""
 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 +823,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 +836,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 +901,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 +921,29 @@ 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 +964,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 +972,58 @@ print(peek.delta)
 ```
 prints a value that id slightly more than 0.
 
+# Use peek.print to mimic print with extras
+The method `peek.print` allows peek to be used as alternative to print. Note that `peek.print` obeys the `color`, `enabled`, `filter` and `output`. It is also possible to redirect the output to as stringg with `as_str`.
+
+So,
+
+```
+peek.color = "red"
+peek.filter = "level==1"
+peek.print(f"{max(1, 2)=}")  # default level is 0, so this will be suppressed
+peek.print(f"{min(1, 2)=}", level=1)
+```
+
+will print
+
+  ```
+min(1, 2)=1
+  ```
+
+in red.
+
+The `peek.print`() method applies the prefix and end attributes to the ouput.
+
+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]
+>
+> The value of the attributes `color_value`, `compact`, `context_separator`, `depth`, `delta`,  `equals_separator`, `indent`, `line_length`, `quote_string`, `return_none`, `serialize`, `show_delta`, `show_enter`, `show_exit`, `show_time`, `show_traceback`, `sort_dicts`, `to_clipboard`,  `underscore_numbers`, `values_only`, `values_only_for_fstrings` are ignored when using `peek.print`.
+
 # 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
@@ -1273,6 +1346,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
+mimics print() with extras        yes (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,

{peek_python-24.0.2.post2 → peek_python-24.0.4}/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 = "24.0.2.post2"
+version = "24.0.4"
 readme = "README.md"
 requires-python = ">=3.6"
 dependencies = [

{peek_python-24.0.2.post2 → peek_python-24.0.4}/tests/test_peek.py

@@ -15,9 +15,9 @@ sys.path.insert(0, file_folder + "/../peek")
 
 import peek
 
-import tempfile
 
-peek=peek.new(ignore_toml=True,output="stdout_nocolor")
+peek = peek.new(ignore_toml=True, output="stdout_nocolor")
+
 
 class g:
     pass
@@ -68,9 +68,11 @@ hello='world'
     )
     assert result == hello
 
+
 def test_illegal_assignment():
     with pytest.raises(AttributeError):
-        peek.colour = 'red'
+        peek.colour = "red"
+
 
 def test_two_arguments(capsys):
     hello = "world"
@@ -156,11 +158,22 @@ def test_calls():
         peek(a=1)
 
 
+def test_repr_and_str(capsys):
+    print(str(peek))
+    out, err = capsys.readouterr()
+    assert out.startswith("peek with attributes:")
+    assert out.endswith(")\n")
+
+    print(repr(peek))
+    out, err = capsys.readouterr()
+    assert out.startswith("peek.new(")
+    assert out.endswith(")\n")
+
 def test_output(capsys, tmpdir):
     g.result = ""
 
     def my_output(s):
-        g.result += s + "\n"
+        g.result += s
 
     hello = "world"
     peek(hello, output=print)
@@ -187,7 +200,6 @@ def test_output(capsys, tmpdir):
     out, err = capsys.readouterr()
     assert out == "hello='world'\n"
 
-
     path = Path(tmpdir) / "x0"
     peek(hello, output=path)
     out, err = capsys.readouterr()
@@ -235,38 +247,63 @@ def test_output(capsys, tmpdir):
         out, err = capsys.readouterr()
         assert out == "hello='world' [len=5]\n"
 
-    def test_show_time(capsys):
-        hello = "world"
-        peek(hello, show_time=True)
-        out, err = capsys.readouterr()
-        assert out.endswith("hello='world'\n")
-        assert "@ " in err
 
-    def test_show_delta(capsys):
-        hello = "world"
-        peek(hello, show_delta=True)
-        out, err = capsys.readouterr()
-        assert out.endswith("hello='world'\n")
-        assert "delta=" in err
+def test_show_time(capsys):
+    hello = "world"
+    peek(hello, show_time=True)
+    out, err = capsys.readouterr()
+    assert out.endswith("hello='world'\n")
+    assert "@ " in out
 
-    def test_as_str(capsys):
-        hello = "world"
-        s = peek(hello, as_str=True)
-        peek(hello)
-        out, err = capsys.readouterr()
-        assert out == s
 
-        with pytest.raises(TypeError):
+def test_show_delta(capsys):
+    hello = "world"
+    peek(hello, show_delta=True)
+    out, err = capsys.readouterr()
+    assert out.endswith("hello='world'\n")
+    assert "delta=" in out
+
 
-            @peek(as_str=True)
-            def add2(x):
-                return x + 2
+def test_as_str(capsys):
+    hello = "world"
+    s = peek(hello, as_str=True)
+    peek(hello)
+    out, err = capsys.readouterr()
+    assert out == s
 
-        with pytest.raises(TypeError):
-            with peek(as_str=True):
-                pass
+    with pytest.raises(TypeError):
+
+        @peek(as_str=True)
+        def add2(x):
+            return x + 2
+
+    with pytest.raises(TypeError):
+        with peek(as_str=True):
+            pass
 
 
+def test_print(capsys):
+    peek.print(*range(4))
+    peek.print(*range(4), sep="|")
+    peek.print(*range(4), end="END\n")
+    peek.filter = "1<=level<=2"
+    for i in range(4):
+        peek.print(i, level=i)
+    out, err = capsys.readouterr()
+    peek.filter = ""
+    assert (
+        out
+        == """\
+0 1 2 3
+0|1|2|3
+0 1 2 3END
+1
+2
+"""
+    )
+    with pytest.raises(AttributeError):
+        peek.print(sep="|", sepp="/")   
+
 def test_clone():
     hello = "world"
     z = peek.clone()
@@ -284,7 +321,8 @@ def test_sort_dicts():
     s1 = peek(world, sort_dicts=False, as_str=True)
     s2 = peek(world, sort_dicts=True, as_str=True)
     if sys.version_info >= (3, 8):
-        assert s0 == s1 == "world={'EN': 'world', 'NL': 'wereld', 'FR': 'monde', 'DE': 'Welt'}\n"
+        assert s0 == "world={'EN': 'world', 'NL': 'wereld', 'FR': 'monde', 'DE': 'Welt'}\n"
+        assert s1 == "world={'EN': 'world', 'NL': 'wereld', 'FR': 'monde', 'DE': 'Welt'}\n"
         assert s2 == "world={'DE': 'Welt', 'EN': 'world', 'FR': 'monde', 'NL': 'wereld'}\n"
     else:
         assert s0 == s1 == s2 == "world={'DE': 'Welt', 'EN': 'world', 'FR': 'monde', 'NL': 'wereld'}\n"
@@ -337,24 +375,27 @@ lines=
 """
     )
 
+
 def test_filter(capsys):
     def gen():
         for level, color in enumerate("- blue red green blue".split()):
             peek(level, level=level, color=color)
 
-    peek.filter="True"
+    peek.filter = "True"
     gen()
-    peek.filter="level >=2"
+    peek.filter = "level >=2"
     gen()
-    peek.filter="level >=2"
+    peek.filter = "level >=2"
     gen()
-    peek.filter="level >=2 and color=='blue'"
+    peek.filter = "level >=2 and color=='blue'"
     gen()
-    peek.filter=""
+    peek.filter = ""
     gen()
 
     out, err = capsys.readouterr()
-    assert out == """\
+    assert (
+        out
+        == """\
 level=0
 level=1
 level=2
@@ -372,26 +413,29 @@ level=1
 level=2
 level=3
 level=4
-""" 
+"""
+    )
+
 
 @pytest.mark.skipif(Pythonista, reason="Pythonista does not generate ansi codes")
 def test_color(capsys):
-    peek(10*10, output="stdout")
+    peek(10 * 10, output="stdout")
+    peek(10 * 10, color="red", output="stdout")
     out, err = capsys.readouterr()
-    assert out == '\x1b[0m10*10=100\x1b[0m\n'
+    assert out == "10 * 10=100\n\x1b[0;31m10 * 10=100\n\x1b[0m"
 
 
 def test_incorrect_filter():
     with pytest.raises(AttributeError):
-        peek.filter="color='blue'"
+        peek.filter = "color='blue'"
 
     with pytest.raises(AttributeError):
-        peek.filter="colour=='blue'"
+        peek.filter = "colour=='blue'"
+
 
 def test_decorator(capsys):
     peek.fix_perf_counter(0)
 
-
     @peek()
     def div(x, y):
         return x / y
@@ -486,6 +530,7 @@ called __mul__(Number(2), Number(3))
 """
         )
 
+
 @pytest.mark.skipif(Pythonista, reason="Pythonista problem")
 def test_context_manager(capsys):
     peek.fix_perf_counter(0)
@@ -762,40 +807,6 @@ def test_traceback(capsys):
         assert out.count("traceback") == 2
 
 
-@pytest.mark.skipif(Pythonista, reason="Pythonista problem")
-def test_enforce_line_length(capsys):
-    s = 80 * "*"
-    with peek.preserve():
-        peek.prefix = "peek| "
-        peek.line_length = 80
-        peek(s)
-        peek(s, enforce_line_length=True)
-    out, err = capsys.readouterr()
-    assert (
-        out
-        == """\
-peek|
-    s='********************************************************************************'
-peek|
-    s='*************************************************************************
-"""
-    )
-    with peek.preserve():
-        peek.configure(line_length=20, show_line_number=True)
-        peek()
-        out1, err = capsys.readouterr()
-        peek(enforce_line_length=True)
-        out2, err = capsys.readouterr()
-        out1 = out1.rstrip("\n")
-        out2 = out2.rstrip("\n")
-        assert len(out2) == 20
-        assert out1[10:20] == out2[10:20]
-        assert len(out1) > 20
-    res = peek("abcdefghijklmnopqrstuvwxyz", pr="", enforce_line_length=1, ll=20, as_str=True).rstrip("\n")
-    assert res == "'abcdefghijklmnopqrs"
-    assert len(res) == 20
-
-
 def test_check_output(capsys, tmpdir):
     """special Pythonista code, as that does not reload x1 and x2"""
     if "x1" in sys.modules:
@@ -893,6 +904,27 @@ def test():
 """
     )
 
+
+def test_prefix_variants(capsys):
+    n = 1
+    peek.prefix = lambda: f"{n:<2d}"
+    peek(10 * 10)
+    n = 2
+    peek(10 * 10)
+    peek.prefix = 1
+    peek(10 * 10)
+    out, err = capsys.readouterr()
+    assert (
+        out
+        == """\
+1 10 * 10=100
+2 10 * 10=100
+110 * 10=100
+"""
+    )
+    peek.prefix = ""
+
+
 def test_propagation():
     with peek.preserve():
         y0 = peek.fork()
@@ -956,6 +988,22 @@ def test_delta_propagation():
         assert 100 < y2.delta < 110
 
 
+def test_end(capsys):
+    a = 12
+    b = 4 * ["test"]
+    c = 1
+    peek(a, end=" ")
+    peek(b, end=" ")
+    peek(c)
+    out, err = capsys.readouterr()
+    assert (
+        out
+        == """\
+a=12 b=['test', 'test', 'test', 'test'] c=1
+"""
+    )
+
+
 def test_separator(capsys):
     a = 12
     b = 4 * ["test"]
@@ -992,7 +1040,6 @@ a = 12, b = ['test', 'test', 'test', 'test']
     )
 
 
-
 def test_context_separator(capsys):
     a = 12
     b = 2 * ["test"]
@@ -1081,4 +1128,3 @@ hello='world'
 
 if __name__ == "__main__":
     pytest.main(["-vv", "-s", "-x", __file__])
-