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

{peek_python-24.0.4 → peek_python-24.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.4
+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,7 +44,7 @@ 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)
+* [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)
 
@@ -335,6 +335,7 @@ level                   lvl             0
 line_length             ll              80
 output                  -               "stdout"
 prefix                  pr              ""
+print_like              print           False
 quote_string			qs				True
 return_none             -               False
 separator               sep             ", "
@@ -921,7 +922,9 @@ 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:
 
@@ -972,16 +975,35 @@ 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`.
+## 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.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)
+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
@@ -990,9 +1012,9 @@ will print
 min(1, 2)=1
   ```
 
-in red.
+in red, but only if peek.enabled is True (which is the default).
 
-The `peek.print`() method applies the prefix and end attributes to the ouput.
+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
@@ -1019,10 +1041,9 @@ 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`.
+> `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
 
@@ -1087,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"
 ```
@@ -1209,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.
@@ -1346,7 +1367,7 @@ 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
+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

{peek_python-24.0.4 → peek_python-24.0.5}/README.md

@@ -24,7 +24,7 @@ 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)
+* [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)
 
@@ -315,6 +315,7 @@ level                   lvl             0
 line_length             ll              80
 output                  -               "stdout"
 prefix                  pr              ""
+print_like              print           False
 quote_string			qs				True
 return_none             -               False
 separator               sep             ", "
@@ -901,7 +902,9 @@ 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:
 
@@ -952,16 +955,35 @@ 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`.
+## 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.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)
+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
@@ -970,9 +992,9 @@ will print
 min(1, 2)=1
   ```
 
-in red.
+in red, but only if peek.enabled is True (which is the default).
 
-The `peek.print`() method applies the prefix and end attributes to the ouput.
+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
@@ -999,10 +1021,9 @@ 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`.
+> `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
 
@@ -1067,7 +1088,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"
 ```
@@ -1189,14 +1210,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.
@@ -1326,7 +1347,7 @@ 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
+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

{peek_python-24.0.4 → peek_python-24.0.5}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "24.0.4"
+__version__ = "24.0.5"
 
 """
 See https://github.com/salabim/peek for details
@@ -284,33 +284,33 @@ class _Peek:
         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"]
+        print_like=True
+        if "print" in kwargs and "print_like" in kwargs:
+            raise AttributeError("both print_like and print specified")
+        print_like=kwargs.get["print_like", print_like]
+        print_like=kwargs.get["print", print_like]
+        kwargs["print_like"]=print_like
+        return self(*args, as_str=as_str, **kwargs)
 
+    def __call__(self, *args, as_str=False, **kwargs):
         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))
+        this._as_str = as_str
 
-        if as_str:
-            return s + this.end
+        if this.print_like:
+            if "sep" in kwargs or "separator" in kwargs:
+                if "sepp" in kwargs or "separator_print" in kwargs:
+                    raise AttributeError("both separator and separator_print specified")
+                this.separator_print = this.separator
 
-        this.do_output(s)
+            this.values_only = True
+            this.show_enter = False
+            this.show_exit = False
+            this.show_traceback = False
+            this.to_clipboard = False
+            this.return_none = True
+            args = [this.separator_print.join(map(str, args))]
 
-    def __call__(self, *args, as_str=False, **kwargs):
-        this = self.fork(**kwargs)
-
-        this._as_str = as_str
         if len(args) != 0 and not this.do_show():
             if as_str:
                 return ""
@@ -375,7 +375,7 @@ class _Peek:
                 this_line_prev = code[line_number - 2].strip()
             else:
                 this_line_prev = ""
-        if this_line.startswith("@") or this_line_prev.startswith("@"):
+        if (this_line.startswith("@") or this_line_prev.startswith("@")) and (this.show_enter or this.show_exit):
             if as_str:
                 raise TypeError("as_str may not be True when peek used as decorator")
 
@@ -425,7 +425,7 @@ class _Peek:
 
             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 (this_line.startswith("with ") or this_line.startswith("with\t")) and (this.show_enter or this.show_exit):
             if as_str:
                 raise TypeError("as_str may not be True when peek used as context manager")
             if args:
@@ -566,8 +566,8 @@ class _Peek:
             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 != "":
+    def context(self, omit_line_number=False, omit_context_separator=False):
+        if not omit_line_number and self.show_line_number and self._line_number_with_filename_and_parent != "":
             parts = [self._line_number_with_filename_and_parent]
         else:
             parts = []
@@ -674,6 +674,7 @@ class _Peek:
 
 store_perf_counter = perf_counter()
 name_alias_default = (
+    # name, alias, default value
     ("color", "col", "-"),
     ("color_value", "col_val", ""),
     ("compact", "", False),
@@ -689,6 +690,7 @@ name_alias_default = (
     ("line_length", "ll", 80),
     ("output", "", "stdout"),
     ("prefix", "pr", ""),
+    ("print_like", "print", False),
     ("quote_string", "qs", True),
     ("return_none", "", False),
     ("separator", "sep", ", "),
@@ -708,6 +710,7 @@ name_alias_default = (
     ("wrap_indent", "", "    "),
 )
 alias_name = {alias: name for (name, alias, default) in name_alias_default if alias}
+name_alias = {name: alias for (name, alias, default) in name_alias_default}
 name_default = {name: default for (name, alias, default) in name_alias_default}
 alias_default = {alias: default for (name, alias, default) in name_alias_default if alias}
 name_and_alias_default = {**name_default, **alias_default}
@@ -739,3 +742,4 @@ class PeekModule(types.ModuleType):
 
 if __name__ != "__main__":
     sys.modules["peek"].__class__ = PeekModule
+

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.4
+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,7 +44,7 @@ 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)
+* [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)
 
@@ -335,6 +335,7 @@ level                   lvl             0
 line_length             ll              80
 output                  -               "stdout"
 prefix                  pr              ""
+print_like              print           False
 quote_string			qs				True
 return_none             -               False
 separator               sep             ", "
@@ -921,7 +922,9 @@ 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:
 
@@ -972,16 +975,35 @@ 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`.
+## 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.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)
+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
@@ -990,9 +1012,9 @@ will print
 min(1, 2)=1
   ```
 
-in red.
+in red, but only if peek.enabled is True (which is the default).
 
-The `peek.print`() method applies the prefix and end attributes to the ouput.
+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
@@ -1019,10 +1041,9 @@ 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`.
+> `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
 
@@ -1087,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"
 ```
@@ -1209,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.
@@ -1346,7 +1367,7 @@ 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
+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

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

{peek_python-24.0.4 → peek_python-24.0.5}/tests/test_peek.py

@@ -301,9 +301,23 @@ def test_print(capsys):
 2
 """
     )
+    result=peek.print(1,2,as_str=True)
+    assert result=="1 2\n"
+
+    result=peek.print(1,2)
+    assert result is None
+
+
     with pytest.raises(AttributeError):
         peek.print(sep="|", sepp="/")   
 
+    with pytest.raises(AttributeError):
+        peek.print(line_length=120)   
+
+    with pytest.raises(AttributeError):
+        peek.print(line_length=120)   
+
+
 def test_clone():
     hello = "world"
     z = peek.clone()