Property on the Client to enable/disable logging

Author: florentx

CHANGES.rst

@@ -29,6 +29,8 @@ Changelog
 * Add private method :meth:`Record._invalidate_cache` to implement
   :meth:`Record.refresh`.
 
+* Property :attr:`Client.verbose` to enable/disable logging.
+
 
 2.4.7 (2025-11-07)
 ~~~~~~~~~~~~~~~~~~

README.rst

@@ -117,7 +117,7 @@ This is a sample session::
 
    It's also possible to set verbosity from the interactive prompt::
 
-       >>> client._printer.cols = 180
+       >>> client.verbose = 180  # Width in columns
 
 .. note::
 

odooly.py

@@ -414,15 +414,13 @@ class ServerError(Exception):
 
 
 class Printer:
-    def __init__(self, cols):
-        self.cols = MAXCOL[min(3, cols) - 1] if (cols or 9) < 9 else cols or None
+    cols = None
 
     def _print_(self, message, _prefix):
-        cols = max(36, self.cols)
         xch = str(message)
-        if len(xch) > cols:
+        if len(xch) > self.cols:
             suffix = f"... L={len(xch)}"
-            xch = xch[:cols - len(suffix)] + suffix
+            xch = xch[:self.cols - len(suffix)] + suffix
         print(f"{_prefix} {xch}")
 
     print_sent = functools.partialmethod(_print_, _prefix='-->')
@@ -1174,19 +1172,29 @@ class Client:
     def __init__(self, server, db=None, user=None, password=None,
                  api_key=None, transport=None, verbose=False):
         self._http = HTTPSession()
+        self._printer = Printer()
         self._session_uid = None
-        self._set_services(server, db, transport, verbose)
+        self.verbose = verbose
+        self._set_services(server, db, transport)
         self.env = Env(self)
         if user:  # Try to login
             self.login(user, password=password, api_key=api_key, database=db)
 
-    def _set_services(self, server, db, transport, cols):
+    @property
+    def verbose(self):
+        return self._printer.cols
+
+    @verbose.setter
+    def verbose(self, cols):
+        cols = MAXCOL[min(3, cols) - 1] if (cols or 9) < 9 else cols
+        self._printer.cols = cols and max(36, cols) or None
+
+    def _set_services(self, server, db, transport):
         if isinstance(server, list):
             appname = Path(__file__).name.rstrip('co')
             server = start_odoo_services(server, appname=appname)
         elif isinstance(server, str) and server[-1:] == '/':
             server = server.rstrip('/')
-        self._printer = Printer(cols)
         self._server = server
         self._connections = []
 
@@ -1329,7 +1337,7 @@ def from_config(cls, environment, user=None, verbose=False):
             password = None
         try:
             client = Env._cache[Env, db, server].client
-            client._printer.__init__(verbose)
+            client.verbose = verbose
             client.login(user or conf_user, password=password, api_key=api_key)
         except KeyError:
             client = cls(server, db, user or conf_user, password=password, api_key=api_key, verbose=verbose)
@@ -1469,11 +1477,11 @@ def connect(self, env_name=None, *, server=None, user=None):
         """Connect to another environment and replace the globals()."""
         assert self._is_interactive(), 'Not available'
         if env_name:
-            self.from_config(env_name, user=user, verbose=self._printer.cols)
+            self.from_config(env_name, user=user, verbose=self.verbose)
         elif server:
             if not user and self.env.uid:
                 user = self.env.user.login
-            self.__class__(server, user=user, verbose=self._printer.cols)
+            self.__class__(server, user=user, verbose=self.verbose)
         else:
             assert not user, "Use client.login(...) instead"
             self._globals['client'] = self.env.client

tests/test_client.py

@@ -365,6 +365,25 @@ def test_module_upgrade(self):
         )
         self.assertOutput(ANY)
 
+    def test_client_verbose(self):
+        client = self.client
+
+        self.assertIsNone(client.verbose)
+
+        client.verbose = 1
+        self.assertEqual(client.verbose, 79)
+
+        client.verbose = 3
+        self.assertEqual(client.verbose, 9999)
+
+        client.verbose = 140
+        self.assertEqual(client.verbose, 140)
+        self.assertEqual(client._printer.cols, 140)
+
+        client.verbose = 0
+        self.assertIsNone(client.verbose)
+        self.assertIsNone(client._printer.cols)
+
 
 class TestClientApi(XmlRpcTestCase):
     """Test the Client API."""

tests/test_util.py

@@ -1,7 +1,7 @@
 from functools import partial
 from unittest import TestCase
 
-from odooly import issearchdomain, searchargs, Model
+from odooly import issearchdomain, searchargs, Model, Client, Printer
 
 
 class TestUtils(TestCase):
@@ -141,3 +141,32 @@ def test_readfmt(self):
 
         (fields, fmt) = readfmt('a {color} elephant enters {location[1]}.\n\n{firstname!r} has left')
         self.assertEqual(fields, ['color', 'location', 'firstname'])
+
+    def test_printer(self):
+        # Verbosity None or 0   --> disable logging
+        # Verbosity 1 to 8      --> mapped 1 -> 79 / 2 -> 179 / 3+ -> 9999
+        # Verbosity >= 36       --> width to print in columns
+        client = object.__new__(Client)
+        client._printer = Printer()
+        client.verbose = 2
+        self.assertEqual(client._printer.cols, 179)
+        self.assertEqual(client.verbose, 179)
+        client.verbose = 3
+        self.assertEqual(client._printer.cols, 9999)
+        client.verbose = 250
+        self.assertEqual(client._printer.cols, 250)
+        client.verbose = None
+        self.assertIsNone(client._printer.cols)
+        client.verbose = 64
+        self.assertEqual(client._printer.cols, 64)
+        self.assertEqual(client.verbose, 64)
+        client.verbose = True
+        self.assertEqual(client._printer.cols, 79)
+        client.verbose = 8
+        self.assertEqual(client._printer.cols, 9999)
+        self.assertEqual(client.verbose, 9999)
+        client.verbose = 0
+        self.assertIsNone(client._printer.cols)
+
+        self.assertRaises(TypeError, setattr, client, 'verbose', 'a')
+        self.assertRaises(IndexError, setattr, client, 'verbose', -4)