Pre-release polishing

* `max_iter` is `0` by default
* fix formatting

Author: penguinolog

logwrap/log_on_access.py

@@ -51,49 +51,57 @@ class LogOnAccess(property, typing.Generic[_OwnerT, _ReturnT]):
     >>> logging.basicConfig(level=logging.DEBUG, stream=log)
 
     >>> class Test:
-    ...     def __init__(self, val = 'ok'):
+    ...     def __init__(self, val="ok"):
     ...         self.val = val
+    ...
     ...     def __repr__(self):
-    ...         return f'{self.__class__.__name__}(val={self.val})'
+    ...         return f"{self.__class__.__name__}(val={self.val})"
+    ...
     ...     @LogOnAccess
     ...     def ok(self):
     ...         return self.val
+    ...
     ...     @ok.setter
     ...     def ok(self, val):
     ...         self.val = val
+    ...
     ...     @ok.deleter
     ...     def ok(self):
-    ...         self.val = ''
+    ...         self.val = ""
+    ...
     ...     @LogOnAccess
     ...     def fail_get(self):
     ...         raise RuntimeError()
+    ...
     ...     @LogOnAccess
     ...     def fail_set_del(self):
     ...         return self.val
+    ...
     ...     @fail_set_del.setter
     ...     def fail_set_del(self, value):
     ...         raise ValueError(value)
+    ...
     ...     @fail_set_del.deleter
     ...     def fail_set_del(self):
     ...         raise RuntimeError()
 
     >>> test = Test()
     >>> test.ok
     'ok'
-    >>> test.ok = 'OK'
+    >>> test.ok = "OK"
     >>> del test.ok
-    >>> test.ok = 'fail_get'
+    >>> test.ok = "fail_get"
 
     >>> test.fail_get
     Traceback (most recent call last):
     ...
     RuntimeError
 
-    >>> test.ok = 'fail_set_del'
+    >>> test.ok = "fail_set_del"
     >>> test.fail_set_del
     'fail_set_del'
 
-    >>> test.fail_set_del = 'fail'
+    >>> test.fail_set_del = "fail"
     Traceback (most recent call last):
     ...
     ValueError: fail

logwrap/log_wrap.py

@@ -774,7 +774,7 @@ def logwrap(
     log_level: int = DEBUG,
     exc_level: int = ERROR,
     max_indent: int = 20,
-    max_iter: int = 20,
+    max_iter: int = 0,
     blacklisted_names: Iterable[str] | None = None,
     blacklisted_exceptions: Iterable[type[Exception]] | None = None,
     log_call_args: bool = True,
@@ -794,7 +794,7 @@ def logwrap(
     log_level: int = DEBUG,
     exc_level: int = ERROR,
     max_indent: int = 20,
-    max_iter: int = 20,
+    max_iter: int = 0,
     blacklisted_names: Iterable[str] | None = None,
     blacklisted_exceptions: Iterable[type[Exception]] | None = None,
     log_call_args: bool = True,

logwrap/repr_utils.py

@@ -990,7 +990,7 @@ def pretty_str(
     indent: int = 0,
     no_indent_start: bool = False,
     max_indent: int = 20,
-    max_iter: int = 20,
+    max_iter: int = 0,
     indent_step: int = 4,
 ) -> str:
     """Make human readable str of object.

pyproject.toml

@@ -159,6 +159,7 @@ extend-select = [
   "ISC",  # flake8-implicit-str-concat
   "RET", "SIM", "C4",  # flake8-return, flake8-simplify, flake8-comprehensions
   "ICN", "PGH",  # flake8-import-conventions, pygrep-hooks
+  "TID",  # flake8-tidy-imports
   "Q",  # quotes
   "FLY",  # Flynt
   "FURB",  # Refurb
@@ -183,6 +184,9 @@ allow-dunder-method-names = ["__pretty_repr__", "__pretty_str__", "__rich_repr__
 [tool.ruff.lint.pydocstyle]
 convention = "pep257"
 
+[tool.ruff.format]
+docstring-code-format = true
+
 [tool.refurb]
 python_version = "3.8"
 enable_all = true

setup.py

@@ -62,7 +62,7 @@ def get_simple_vars_from_src(
 
     >>> list_sample = "c = [u'1', b'1', 1, 1.0, 1j, None]"
     >>> result = get_simple_vars_from_src(list_sample)
-    >>> result == {'c': [u'1', b'1', 1, 1.0, 1j, None]}
+    >>> result == {"c": ["1", b"1", 1, 1.0, 1j, None]}
     True
 
     >>> iterable_sample = "d = ([1], {1: 1}, {1})"

test/test_log_wrap.py

@@ -600,6 +600,7 @@ def func():
 
         result = func()
         self.assertEqual(result, [1, 2, 3])
+        # fmt: off
         self.assertEqual(
             "DEBUG>Calling: \n"
             "func()\n"
@@ -609,6 +610,8 @@ def func():
             "]\n",
             self.stream.getvalue(),
         )
+        # fmt: on
+
 
 # noinspection PyMissingOrEmptyDocstring
 class TestObject(unittest.TestCase):