peek-python 1.8.4__tar.gz → 1.8.6.post0__tar.gz

{peek_python-1.8.4 → peek_python-1.8.6.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 1.8.4
+Version: 1.8.6.post0
 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
@@ -50,6 +50,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [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)
 
 * [Speeding up disabled peek](#speeding-up-disabled-peek)
@@ -340,8 +342,8 @@ sort_dicts              sdi             False
 underscore_numbers      un              False
 enabled                 e               True
 line_length             ll              160
-color                   col             ""
-color_value				colv			""
+color                   col             "-"
+color_value				colv			"-"
 level                   l               0
 compact                 c               False
 indent                  i               1
@@ -480,6 +482,7 @@ Finally, you can specify the following strings:
 ```
 "stderr"           to print to stderr
 "stdout"           to print to stdout
+"stdout_nocolor"   to print to stdout without any colors
 "null" or ""       to completely ignore (dummy) output 
 "logging.debug"    to use logging.debug
 "logging.info"     to use logging.info
@@ -639,9 +642,9 @@ d=
 ```
 
 ## color / col and color_value / colv
-The color attribute is used to specify the colour of the output.
+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 the null string ("").
+To set the color to 'nothing', use "-".
 
 On top of that, color_value may be used to specify the value part of an output item. By specifying color_value as "" (the default), the value part will be displayed with the same color as the rest of the output.
 
@@ -665,6 +668,8 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 > [!NOTE]
 >
 > 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"
 
 ## compact / c
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -1098,7 +1103,30 @@ Examples:
 
 This will print one line with`1` only.
 
+# Using color to control peek output
+
+The method `peek.show_color()` can be used to show only peek output for certain colors.
+
+For instance, with `peek.show_color("blue red")`, subsequent peek commands will print only if the color is *blue* or *red*. 
+With `peek.show_color("-")` only not colored output will be shown.
+
+It is also possible to specify which colors *not* to show. E.g. `peek.show_color("not green yellow"` will show all peeks apart from those in green or yellow. With `peek.show_color("not -")` only colored peeks will be shown.
+
+With `peek.show_color()` the current value can be queried.
+
+Finally, `peek.show_color()` can be used as a context manager:
+```
+with peek.show_color("blue red"):
+    peek(1, color="blue")
+    peek(2)
+peek(3)
+```
+This will print 1 and 3.
+
+It is possible to use both `peek.show_level()` and `peek.show_color()` at the same time, but this might be confusing.
+
 # Copying to the clipboard
+
 It is possible to copy a value to the clipboard. There are two ways:
 
 ### With peek(*args, to_clipboard=True)
@@ -1365,11 +1393,11 @@ suppress f-strings at left hand   optional                    no
 indentation                       4 blanks (overridable)      dependent on length of prefix
 forking and cloning               yes                         no
 test script                       pytest                      unittest
-colourize ***)                    yes, off by default         yes, on by default
+colorize ***)                    yes, off by default         yes, on by default
 -------------------------------------------------------------------------------------------
 *)   under Python <= 3.7, dicts are always sorted (regardless of the sort_dicts attribute
 **)  under Python <= 3.7, numbers are never underscored (regardless of the underscore_numnbers attribute
-***) peek allows selection of a colour, whereas IceCream does colouring based on contents.
+***) peek allows selection of a color, 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-1.8.4 → peek_python-1.8.6.post0}/README.md

@@ -30,6 +30,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [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)
 
 * [Speeding up disabled peek](#speeding-up-disabled-peek)
@@ -320,8 +322,8 @@ sort_dicts              sdi             False
 underscore_numbers      un              False
 enabled                 e               True
 line_length             ll              160
-color                   col             ""
-color_value				colv			""
+color                   col             "-"
+color_value				colv			"-"
 level                   l               0
 compact                 c               False
 indent                  i               1
@@ -460,6 +462,7 @@ Finally, you can specify the following strings:
 ```
 "stderr"           to print to stderr
 "stdout"           to print to stdout
+"stdout_nocolor"   to print to stdout without any colors
 "null" or ""       to completely ignore (dummy) output 
 "logging.debug"    to use logging.debug
 "logging.info"     to use logging.info
@@ -619,9 +622,9 @@ d=
 ```
 
 ## color / col and color_value / colv
-The color attribute is used to specify the colour of the output.
+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 the null string ("").
+To set the color to 'nothing', use "-".
 
 On top of that, color_value may be used to specify the value part of an output item. By specifying color_value as "" (the default), the value part will be displayed with the same color as the rest of the output.
 
@@ -645,6 +648,8 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 > [!NOTE]
 >
 > 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"
 
 ## compact / c
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -1078,7 +1083,30 @@ Examples:
 
 This will print one line with`1` only.
 
+# Using color to control peek output
+
+The method `peek.show_color()` can be used to show only peek output for certain colors.
+
+For instance, with `peek.show_color("blue red")`, subsequent peek commands will print only if the color is *blue* or *red*. 
+With `peek.show_color("-")` only not colored output will be shown.
+
+It is also possible to specify which colors *not* to show. E.g. `peek.show_color("not green yellow"` will show all peeks apart from those in green or yellow. With `peek.show_color("not -")` only colored peeks will be shown.
+
+With `peek.show_color()` the current value can be queried.
+
+Finally, `peek.show_color()` can be used as a context manager:
+```
+with peek.show_color("blue red"):
+    peek(1, color="blue")
+    peek(2)
+peek(3)
+```
+This will print 1 and 3.
+
+It is possible to use both `peek.show_level()` and `peek.show_color()` at the same time, but this might be confusing.
+
 # Copying to the clipboard
+
 It is possible to copy a value to the clipboard. There are two ways:
 
 ### With peek(*args, to_clipboard=True)
@@ -1345,11 +1373,11 @@ suppress f-strings at left hand   optional                    no
 indentation                       4 blanks (overridable)      dependent on length of prefix
 forking and cloning               yes                         no
 test script                       pytest                      unittest
-colourize ***)                    yes, off by default         yes, on by default
+colorize ***)                    yes, off by default         yes, on by default
 -------------------------------------------------------------------------------------------
 *)   under Python <= 3.7, dicts are always sorted (regardless of the sort_dicts attribute
 **)  under Python <= 3.7, numbers are never underscored (regardless of the underscore_numnbers attribute
-***) peek allows selection of a colour, whereas IceCream does colouring based on contents.
+***) peek allows selection of a color, 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-1.8.4 → peek_python-1.8.6.post0}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "1.8.4"
+__version__ = "1.8.6"
 
 """
 See https://github.com/salabim/peek for details
@@ -67,7 +67,7 @@ colors = dict(
     cyan="\033[0;36m",
     white="\033[0;37m",
 )
-colors[""] = "\033[0m"
+colors["-"] = "\033[0m"
 
 
 ansi_to_hexa = {
@@ -94,16 +94,12 @@ def flatten(x):
                 yield item
 
 
-# def colorname_to_rgb(colorname):
-#    return tuple(int(ansito_rgb[colorname.lower()][i : i + 2], 16) / 255 for i in range(1, 7, 2))
-
-
 def check_validity(item, value, message=""):
     if value is None:
         return
 
     if item in ("color", "color_value"):
-        if not value or (isinstance(value, str) and value.lower() in colors):
+        if isinstance(value, str) and value.lower() in colors:
             return
 
     elif item in ("line_length", "enforce_line_length"):
@@ -132,12 +128,12 @@ def check_validity(item, value, message=""):
 
 
 class show_level:
-    def __new__(cls, *values, min=None, max=None, message=""):
+    def __new__(cls, *values, min=None, max=None):
         if len(values) == 0 and min is None and max is None:
             return _show_level
         return super().__new__(cls)
 
-    def __init__(self, *values, min=None, max=None, message=""):
+    def __init__(self, *values, min=None, max=None):
         result = ["False"]
         if min is not None or max is not None:
             if values:
@@ -178,18 +174,18 @@ class show_level:
                         float(part0)
                         float(part1)
                     except ValueError as e:
-                        raise ValueError(f"incorrect show_level spec: {element} in {values} {message}") from None
+                        raise ValueError(f"incorrect show_level spec: {element} in {values}") from None
                     if float(part0) > float(part1):
-                        raise ValueError(f"incorrect order in show_level spec: {element} in {values} {message}")
+                        raise ValueError(f"incorrect order in show_level spec: {element} in {values}")
                     result.append(f"{part0} <= level <= {part1}")
                 else:
                     try:
                         float(elementx)
                     except ValueError as e:
-                        raise ValueError(f"incorrect show_level spec: {element} in {values} {message}") from None
+                        raise ValueError(f"incorrect show_level spec: {element} in {values}") from None
                     result.append(f"level == {element}")
             else:
-                raise ValueError(f"incorrect show_level spec: {element} in {values} {message}")
+                raise ValueError(f"incorrect show_level spec: {element} in {values}")
 
         expression = f"level != '' and ({' or '.join(result)})"
 
@@ -209,6 +205,35 @@ class show_level:
         _show_level = self.saved_show_level
         _show_level_expression = self.saved_show_level_expression
 
+class show_color:
+    def __new__(cls, spec=None):
+        if spec is None:
+            return _show_color
+        return super().__new__(cls)
+
+    def __init__(self, spec=None):
+        global _show_color
+        global _show_color_expression
+
+        if not isinstance(spec,str):
+            raise TypeError(f"spec should be a string not {type(spec)}")
+        self.saved_show_color = _show_color
+        self.saved_show_color_expression = _show_color_expression
+        _show_color=spec
+        if spec.lower().startswith("not"):
+            _show_color_expression = f"color.lower() not in {repr(spec.lower()[3:])}"
+        else:
+            _show_color_expression = f"color in {repr(spec.lower())}"
+
+    def __enter__(self):
+        ...
+
+    def __exit__(self, exc_type, exc_value, exc_tb):
+        global _show_color
+        global _show_color_expression
+        print("exit",self.saved_show_color)
+        _show_color = self.saved_show_color
+        _show_color_expression = self.saved_show_color_expression
 
 def peek_pformat(obj, width, compact, indent, depth, sort_dicts, underscore_numbers):
     return pprint.pformat(obj, width=width, compact=compact, indent=indent, depth=depth, sort_dicts=sort_dicts, underscore_numbers=underscore_numbers).replace(
@@ -243,8 +268,8 @@ _fixed_perf_counter = None
 _show_level = "-"
 _show_level_expression = "True"
 
-attrs = set()  # ***
-
+_show_color = "-"
+_show_color_expression = "True"
 
 def fix_perf_counter(val):  # for tests
     global _fixed_perf_counter
@@ -306,8 +331,8 @@ def set_defaults():
     default.values_only = False
     default.values_only_for_fstrings = False
     default.return_none = False
-    default.color = ""
-    default.color_value = ""
+    default.color = "-"
+    default.color_value = "-"
     default.level = 0
     default.enforce_line_length = False
     default.one_line_per_pairenforce_line_length = False
@@ -451,13 +476,16 @@ class _Peek:
         if item == "show_level":
             raise NameError("reassigning show_level not allowed")
 
+        if item == "show_color":
+            raise NameError("reassigning show_color not allowed")
+
         if item in ["_attributes"]:
             super(_Peek, self).__setattr__(item, value)
         else:
             self._attributes[item] = value
 
     def do_show(self):
-        return eval(_show_level_expression, dict(level=self.level)) and self.enabled
+        return eval(_show_level_expression, dict(level=self.level)) and eval(_show_color_expression, dict(color=self.color))and self.enabled
 
     def assign(self, shortcuts, source, func):
         for key, value in shortcuts.items():
@@ -909,9 +937,13 @@ class _Peek:
         return (self.prefix() if callable(self.prefix) else self.prefix) + context
 
     def add_color_value(self, s):
-        if self.output != "stdout" or self.color_value == "" 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()]
+        else:
             return s
-        return colors[self.color_value] + s + colors[self.color]
 
     def do_output(self, s):
         if self.enforce_line_length:
@@ -922,27 +954,29 @@ class _Peek:
             elif self.output == "stderr":
                 print(s, file=sys.stderr)
             elif self.output == "stdout":
-                s = colors[self.color] + s + colors[""]
-                if Pythonista:
-                    while s:
-                        for ansi, hexa in ansi_to_hexa.items():
-                            if s.startswith(ansi):
-                                if hexa == "":
-                                    console.set_color()
-                                else:
-                                    rgb = tuple(int(hexa[i : i + 2], 16) / 255 for i in range(1, 7, 2))
-                                    console.set_color(*rgb)
-                                s = s[len(ansi) :]
-                                break
-                        else:
-                            print(s[0], end="", file=sys.stdout)
-                            s = s[1:]
-                    print()
+                if self.color!="-" or self.color_value!="-":
+                    s = colors[self.color.lower()] + s + colors["-"]
+                    if Pythonista:
+                        while s:
+                            for ansi, hexa in ansi_to_hexa.items():
+                                if s.startswith(ansi):
+                                    if hexa == "":
+                                        console.set_color()
+                                    else:
+                                        rgb = tuple(int(hexa[i : i + 2], 16) / 255 for i in range(1, 7, 2))
+                                        console.set_color(*rgb)
+                                    s = s[len(ansi) :]
+                                    break
+                            else:
+                                print(s[0], end="", file=sys.stdout)
+                                s = s[1:]
+                        print()
+                    else:
+                        print(s)
                 else:
-                    colorama.init()
-                    print(s, file=sys.stdout)
-                    colorama.deinit()
-
+                    print(s)
+            elif self.output=="stdout_nocolor":
+                print(s)
             elif self.output == "logging.debug":
                 logging.debug(s)
             elif self.output == "logging.info":
@@ -961,7 +995,6 @@ class _Peek:
             elif isinstance(self.output, Path):
                 with self.output.open("a+", encoding="utf-8") as f:
                     print(s, file=f)
-
             else:
                 print(s, file=self.output)
 

{peek_python-1.8.4 → peek_python-1.8.6.post0}/peek_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 1.8.4
+Version: 1.8.6.post0
 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
@@ -50,6 +50,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [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)
 
 * [Speeding up disabled peek](#speeding-up-disabled-peek)
@@ -340,8 +342,8 @@ sort_dicts              sdi             False
 underscore_numbers      un              False
 enabled                 e               True
 line_length             ll              160
-color                   col             ""
-color_value				colv			""
+color                   col             "-"
+color_value				colv			"-"
 level                   l               0
 compact                 c               False
 indent                  i               1
@@ -480,6 +482,7 @@ Finally, you can specify the following strings:
 ```
 "stderr"           to print to stderr
 "stdout"           to print to stdout
+"stdout_nocolor"   to print to stdout without any colors
 "null" or ""       to completely ignore (dummy) output 
 "logging.debug"    to use logging.debug
 "logging.info"     to use logging.info
@@ -639,9 +642,9 @@ d=
 ```
 
 ## color / col and color_value / colv
-The color attribute is used to specify the colour of the output.
+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 the null string ("").
+To set the color to 'nothing', use "-".
 
 On top of that, color_value may be used to specify the value part of an output item. By specifying color_value as "" (the default), the value part will be displayed with the same color as the rest of the output.
 
@@ -665,6 +668,8 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 > [!NOTE]
 >
 > 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"
 
 ## compact / c
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -1098,7 +1103,30 @@ Examples:
 
 This will print one line with`1` only.
 
+# Using color to control peek output
+
+The method `peek.show_color()` can be used to show only peek output for certain colors.
+
+For instance, with `peek.show_color("blue red")`, subsequent peek commands will print only if the color is *blue* or *red*. 
+With `peek.show_color("-")` only not colored output will be shown.
+
+It is also possible to specify which colors *not* to show. E.g. `peek.show_color("not green yellow"` will show all peeks apart from those in green or yellow. With `peek.show_color("not -")` only colored peeks will be shown.
+
+With `peek.show_color()` the current value can be queried.
+
+Finally, `peek.show_color()` can be used as a context manager:
+```
+with peek.show_color("blue red"):
+    peek(1, color="blue")
+    peek(2)
+peek(3)
+```
+This will print 1 and 3.
+
+It is possible to use both `peek.show_level()` and `peek.show_color()` at the same time, but this might be confusing.
+
 # Copying to the clipboard
+
 It is possible to copy a value to the clipboard. There are two ways:
 
 ### With peek(*args, to_clipboard=True)
@@ -1365,11 +1393,11 @@ suppress f-strings at left hand   optional                    no
 indentation                       4 blanks (overridable)      dependent on length of prefix
 forking and cloning               yes                         no
 test script                       pytest                      unittest
-colourize ***)                    yes, off by default         yes, on by default
+colorize ***)                    yes, off by default         yes, on by default
 -------------------------------------------------------------------------------------------
 *)   under Python <= 3.7, dicts are always sorted (regardless of the sort_dicts attribute
 **)  under Python <= 3.7, numbers are never underscored (regardless of the underscore_numnbers attribute
-***) peek allows selection of a colour, whereas IceCream does colouring based on contents.
+***) peek allows selection of a color, 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-1.8.4 → peek_python-1.8.6.post0}/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 = "1.8.4"
+version = "1.8.6-0"
 readme = "README.md"
 requires-python = ">=3.6"
 dependencies = [
@@ -33,5 +33,4 @@ Repository = "https://github.com/salabim/peek"
 packages = ["peek"]
 
 [tool.setuptools.package-data]
-"*" = ["*.json"]
-
+"*" = ["*.json"]

{peek_python-1.8.4 → peek_python-1.8.6.post0}/tests/test_peek.py

@@ -449,7 +449,7 @@ def test_read_toml1():
     peek.set_defaults()
     assert peek.default.line_length == 80
     assert peek.default.show_line_number == False
-    assert peek.default.color == ""
+    assert peek.default.color == "-"
 
     with open(toml_filename0, "w") as f:
         print("error = 0", file=f)
@@ -1096,13 +1096,42 @@ a = 12, b = ['test', 'test', 'test', 'test']
     )
 
 
-def test_color():
-    assert peek.color==""
+def test_color(capsys):
+    assert peek.color=="-"
     peek.color="red"
     assert peek.color=="red"
     with pytest.raises(ValueError):
         peek.color="wrong"
-    peek.color=""
+
+    peek.color="-"
+    peek.output="stdout_nocolor"
+    peek.show_color("- blue yellow black white")
+    peek(peek.show_color())
+
+    for i,color in enumerate("black white red blue green cyan magenta yellow".split()):
+        peek(i, i*i, color=color)
+
+    with peek.show_color("not - blue yellow black white"):
+        peek(peek.show_color())
+        for i,color in enumerate("black white red blue green cyan magenta yellow".split()):
+            peek(i, i*i, color=color)
+    peek.output="stdout"
+
+    out, err = capsys.readouterr()
+    assert out=="""\
+peek.show_color()='- blue yellow black white'
+i=0, i*i=0
+i=1, i*i=1
+i=3, i*i=9
+i=7, i*i=49
+i=2, i*i=4
+i=4, i*i=16
+i=5, i*i=25
+i=6, i*i=36
+exit - blue yellow black white
+"""
+    peek.color="-"
+    
 
 
 def test_context_separator(capsys):