peek-python 24.0.0__tar.gz → 24.0.1__tar.gz

{peek_python-24.0.0 → peek_python-24.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.0
+Version: 24.0.1
 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
@@ -18,7 +18,8 @@ Requires-Dist: pyperclip>=1.9.0
 Requires-Dist: six>=1.17.0
 Requires-Dist: tomli>=2.2.1
 
- <img src="https://www.salabim.org/peek/peek_logo1.png">
+- [ ]  <img src="https://www.salabim.org/peek/peek_logo1.png">
+
 
 # Introduction
 
@@ -48,9 +49,7 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using level to control peek output](#Using-level-to-control-peek-output)
-
-* [Using color to control peek output](#Using-color-to-control-peek-output)
+* [Using filter to control peek output](#Using-filter-to-control-peek-output)
 
 * [Copying to the clipboard](#Copying-to-the-clipboard)
 
@@ -66,12 +65,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Alternative to `peek`](#alternative-to-peek)
 
-* [Alternative installation](#alternative-installation)
-
 * [Limitations](#limitations)
 
-* [Implementation details](#implementation-details)
-
 * [Acknowledgement](#acknowledgement)
 
 * [Changelog](#changelog)
@@ -92,7 +87,7 @@ pip install peek-python --upgrade
 
 Alternatively, peek.py can be just copied into you current work directory from GitHub (https://github.com/salabim/peek).
 
-Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  tomli and pyperclip` modules, all of which will be automatically installed.
+Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed with pip.
 
 # Importing peek
 
@@ -108,8 +103,9 @@ import peek
 from peek import peek
 ```
 
-Note that after this, `peek` is automatically a builtin and can thus be used in any module without
-importing it there.
+> [!NOTE]
+>
+> After this, `peek` is automatically a builtin and can thus be used in any module without importing it there.
 
 # Inspect variables and expressions
 
@@ -326,7 +322,7 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value				colv			"-"
+color_value             col_val         "-"
 context_separator       cs              " ==> "
 compact                 -               False
 depth                   -               1000000
@@ -366,6 +362,7 @@ print(peek.prefix)
 
 But, it is also possible to apply configuration directly, only here, in the call to `peek`:
 So, it is possible to say
+
 ```
 peek(12, prefix="==> ")
 ```
@@ -640,7 +637,7 @@ d=
      'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
 ```
 
-## color / col and color_value / colv
+## color / col and color_value / col_val
 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 "-".
@@ -668,7 +665,7 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 >
 > 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`.
+> Colors can be ignored completely by using `peek.output = "stdout_nocolor"`.
 
 ## compact
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -1017,7 +1014,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"
 ```
@@ -1139,7 +1136,7 @@ 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()`
      
@@ -1147,7 +1144,7 @@ THere are several ways to obtain a new instance of peek:
      and possibly peek.toml overrides.
 *    by using `peek.new(ignore_toml=True)`
 
-     With this a new peekobject is created with the default attibutes. Any peek.toml files asre ignored.
+     With this a new peek object 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.
@@ -1274,9 +1271,9 @@ The peek package is a rebrand of the **ycecream** package, with enhancements.
 The peek module was originally a fork of **IceCream**, but has many differences:
 
 ```
--------------------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------
 characteristic                    peek                        IceCream
--------------------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------
 default name                      peek                        ic
 import method                     import peek                 from icecream import ic
 number of files                   1                           several
@@ -1295,14 +1292,14 @@ level control                     yes                         no
 observes line_length correctly    yes                         no
 benchmarking functionality        yes                         no
 suppress f-strings at left hand   optional                    no
-indentation                       4 blanks (overridable)      dependent on length of prefix
+indentation                       4 blanks (overridable)      length of prefix
 forking and cloning               yes                         no
 test script                       pytest                      unittest
 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 color, whereas IceCream does coloring based on contents.
+-----------------------------------------------------------------------------------------
+*)   under Python <= 3.7, dicts are always sorted
+**)  under Python <= 3.7, numbers are never underscored
+***) 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-24.0.0 → peek_python-24.0.1}/README.md

@@ -1,4 +1,5 @@
- <img src="https://www.salabim.org/peek/peek_logo1.png">
+- [ ]  <img src="https://www.salabim.org/peek/peek_logo1.png">
+
 
 # Introduction
 
@@ -28,9 +29,7 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using level to control peek output](#Using-level-to-control-peek-output)
-
-* [Using color to control peek output](#Using-color-to-control-peek-output)
+* [Using filter to control peek output](#Using-filter-to-control-peek-output)
 
 * [Copying to the clipboard](#Copying-to-the-clipboard)
 
@@ -46,12 +45,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Alternative to `peek`](#alternative-to-peek)
 
-* [Alternative installation](#alternative-installation)
-
 * [Limitations](#limitations)
 
-* [Implementation details](#implementation-details)
-
 * [Acknowledgement](#acknowledgement)
 
 * [Changelog](#changelog)
@@ -72,7 +67,7 @@ pip install peek-python --upgrade
 
 Alternatively, peek.py can be just copied into you current work directory from GitHub (https://github.com/salabim/peek).
 
-Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  tomli and pyperclip` modules, all of which will be automatically installed.
+Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed with pip.
 
 # Importing peek
 
@@ -88,8 +83,9 @@ import peek
 from peek import peek
 ```
 
-Note that after this, `peek` is automatically a builtin and can thus be used in any module without
-importing it there.
+> [!NOTE]
+>
+> After this, `peek` is automatically a builtin and can thus be used in any module without importing it there.
 
 # Inspect variables and expressions
 
@@ -306,7 +302,7 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value				colv			"-"
+color_value             col_val         "-"
 context_separator       cs              " ==> "
 compact                 -               False
 depth                   -               1000000
@@ -346,6 +342,7 @@ print(peek.prefix)
 
 But, it is also possible to apply configuration directly, only here, in the call to `peek`:
 So, it is possible to say
+
 ```
 peek(12, prefix="==> ")
 ```
@@ -620,7 +617,7 @@ d=
      'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
 ```
 
-## color / col and color_value / colv
+## color / col and color_value / col_val
 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 "-".
@@ -648,7 +645,7 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 >
 > 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`.
+> Colors can be ignored completely by using `peek.output = "stdout_nocolor"`.
 
 ## compact
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -997,7 +994,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"
 ```
@@ -1119,7 +1116,7 @@ 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()`
      
@@ -1127,7 +1124,7 @@ THere are several ways to obtain a new instance of peek:
      and possibly peek.toml overrides.
 *    by using `peek.new(ignore_toml=True)`
 
-     With this a new peekobject is created with the default attibutes. Any peek.toml files asre ignored.
+     With this a new peek object 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.
@@ -1254,9 +1251,9 @@ The peek package is a rebrand of the **ycecream** package, with enhancements.
 The peek module was originally a fork of **IceCream**, but has many differences:
 
 ```
--------------------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------
 characteristic                    peek                        IceCream
--------------------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------
 default name                      peek                        ic
 import method                     import peek                 from icecream import ic
 number of files                   1                           several
@@ -1275,14 +1272,14 @@ level control                     yes                         no
 observes line_length correctly    yes                         no
 benchmarking functionality        yes                         no
 suppress f-strings at left hand   optional                    no
-indentation                       4 blanks (overridable)      dependent on length of prefix
+indentation                       4 blanks (overridable)      length of prefix
 forking and cloning               yes                         no
 test script                       pytest                      unittest
 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 color, whereas IceCream does coloring based on contents.
+-----------------------------------------------------------------------------------------
+*)   under Python <= 3.7, dicts are always sorted
+**)  under Python <= 3.7, numbers are never underscored
+***) 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-24.0.0 → peek_python-24.0.1}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "24.0.0"
+__version__ = "24.0.1"
 
 """
 See https://github.com/salabim/peek for details
@@ -42,6 +42,7 @@ if Pythonista:
     import clipboard
 else:
     import colorama
+    colorama.just_fix_windows_console()
     import pyperclip
 
 try:
@@ -67,28 +68,28 @@ colors = dict(
 colors["-"] = "\033[0m"
 
 
-ansi_to_hexa = {
-    "\033[0;30m": "#000000",
-    "\033[0;31m": "#FF0000",
-    "\033[0;32m": "#00FF00",
-    "\033[0;33m": "#FFFF00",
-    "\033[0;34m": "#0080FF",
-    "\033[0;35m": "#FF00FF",
-    "\033[0;36m": "#00FFFF",
-    "\033[0;37m": "#FFFFFF",
-    "\033[0m": "",
+ansi_to_rgb = {
+    "\033[0;30m": (0, 0, 0),
+    "\033[0;31m": (1, 0, 0),
+    "\033[0;32m": (0, 1, 0),
+    "\033[0;33m": (1, 1, 0),
+    "\033[0;34m": (0, 0.7, 1),
+    "\033[0;35m": (1, 0, 1),
+    "\033[0;36m": (0, 1, 1),
+    "\033[0;37m": (1, 1, 1),
+    "\033[0m": (),
 }
 
 
-def dealias(name):
+def de_alias(name):
     return alias_name.get(name, name)
 
 
-def check_validity(name, value, message=""):
+def check_validity(name, value):
     name_org = name
-    name = dealias(name)
+    name = de_alias(name)
     if name not in name_default:
-        raise ValueError(f"parameter {name} not allowed{message}")
+        raise AttributeError(f"attribute {name} not allowed{in_read_toml_message}")
 
     if value is None:
         return
@@ -102,7 +103,7 @@ def check_validity(name, value, message=""):
             return
         except Exception:
             pass
-        raise TypeError("output should be a callable, str, Path or open text file.")
+        raise AttributeError("output should be a callable, str, Path or open text file.")
 
     if name == "serialize":
         if callable(value):
@@ -114,6 +115,10 @@ def check_validity(name, value, message=""):
         if isinstance(value, str) and value.lower() in colors:
             return
 
+        elif name == "delta":
+            if isinstance(value, numbers.Number):
+                return
+
     elif name == "enforce_line_length":
         if value:
             if isinstance(value, numbers.Number) and value > 0:
@@ -152,7 +157,7 @@ def check_validity(name, value, message=""):
     else:
         return
 
-    raise ValueError(f"incorrect {name_org}: {value}{message}")
+    raise AttributeError(f"incorrect {name_org}: {repr(value)}{in_read_toml_message}")
 
 
 class Source(executing.Source):
@@ -173,24 +178,31 @@ def change_path(new_path):  # used in tests
 _fixed_perf_counter = None
 
 
+def spec_to_attributes(d):
+    result = {}
+    for name, value in d.items():
+        check_validity(name, value)
+        name = de_alias(name)
+        if name == "delta" and value is not None:
+            result["perf_counter"] = perf_counter()
+        result[name] = value
+    return result
+
+
 def read_toml():
+    global in_read_toml_message
     this_path = Path(".").resolve()
-
     for i in range(len(this_path.parts), 0, -1):
         toml_file = Path(this_path.parts[0]).joinpath(*this_path.parts[1:i], "peek.toml")
         if toml_file.is_file():
+            in_read_toml_message = f" in reading {toml_file}"
             with open(toml_file, "r") as f:
                 config_as_str = f.read()
-            config = tomlib.loads(config_as_str)
-            for name, value in config.items():
-                check_validity(name, value, message=f" while processing {toml_file}")
-            return config
-            break
+            return tomlib.loads(config_as_str)
     return {}
 
 
 def no_source_error():
-
     raise NotImplementedError(
         """
 Failed to access the underlying source code for analysis. Possible causes:
@@ -212,28 +224,36 @@ def return_args(args, return_none):
 
 class _Peek:
     def __init__(self, parent=None, **kwargs):
-        self._attributes = {}
-        for name, value in kwargs.items():
-            check_validity(name, value)
-            setattr(self, name, value)
+        self._attributes = spec_to_attributes(kwargs)
         self._parent = parent
 
-    def __repr__(self):
-        pairs = [str(name) + "=" + repr(getattr(self, name)) for name in name_default if name != "serialize"]
-        return "peek.new(" + ", ".join(pairs) + ")"
+    def new(self, ignore_toml=False, **kwargs):
+        if ignore_toml:
+            return _Peek(**kwargs, parent=peek_no_toml)
+        else:
+            return _Peek(**kwargs, parent=peek_toml)
 
-    def fix_perf_counter(self, val):  # for tests
-        global _fixed_perf_counter
-        _fixed_perf_counter = val
+    def fork(self, **kwargs):
+        return _Peek(**kwargs, parent=self)
 
-    def __getattr__(self, item):
-        item = dealias(item)
-        if item in name_default:
+    def clone(self, **kwargs):
+        clone = _Peek(parent=self._parent)
+        clone._attributes = {**self._attributes, **spec_to_attributes(kwargs)}
+        return clone
+
+    def configure(self, **kwargs):
+        self._attributes.update(spec_to_attributes(kwargs))
+
+    def __getattr__(self, item, spec=False):
+        item = de_alias(item)
+        if item in name_default or item == "perf_counter":
             node = self
             while not item in node._attributes or node._attributes[item] is None:
                 node = node._parent
             if item == "delta":
-                return perf_counter() - node._attributes[item]
+                return perf_counter() - node._attributes["perf_counter"] + node._attributes["delta"]
+            elif item == "perf_counter":
+                return node._attributes["delta"]
             else:
                 return node._attributes[item]
         else:
@@ -242,18 +262,23 @@ 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}))
 
-        if item not in name_and_alias_default:
-            raise AttributeError(f"attribute {item} not allowed")
-
-        check_validity(item, value)
-        item = dealias(item)
+    def __repr__(self):
+        pairs = [
+            str(name) + "=" + repr(getattr(self, "perf_counter") if name == "delta" else getattr(self, name)) for name in name_default if name != "serialize"
+        ]
+        return "peek.new(" + ", ".join(pairs) + ")"
 
-        if item == "delta" and value is not None:
-            self._attributes[item] = perf_counter() - value
+    def __str__(self):
+        pairs = [
+            str(name) + "=" + repr(getattr(self, "perf_counter") if name == "delta" else getattr(self, name)) for name in name_default if name != "serialize"
+        ]
+        return "peek with attributes:\n    " + "\n    ".join(pairs) + ")"
 
-        else:
-            self._attributes[item] = value
+    def fix_perf_counter(self, val):  # for tests
+        global _fixed_perf_counter
+        _fixed_perf_counter = val
 
     def do_show(self):
         if self.filter.strip() != "":
@@ -261,14 +286,6 @@ class _Peek:
                 return False
         return self.enabled
 
-    def copy_to_clipboard(self, value, confirm=True):
-        if Pythonista:
-            clipboard.set(str(value))
-        else:
-            pyperclip.copy(str(value))
-        if confirm:
-            print(f"copied to clipboard: {value}")
-
     def __call__(self, *args, as_str=False, **kwargs):
         codes = {}
         this = self.fork(**kwargs)
@@ -507,28 +524,6 @@ class _Peek:
 
         return return_args(args, this.return_none)
 
-    def configure(self, **kwargs):
-        for name, value in kwargs.items():
-            check_validity(name, value)
-            self._attributes[name] = value
-        return self
-
-    def new(self, ignore_toml=False, **kwargs):
-        if ignore_toml:
-            return _Peek(**kwargs, parent=peek_no_toml)
-        else:
-            return _Peek(**kwargs, parent=peek_toml)
-
-    def fork(self, **kwargs):
-        return _Peek(**kwargs, parent=self)
-
-    def clone(self, **kwargs):
-        clone = _Peek(parent=self._parent)
-        clone._attributes=self._attributes.copy()
-        for name,value in kwargs:
-            setattr(clone,name,value)    
-        return clone
-
     @contextlib.contextmanager
     def preserve(self):
         save = dict(self._attributes)
@@ -567,7 +562,7 @@ class _Peek:
         if not omit_context_separator and context:
             context += self.context_separator
 
-        return (self.prefix() if callable(self.prefix) else self.prefix) + context
+        return str(self.prefix() if callable(self.prefix) else self.prefix) + context
 
     def add_color_value(self, s):
         if self.output != "stdout" or self.as_str:
@@ -590,17 +585,13 @@ class _Peek:
                     s = colors[self.color.lower()] + s + colors["-"]
                     if Pythonista:
                         while s:
-                            for ansi, hexa in ansi_to_hexa.items():
+                            for ansi, rgb in ansi_to_rgb.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)
+                                    console.set_color(*rgb)
                                     s = s[len(ansi) :]
                                     break
                             else:
-                                print(s[0], end="", file=sys.stdout)
+                                print(s[0], end="")
                                 s = s[1:]
                         print()
                     else:
@@ -630,6 +621,14 @@ class _Peek:
             else:
                 print(s, file=self.output)
 
+    def copy_to_clipboard(self, value, confirm=True):
+        if Pythonista:
+            clipboard.set(str(value))
+        else:
+            pyperclip.copy(str(value))
+        if confirm:
+            print(f"copied to clipboard: {value}")
+
     def traceback(self):
         if self.show_traceback:
             if isinstance(self.wrap_indent, numbers.Number):
@@ -660,11 +659,12 @@ class _Peek:
         return self.add_color_value(self.serialize(obj, **kwargs).replace("\\n", "\n"))
 
 
+store_perf_counter = perf_counter()
 name_alias_default = (
     ("color", "col", "-"),
-    ("color_value", "colv", ""),
-    ("context_separator", "cs", " ==> "),
+    ("color_value", "col_val", ""),
     ("compact", "", False),
+    ("context_separator", "cs", " ==> "),
     ("delta", "", 0),
     ("depth", "", 1000000),
     ("enabled", "", True),
@@ -689,26 +689,22 @@ name_alias_default = (
     ("sort_dicts", "", False),
     ("to_clipboard", "clip", False),
     ("underscore_numbers", "un", False),
-    ("wrap_indent", "", "    "),
     ("values_only", "vo", False),
     ("values_only_for_fstrings", "voff", False),
+    ("wrap_indent", "", "    "),
 )
-
 alias_name = {alias: name for (name, alias, default) in name_alias_default if alias}
 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}
 
+in_read_toml_message = ""
 peek_no_toml = _Peek(**name_default)
-peek_toml = peek_no_toml.fork(**read_toml())
-#_Peek(parent=peek_no_toml)
-# for name, value in read_toml().items():
-#     setattr(peek_toml,name,value)
-
-peek=peek_toml.new()
+peek_toml = _Peek(**{**name_default, **read_toml()})
+in_read_toml_message = ""
+peek = peek_toml.new()
 builtins.peek = peek
 
-
 class PeekModule(types.ModuleType):
     def __call__(self, *args, **kwargs):
         return peek(*args, **kwargs)
@@ -719,6 +715,12 @@ class PeekModule(types.ModuleType):
     def __getattr__(self, item):
         return getattr(peek, item)
 
+    def __repr__(self):
+        return repr(peek)
+
+    def __str__(self):
+        return str(peek)
+
 
 if __name__ != "__main__":
     sys.modules["peek"].__class__ = PeekModule

{peek_python-24.0.0 → peek_python-24.0.1}/peek_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 24.0.0
+Version: 24.0.1
 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
@@ -18,7 +18,8 @@ Requires-Dist: pyperclip>=1.9.0
 Requires-Dist: six>=1.17.0
 Requires-Dist: tomli>=2.2.1
 
- <img src="https://www.salabim.org/peek/peek_logo1.png">
+- [ ]  <img src="https://www.salabim.org/peek/peek_logo1.png">
+
 
 # Introduction
 
@@ -48,9 +49,7 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Disabling peek's output](#disabling-peeks-output)
 
-* [Using level to control peek output](#Using-level-to-control-peek-output)
-
-* [Using color to control peek output](#Using-color-to-control-peek-output)
+* [Using filter to control peek output](#Using-filter-to-control-peek-output)
 
 * [Copying to the clipboard](#Copying-to-the-clipboard)
 
@@ -66,12 +65,8 @@ And on top of that, you get some basic benchmarking functionality.
 
 * [Alternative to `peek`](#alternative-to-peek)
 
-* [Alternative installation](#alternative-installation)
-
 * [Limitations](#limitations)
 
-* [Implementation details](#implementation-details)
-
 * [Acknowledgement](#acknowledgement)
 
 * [Changelog](#changelog)
@@ -92,7 +87,7 @@ pip install peek-python --upgrade
 
 Alternatively, peek.py can be just copied into you current work directory from GitHub (https://github.com/salabim/peek).
 
-Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  tomli and pyperclip` modules, all of which will be automatically installed.
+Note that peek requires the `asttokens`,  `colorama`, `executing`. `six`,  `tomli` and `pyperclip` modules, all of which will be automatically installed with pip.
 
 # Importing peek
 
@@ -108,8 +103,9 @@ import peek
 from peek import peek
 ```
 
-Note that after this, `peek` is automatically a builtin and can thus be used in any module without
-importing it there.
+> [!NOTE]
+>
+> After this, `peek` is automatically a builtin and can thus be used in any module without importing it there.
 
 # Inspect variables and expressions
 
@@ -326,7 +322,7 @@ a number of configuration attributes:
 attribute               alternative     default
 ------------------------------------------------------
 color                   col             "-"
-color_value				colv			"-"
+color_value             col_val         "-"
 context_separator       cs              " ==> "
 compact                 -               False
 depth                   -               1000000
@@ -366,6 +362,7 @@ print(peek.prefix)
 
 But, it is also possible to apply configuration directly, only here, in the call to `peek`:
 So, it is possible to say
+
 ```
 peek(12, prefix="==> ")
 ```
@@ -640,7 +637,7 @@ d=
      'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
 ```
 
-## color / col and color_value / colv
+## color / col and color_value / col_val
 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 "-".
@@ -668,7 +665,7 @@ Of course, color and color_value may be specified in a peek.toml file, to make a
 >
 > 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`.
+> Colors can be ignored completely by using `peek.output = "stdout_nocolor"`.
 
 ## compact
 This attribute is used to specify the compact parameter for `pformat` (see the pprint documentation
@@ -1017,7 +1014,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"
 ```
@@ -1139,7 +1136,7 @@ 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()`
      
@@ -1147,7 +1144,7 @@ THere are several ways to obtain a new instance of peek:
      and possibly peek.toml overrides.
 *    by using `peek.new(ignore_toml=True)`
 
-     With this a new peekobject is created with the default attibutes. Any peek.toml files asre ignored.
+     With this a new peek object 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.
@@ -1274,9 +1271,9 @@ The peek package is a rebrand of the **ycecream** package, with enhancements.
 The peek module was originally a fork of **IceCream**, but has many differences:
 
 ```
--------------------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------
 characteristic                    peek                        IceCream
--------------------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------
 default name                      peek                        ic
 import method                     import peek                 from icecream import ic
 number of files                   1                           several
@@ -1295,14 +1292,14 @@ level control                     yes                         no
 observes line_length correctly    yes                         no
 benchmarking functionality        yes                         no
 suppress f-strings at left hand   optional                    no
-indentation                       4 blanks (overridable)      dependent on length of prefix
+indentation                       4 blanks (overridable)      length of prefix
 forking and cloning               yes                         no
 test script                       pytest                      unittest
 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 color, whereas IceCream does coloring based on contents.
+-----------------------------------------------------------------------------------------
+*)   under Python <= 3.7, dicts are always sorted
+**)  under Python <= 3.7, numbers are never underscored
+***) 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-24.0.0 → peek_python-24.0.1}/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 = "24.0.0"
+version = "24.0.1"
 readme = "README.md"
 requires-python = ">=3.6"
 dependencies = [

{peek_python-24.0.0 → peek_python-24.0.1}/tests/test_peek.py

@@ -144,15 +144,15 @@ def test_values_only():
 
 
 def test_calls():
-    with pytest.raises(ValueError):
+    with pytest.raises(AttributeError):
         peek.new(a=1)
-    with pytest.raises(ValueError):
+    with pytest.raises(AttributeError):
         peek.clone(a=1)
-    with pytest.raises(ValueError):
+    with pytest.raises(AttributeError):
         peek.configure(a=1)
-    with pytest.raises(ValueError):
+    with pytest.raises(AttributeError):
         peek(12, a=1)
-    with pytest.raises(ValueError):
+    with pytest.raises(AttributeError):
         peek(a=1)
 
 
@@ -208,7 +208,7 @@ def test_output(capsys, tmpdir):
     with path.open("a+") as f:
         peek(hello, output=f)
 
-    with pytest.raises(TypeError):  # closed file
+    with pytest.raises(AttributeError):  # closed file
         peek(hello, output=f)
     out, err = capsys.readouterr()
     assert out == ""
@@ -216,7 +216,7 @@ def test_output(capsys, tmpdir):
     with path.open("r") as f:
         assert f.read() == "hello='world'\n"
 
-    with pytest.raises(TypeError):
+    with pytest.raises(AttributeError):
         peek(hello, output=1)
 
     peek(hello, output=my_output)
@@ -382,10 +382,10 @@ def test_color(capsys):
 
 
 def test_incorrect_filter():
-    with pytest.raises(ValueError):
+    with pytest.raises(AttributeError):
         peek.filter="color='blue'"
 
-    with pytest.raises(ValueError):
+    with pytest.raises(AttributeError):
         peek.filter="colour=='blue'"
 
 def test_decorator(capsys):
@@ -762,7 +762,7 @@ def test_traceback(capsys):
         assert out.count("traceback") == 2
 
 
-#@pytest.mark.skipif(Pythonista, reason="Pythonista problem")
+@pytest.mark.skipif(Pythonista, reason="Pythonista problem")
 def test_enforce_line_length(capsys):
     s = 80 * "*"
     with peek.preserve():