peek-python 25.0.6__tar.gz → 25.0.8__tar.gz

{peek_python-25.0.6 → peek_python-25.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: peek-python
-Version: 25.0.6
+Version: 25.0.8
 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
@@ -343,7 +343,7 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value             col_val         "-"
+color_value             col_val         ""
 compact                 -               False
 context_separator       cs              " ==> "
 depth                   -               1000000
@@ -372,7 +372,8 @@ show_time               st              False
 show_traceback          -               False
 sort_dicts              -               False
 to_clipboard            clip            False
-underscore_numbers      un              False   
+underscore_numbers      un              False
+use_color               -               True
 values_only             vo              False
 value_only_for_fstrings voff            False 
 wrap_indent             -               "     "
@@ -691,11 +692,6 @@ will result in:
 
 Of course, color and color_value may be specified in a peek.toml file, to make all peek output in a specified color.
 
-> [!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"`.
 
 ------
 
@@ -717,8 +713,24 @@ repr(peek.ANSI.red)='\x1b[1;31m'
 
 ------
 
+## use_color
+
+Colors can be ignored completely by using `peek.use_color = False`.
+
+So,
+
+```
+peek(hello, color="red")
+peek.use_color = False
+peek(hello, color="red")
+```
+
+will print `hello=world` once in red and once without color.
+
+Of course, `use_color` can be specified in a peek.toml file.
 
 ## compact
+
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
 for details). `compact` is False by default.
 
@@ -1025,7 +1037,9 @@ for i in range(50):
   time.sleep(0.1)
 peek('')
 ```
-The `end` parameter will be only applied when output is stdout, stdout_nocolor or stderr.
+> [!NOTE]
+>
+> The `end` parameter will not be only applied when output is "logging.debug", "logging.info", "logging.warning", "logging.error" or "logging.critical".
 
 > [!NOTE]
 >
@@ -1077,7 +1091,7 @@ You can also use peek.print (see below).
 
 > [!TIP]
 >
-> Of course, print_only can be put in a **peek.toml** file.
+> Of course, `print_like` 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`, `end`, `filter` and `output`, `separator_print`, `show_delta` and `show_time`. It is also possible to redirect the output to a string with `as_str`.
@@ -1173,23 +1187,22 @@ hello='world'
 
 Note that if enabled=False, the call will return the null string (`""`).
 
-It is also possible to return a string with the embedded ANSI color escape strings, which can be useful to process the output in another program that supports ANSI colors, like salabim. This is done by setting the `as_colored_str` argument to True:
+By default, a string will contain embedded ANSI color escape strings if either `color` or `color_value` specifies a color. By setting `use_color` to False, these escape sequences will be suppressed.
+
 ```
 hello = "world"
-s = peek(hello, color="red", color_value="green", as_colored_str=True)
-print(repr(s), end="")
+s = peek(hello, color="red", color_value="green", as_str=True)
+print(repr(s))
+peek.use_color = False
+s = peek(hello, color="red", color_value="green", as_str=True)
+print(repr(s))
 ```
 prints
 ```
-"\x1b[1;31mhello=\x1b[1;32m'world'\x1b[1;31m\n\x1b[0m"
+'\x1b[1;31mhello=\x1b[1;32mworld\x1b[1;31m\x1b[0m\n'
+'hello=world\n'
 ```
 
-> [!NOTE]
->
-> Specifying both `as_str` and `as_colored_str` is not allowed.
-
-
-
 # Disabling peek's output
 
 ```

{peek_python-25.0.6 → peek_python-25.0.8}/README.md

@@ -323,7 +323,7 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value             col_val         "-"
+color_value             col_val         ""
 compact                 -               False
 context_separator       cs              " ==> "
 depth                   -               1000000
@@ -352,7 +352,8 @@ show_time               st              False
 show_traceback          -               False
 sort_dicts              -               False
 to_clipboard            clip            False
-underscore_numbers      un              False   
+underscore_numbers      un              False
+use_color               -               True
 values_only             vo              False
 value_only_for_fstrings voff            False 
 wrap_indent             -               "     "
@@ -671,11 +672,6 @@ will result in:
 
 Of course, color and color_value may be specified in a peek.toml file, to make all peek output in a specified color.
 
-> [!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"`.
 
 ------
 
@@ -697,8 +693,24 @@ repr(peek.ANSI.red)='\x1b[1;31m'
 
 ------
 
+## use_color
+
+Colors can be ignored completely by using `peek.use_color = False`.
+
+So,
+
+```
+peek(hello, color="red")
+peek.use_color = False
+peek(hello, color="red")
+```
+
+will print `hello=world` once in red and once without color.
+
+Of course, `use_color` can be specified in a peek.toml file.
 
 ## compact
+
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
 for details). `compact` is False by default.
 
@@ -1005,7 +1017,9 @@ for i in range(50):
   time.sleep(0.1)
 peek('')
 ```
-The `end` parameter will be only applied when output is stdout, stdout_nocolor or stderr.
+> [!NOTE]
+>
+> The `end` parameter will not be only applied when output is "logging.debug", "logging.info", "logging.warning", "logging.error" or "logging.critical".
 
 > [!NOTE]
 >
@@ -1057,7 +1071,7 @@ You can also use peek.print (see below).
 
 > [!TIP]
 >
-> Of course, print_only can be put in a **peek.toml** file.
+> Of course, `print_like` 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`, `end`, `filter` and `output`, `separator_print`, `show_delta` and `show_time`. It is also possible to redirect the output to a string with `as_str`.
@@ -1153,23 +1167,22 @@ hello='world'
 
 Note that if enabled=False, the call will return the null string (`""`).
 
-It is also possible to return a string with the embedded ANSI color escape strings, which can be useful to process the output in another program that supports ANSI colors, like salabim. This is done by setting the `as_colored_str` argument to True:
+By default, a string will contain embedded ANSI color escape strings if either `color` or `color_value` specifies a color. By setting `use_color` to False, these escape sequences will be suppressed.
+
 ```
 hello = "world"
-s = peek(hello, color="red", color_value="green", as_colored_str=True)
-print(repr(s), end="")
+s = peek(hello, color="red", color_value="green", as_str=True)
+print(repr(s))
+peek.use_color = False
+s = peek(hello, color="red", color_value="green", as_str=True)
+print(repr(s))
 ```
 prints
 ```
-"\x1b[1;31mhello=\x1b[1;32m'world'\x1b[1;31m\n\x1b[0m"
+'\x1b[1;31mhello=\x1b[1;32mworld\x1b[1;31m\x1b[0m\n'
+'hello=world\n'
 ```
 
-> [!NOTE]
->
-> Specifying both `as_str` and `as_colored_str` is not allowed.
-
-
-
 # Disabling peek's output
 
 ```

{peek_python-25.0.6 → peek_python-25.0.8}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "25.0.6"
+__version__ = "25.0.8"
 
 """
 See https://github.com/salabim/peek for details
@@ -86,6 +86,7 @@ class _Peek:
         ("sort_dicts", "", False),
         ("to_clipboard", "clip", False),
         ("underscore_numbers", "un", False),
+        ("use_color", "", True),
         ("values_only", "vo", False),
         ("values_only_for_fstrings", "voff", False),
         ("wrap_indent", "", "    "),
@@ -94,7 +95,7 @@ class _Peek:
     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}
+    name_and_alias_default = name_default | alias_default
 
     _fixed_perf_counter = None
 
@@ -140,10 +141,14 @@ class _Peek:
         "\033[0m": (),
     }
 
-    ANSI=types.SimpleNamespace(**_color_name_to_ANSI)
+    ANSI = types.SimpleNamespace(**_color_name_to_ANSI)
 
     codes = {}
 
+    #    @staticmethod
+    #    def reset():  # for Pythonista problems. Solved?
+    #        _Peek.codes={}
+
     @staticmethod
     def de_alias(name):
         return _Peek.alias_name.get(name, name)
@@ -153,7 +158,7 @@ class _Peek:
         name_org = name
         name = _Peek.de_alias(name)
         if name not in _Peek.name_default:
-            raise AttributeError(f"attribute {name} not allowed{_Peek.in_read_toml_message}")
+            raise AttributeError(f"attribute {name_org} not allowed{_Peek.in_read_toml_message}")
 
         if value is None:
             return
@@ -169,17 +174,17 @@ class _Peek:
                 pass
             raise AttributeError("output should be a callable, str, Path or open text file.")
 
-        if name == "serialize":
+        elif name == "serialize":
             if callable(value):
                 return
 
-        if name in ("color", "color_value"):
-            if isinstance(value, str) and value.lower() in _Peek._color_name_to_ANSI:
+        elif name in ("color", "color_value"):
+            if isinstance(value, str) and value in _Peek._color_name_to_ANSI:
                 return
 
-            elif name == "delta":
-                if isinstance(value, numbers.Number):
-                    return
+        elif name == "delta":
+            if isinstance(value, numbers.Number):
+                return
 
         elif name == "line_length":
             if isinstance(value, numbers.Number) and value > 0:
@@ -249,7 +254,7 @@ class _Peek:
         return {}
 
     @staticmethod
-    def print_pythonista_color(s, end="\n"):
+    def print_pythonista_color(s, end="\n", file=sys.stdout):
         while s:
             for ansi, rgb in _Peek._ANSI_to_rgb.items():
                 if s.startswith(ansi):
@@ -257,9 +262,9 @@ class _Peek:
                     s = s[len(ansi) :]
                     break
             else:
-                print(s[0], end="")
+                print(s[0], end="", file=file)
                 s = s[1:]
-        print("", end=end)
+        print("", end=end, file=file)
 
     @staticmethod
     def return_args(args, return_none):
@@ -290,7 +295,7 @@ class _Peek:
 
     def clone(self, **kwargs):
         clone = _Peek(parent=self._parent)
-        clone._attributes = {**self._attributes, **_Peek.spec_to_attributes(**kwargs)}
+        clone._attributes = self._attributes | _Peek.spec_to_attributes(**kwargs)
         return clone
 
     def configure(self, **kwargs):
@@ -315,16 +320,7 @@ class _Peek:
             return self.__getattribute__(item)
 
     def __setattr__(self, item, value):
-        if item in (
-            "_parent",
-            "_is_context_manager",
-            "_line_number_with_filename_and_parent",
-            "_save_traceback",
-            "_enter_time",
-            "_as_str",
-            "_as_colored_str",
-            "_attributes",
-        ):
+        if item in ("_parent", "_is_context_manager", "_line_number_with_filename_and_parent", "_save_traceback", "_enter_time", "_as_str", "_attributes"):
             return super().__setattr__(item, value)
         self._attributes.update(_Peek.spec_to_attributes(**{item: value}))
 
@@ -338,6 +334,7 @@ class _Peek:
         pairs = [
             str(name) + "=" + repr(getattr(self, "delta1") if name == "delta" else getattr(self, name)) for name in _Peek.name_default if name != "serialize"
         ]
+
         return "peek with attributes:\n    " + "\n    ".join(pairs) + ")"
 
     def fix_perf_counter(self, val):  # for tests
@@ -349,14 +346,14 @@ class _Peek:
                 return False
         return self.enabled
 
-    def print(self, *args, as_str=False, as_colored_str=False, **kwargs):
+    def print(self, *args, as_str=False, **kwargs):
         if "print" in kwargs and "print_like" in kwargs:
             raise AttributeError("both print_like and print specified")
         if not "print" in kwargs and not "print_like" in kwargs:
             kwargs["print_like"] = True
-        return self(*args, as_str=as_str, as_colored_str=as_colored_str, **kwargs)
+        return self(*args, as_str=as_str, **kwargs)
 
-    def __call__(self, *args, as_str=False, as_colored_str=False, _via_module=False, **kwargs):
+    def __call__(self, *args, as_str=False, _via_module=False, **kwargs):
         def add_to_pairs(pairs, left, right):
             if right in (locals, globals, vars):
                 frame = inspect.currentframe().f_back.f_back
@@ -371,11 +368,7 @@ class _Peek:
         any_args = bool(args)
         this = self.fork(**kwargs)
 
-        if as_str and as_colored_str:
-            raise ValueError("not allowed to use both as_str and as_colored_str")
-
         this._as_str = as_str
-        this._as_colored_str = as_colored_str
 
         if this.print_like:
             seps = [name for name in ("sep", "separator") if name in kwargs]
@@ -394,7 +387,8 @@ class _Peek:
             args = [this.separator_print.join(map(str, args))]
 
         if len(args) != 0 and not this.do_show():
-            if as_str or as_colored_str:
+            # if there are no args, the checks for decorator and context manager always to be done
+            if as_str:
                 return ""
             else:
                 return _Peek.return_args(args, this.return_none)
@@ -447,24 +441,23 @@ class _Peek:
             else:
                 line_number = frame_info.lineno
 
-            #            parent_function = frame_info.function
-            parent_function = executing.Source.executing(call_frame).code_qualname()  # changed in version 1.3.10 to include class name
+            parent_function = executing.Source.executing(call_frame).code_qualname()
             parent_function = parent_function.replace(".<locals>.", ".")
             if parent_function == "<module>" or str(this.show_line_number) in ("n", "no parent"):
                 parent_function = ""
             else:
                 parent_function = f" in {parent_function}()"
-            if 0 <= line_number - 1 < len(code):
+            if 0 <= line_number - 1 < len(code) - 1:
                 this_line = code[line_number - 1].strip()
             else:
                 this_line = ""
-            if 0 <= line_number - 2 < len(code):
+            if 0 <= line_number - 2 < len(code) - 2:
                 this_line_prev = code[line_number - 2].strip()
             else:
                 this_line_prev = ""
         if this_line.startswith("@") or this_line_prev.startswith("@"):
-            if as_str or as_colored_str:
-                raise TypeError("as_str or as_colored_str may not be True when peek used as decorator")
+            if as_str:
+                raise TypeError("as_str may not be True when peek used as decorator")
             if any_args:
                 raise TypeError("non-keyword arguments are not allowed when peek used as decorator")
 
@@ -513,8 +506,8 @@ 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 as_str or as_colored_str:
-                raise TypeError("as_str or as_colored_str may not be True when peek used as context manager")
+            if as_str:
+                raise TypeError("as_str may not be True when peek used as context manager")
             if any_args:
                 raise TypeError("non-keyword arguments are not allowed when peek used as context manager")
 
@@ -522,7 +515,7 @@ class _Peek:
             return this
 
         if not this.do_show():
-            if as_str or as_colored_str:
+            if as_str:
                 return ""
             else:
                 return _Peek.return_args(args, this.return_none)
@@ -560,12 +553,17 @@ class _Peek:
                     add_to_pairs(pairs, left, right)
 
             just_one_line = False
+            if (not this.use_color) or this.color in ("", "-"):
+                out = ""
+            else:
+                out = _Peek._color_name_to_ANSI[this.color.lower()]
+
             if not (len(pairs) > 1 and this.separator == ""):
                 if not any("\n" in pair.left for pair in pairs):
                     as_one_line = context + this.separator.join(pair.left + this.serialize_kwargs(obj=pair.right, width=10000) for pair in pairs)
                     #                    as_one_line = context + this.separator.join(pair.left + (this.serialize_kwargs(obj=pair.right, width=10000)) for pair in pairs)
                     if len(as_one_line) <= this.line_length and "\n" not in as_one_line:
-                        out = as_one_line
+                        out += as_one_line
                         just_one_line = True
 
             if not just_one_line:
@@ -609,7 +607,7 @@ class _Peek:
                         for s in line.splitlines():
                             lines.append(indent2 + s)
 
-                out = "\n".join(line.rstrip() for line in lines)
+                out += "\n".join(line.rstrip() for line in lines)
 
         else:
             if not this.show_line_number:  # if "n" or "no parent", keep that info
@@ -619,18 +617,15 @@ class _Peek:
         if this.show_traceback:
             out += this.traceback()
 
+        if this.use_color and this.color not in ("", "-"):
+            out += _Peek._color_name_to_ANSI["-"]
+
         if as_str:
             if this.do_show():
                 return out + this.end
             else:
                 return ""
 
-        if as_colored_str:
-            if this.do_show():
-                return this._color_name_to_ANSI[this.color.lower()] + out + this.end + this._color_name_to_ANSI["-"]
-            else:
-                return ""
-
         if this.to_clipboard:
             peek.copy_to_clipboard(pairs[-1].right if "pairs" in locals() else "", confirm=False)
         this.do_output(out)
@@ -678,12 +673,17 @@ class _Peek:
         return self.prefix + context
 
     def add_color_value(self, s):
-        if (self.output != "stdout" or self._as_str) and not self._as_colored_str:
+        if not self.use_color:
             return s
-        if self.color_value.lower() not in (self.color.lower(), ""):
-            return self._color_name_to_ANSI[self.color_value.lower()] + s + self._color_name_to_ANSI[self.color.lower()]
+        if self.color_value == "":
+            ...
+        elif self.color_value == "-":
+            if self.color not in ("", "-"):
+                s = _Peek._color_name_to_ANSI["-"] + s + _Peek._color_name_to_ANSI[self.color]
         else:
-            return s
+            if self.color_value != self.color:
+                s = _Peek._color_name_to_ANSI[self.color_value] + s + _Peek._color_name_to_ANSI[self.color]
+        return s
 
     def do_output(self, s):
         if self.do_show():
@@ -693,19 +693,12 @@ class _Peek:
                     self.output(s, end=self.end)
                 else:
                     self.output(s + self.end)
-            elif self.output == "stderr":
-                print(s, file=sys.stderr, end=self.end)
-            elif self.output == "stdout":
-                if self.color not in ["", "-"]:
-                    s = self._color_name_to_ANSI[self.color.lower()] + s + self.end + self._color_name_to_ANSI["-"]
-                    if Pythonista:
-                        _Peek.print_pythonista_color(s, end="")
-                    else:
-                        print(s, end="")
+            elif self.output in ("stdout", "stderr"):
+                file = sys.stdout if self.output == "stdout" else sys.stderr
+                if Pythonista:
+                    _Peek.print_pythonista_color(s, end=self.end, file=file)
                 else:
-                    print(s, end=self.end)
-            elif self.output == "stdout_nocolor":
-                print(s, end=self.end)
+                    print(s, end=self.end, file=file)
             elif self.output == "logging.debug":
                 logging.debug(s)
             elif self.output == "logging.info":
@@ -779,7 +772,7 @@ class _Peek:
 
 _Peek.in_read_toml_message = ""
 _peek_no_toml = _Peek(**_Peek.name_default)
-_peek_toml = _Peek(**{**_Peek.name_default, **_Peek.read_toml()})
+_peek_toml = _Peek(**(_Peek.name_default | _Peek.read_toml()))
 _Peek.in_read_toml_message = ""
 peek = _peek_toml.new()
 builtins.peek = peek
@@ -804,4 +797,3 @@ class _PeekModule(types.ModuleType):
 
 if __name__ != "__main__":
     sys.modules["peek"].__class__ = _PeekModule
-

{peek_python-25.0.6 → peek_python-25.0.8}/peek_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: peek-python
-Version: 25.0.6
+Version: 25.0.8
 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
@@ -343,7 +343,7 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value             col_val         "-"
+color_value             col_val         ""
 compact                 -               False
 context_separator       cs              " ==> "
 depth                   -               1000000
@@ -372,7 +372,8 @@ show_time               st              False
 show_traceback          -               False
 sort_dicts              -               False
 to_clipboard            clip            False
-underscore_numbers      un              False   
+underscore_numbers      un              False
+use_color               -               True
 values_only             vo              False
 value_only_for_fstrings voff            False 
 wrap_indent             -               "     "
@@ -691,11 +692,6 @@ will result in:
 
 Of course, color and color_value may be specified in a peek.toml file, to make all peek output in a specified color.
 
-> [!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"`.
 
 ------
 
@@ -717,8 +713,24 @@ repr(peek.ANSI.red)='\x1b[1;31m'
 
 ------
 
+## use_color
+
+Colors can be ignored completely by using `peek.use_color = False`.
+
+So,
+
+```
+peek(hello, color="red")
+peek.use_color = False
+peek(hello, color="red")
+```
+
+will print `hello=world` once in red and once without color.
+
+Of course, `use_color` can be specified in a peek.toml file.
 
 ## compact
+
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
 for details). `compact` is False by default.
 
@@ -1025,7 +1037,9 @@ for i in range(50):
   time.sleep(0.1)
 peek('')
 ```
-The `end` parameter will be only applied when output is stdout, stdout_nocolor or stderr.
+> [!NOTE]
+>
+> The `end` parameter will not be only applied when output is "logging.debug", "logging.info", "logging.warning", "logging.error" or "logging.critical".
 
 > [!NOTE]
 >
@@ -1077,7 +1091,7 @@ You can also use peek.print (see below).
 
 > [!TIP]
 >
-> Of course, print_only can be put in a **peek.toml** file.
+> Of course, `print_like` 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`, `end`, `filter` and `output`, `separator_print`, `show_delta` and `show_time`. It is also possible to redirect the output to a string with `as_str`.
@@ -1173,23 +1187,22 @@ hello='world'
 
 Note that if enabled=False, the call will return the null string (`""`).
 
-It is also possible to return a string with the embedded ANSI color escape strings, which can be useful to process the output in another program that supports ANSI colors, like salabim. This is done by setting the `as_colored_str` argument to True:
+By default, a string will contain embedded ANSI color escape strings if either `color` or `color_value` specifies a color. By setting `use_color` to False, these escape sequences will be suppressed.
+
 ```
 hello = "world"
-s = peek(hello, color="red", color_value="green", as_colored_str=True)
-print(repr(s), end="")
+s = peek(hello, color="red", color_value="green", as_str=True)
+print(repr(s))
+peek.use_color = False
+s = peek(hello, color="red", color_value="green", as_str=True)
+print(repr(s))
 ```
 prints
 ```
-"\x1b[1;31mhello=\x1b[1;32m'world'\x1b[1;31m\n\x1b[0m"
+'\x1b[1;31mhello=\x1b[1;32mworld\x1b[1;31m\x1b[0m\n'
+'hello=world\n'
 ```
 
-> [!NOTE]
->
-> Specifying both `as_str` and `as_colored_str` is not allowed.
-
-
-
 # Disabling peek's output
 
 ```

{peek_python-25.0.6 → peek_python-25.0.8}/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 = "25.0.6"
+version = "25.0.8"
 readme = "README.md"
 requires-python = ">=3.7"
 dependencies = [

{peek_python-25.0.6 → peek_python-25.0.8}/tests/test_peek.py

@@ -15,7 +15,9 @@ sys.path.insert(0, file_folder + "/../peek")
 
 import peek
 
-peek = peek.new(ignore_toml=True, output="stdout_nocolor")
+peek = peek.new(ignore_toml=True)
+
+globals().update(peek.ANSI.__dict__)  # put white, red, ..., dark_yellow in globals
 
 
 class g:
@@ -121,7 +123,6 @@ def test_time_delta():
     time.sleep(0.1)
     assert 10.05 < peek.delta < 11
 
-  
 
 def test_dynamic_prefix(capsys):
     g.i = 0
@@ -144,24 +145,26 @@ def test_values_only():
         s = peek(hello, as_str=True)
         assert s == "'world'\n"
 
+
 def test_locals(capsys):
     def square(x):
-        result = x ** 2
+        result = x**2
         peek(locals)
-        
+
     square(10)
     out, err = capsys.readouterr()
-    assert out=='x=10, result=100\n'
-        
+    assert out == "x=10, result=100\n"
+
 
 def test_globals(capsys):
     def square(x):
-        result = x ** 2
+        result = x**2
         peek(globals)
-        
+
     square(10)
     out, err = capsys.readouterr()
-    assert 'pytest=<module' in out
+    assert "pytest=<module" in out
+
 
 def test_calls():
     with pytest.raises(AttributeError):
@@ -187,6 +190,7 @@ def test_repr_and_str(capsys):
     assert out.startswith("peek.new(")
     assert out.endswith(")\n")
 
+
 def test_output(capsys, tmpdir):
     g.result = ""
 
@@ -202,10 +206,6 @@ def test_output(capsys, tmpdir):
     out, err = capsys.readouterr()
     assert out == "hello='world'\n"
 
-    peek(hello, output="stdout_nocolor")
-    out, err = capsys.readouterr()
-    assert out == "hello='world'\n"
-
     peek(hello, output="")
     out, err = capsys.readouterr()
     assert out == ""
@@ -282,12 +282,10 @@ def test_show_delta(capsys):
     assert "delta=" in out
 
 
-def test_as_str(capsys):
+def test_as_str():
     hello = "world"
-    s = peek(hello, as_str=True)
-    peek(hello)
-    out, err = capsys.readouterr()
-    assert out == s
+    s = peek(hello, as_str=True, color="red")
+    assert s == f"{red}hello='world'{reset}\n"
 
     with pytest.raises(TypeError):
 
@@ -299,14 +297,12 @@ def test_as_str(capsys):
         with peek(as_str=True):
             pass
 
-def test_as_colored_str():
-    hello = "world"
-    s = peek(hello, as_colored_str=True)
-    assert s == "\x1b[0mhello='world'\n\x1b[0m"
-    
-    with pytest.raises(ValueError):    
-        s=peek(hello, as_str=True, as_colored_str=True)
-    
+    with peek.preserve():
+        peek.use_color = False
+        s = peek(hello, as_str=True, color="red")
+        assert s == "hello='world'\n"
+
+
 @pytest.mark.skipif(Pythonista, reason="Pythonista problem")
 def test_print(capsys):
     peek.print(*range(4))
@@ -327,16 +323,16 @@ def test_print(capsys):
 2
 """
     )
-    result=peek.print(1,2,as_str=True)
-    assert result=="1 2\n"
+    result = peek.print(1, 2, as_str=True)
+    assert result == "1 2\n"
 
-    result=peek.print(1,2)
+    result = peek.print(1, 2)
     assert result is None
     out, err = capsys.readouterr()
     assert out == "1 2\n"
 
     with pytest.raises(AttributeError):
-        peek.print(sep="|", sepp="/")   
+        peek.print(sep="|", sepp="/")
 
 
 def test_clone():
@@ -411,6 +407,7 @@ lines=
     )
 
 
+@pytest.mark.skipif(Pythonista, reason="Pythonista does not use escape sequences for color")
 def test_filter(capsys):
     def gen():
         for level, color in enumerate("- blue red green blue".split()):
@@ -430,34 +427,61 @@ def test_filter(capsys):
     out, err = capsys.readouterr()
     assert (
         out
-        == """\
+        == f"""\
 level=0
-level=1
-level=2
-level=3
-level=4
-level=2
-level=3
-level=4
-level=2
-level=3
-level=4
-level=4
+{blue}level=1{reset}
+{red}level=2{reset}
+{green}level=3{reset}
+{blue}level=4{reset}
+{red}level=2{reset}
+{green}level=3{reset}
+{blue}level=4{reset}
+{red}level=2{reset}
+{green}level=3{reset}
+{blue}level=4{reset}
+{blue}level=4{reset}
 level=0
-level=1
-level=2
-level=3
-level=4
+{blue}level=1{reset}
+{red}level=2{reset}
+{green}level=3{reset}
+{blue}level=4{reset}
 """
     )
 
 
-@pytest.mark.skipif(Pythonista, reason="Pythonista does not generate ansi codes")
 def test_color(capsys):
-    peek(10 * 10, output="stdout")
-    peek(10 * 10, color="red", output="stdout")
-    out, err = capsys.readouterr()
-    assert out == "10 * 10=100\n\x1b[1;31m10 * 10=100\n\x1b[0m"
+    with peek.preserve():
+        hello = "world"
+        s = peek(hello, as_str=True)
+        assert s == f"hello='world'\n"
+        s = peek(hello, as_str=True, color="")
+        assert s == f"hello='world'\n"
+        s = peek(hello, as_str=True, color="-")
+        assert s == f"hello='world'\n"
+        s = peek(hello, as_str=True, color="red")
+        assert s == f"{red}hello='world'{reset}\n"
+
+        peek.color_value = "-"
+        s = peek(hello, as_str=True)
+        assert s == f"hello='world'\n"
+        s = peek(hello, as_str=True, color="")
+        assert s == f"hello='world'\n"
+        s = peek(hello, as_str=True, color="-")
+        assert s == f"hello='world'\n"
+        s = peek(hello, as_str=True, color="red")
+        assert s == f"{red}hello={reset}'world'{red}{reset}\n"
+
+        peek.color_value = "blue"
+        s = peek(hello, as_str=True)
+        assert s == f"hello={blue}'world'{reset}\n"
+        s = peek(hello, as_str=True, color="")
+        assert s == f"hello={blue}'world'{reset}\n"
+        s = peek(hello, as_str=True, color="-")
+        assert s == f"hello={blue}'world'{reset}\n"
+        s = peek(hello, as_str=True, color="red")
+        assert s == f"{red}hello={blue}'world'{red}{reset}\n"
+        s = peek(hello, as_str=True, color="blue")
+        assert s == f"{blue}hello='world'{reset}\n"
 
 
 def test_incorrect_filter():
@@ -860,7 +884,7 @@ def test_check_output(capsys, tmpdir):
 def check_output():
     import x2
 
-    peek.configure(show_line_number=True, show_exit= False,output="stdout_nocolor")
+    peek.configure(show_line_number=True, show_exit= False,use_color=False)
     x2.test()
     peek(1)
     peek(
@@ -1164,3 +1188,4 @@ hello='world'
 
 if __name__ == "__main__":
     pytest.main(["-vv", "-s", "-x", __file__])
+