Slightly improve consistency in Logger attributes naming.

diff --git a/ircplom/client.py b/ircplom/client.py
index ddb4cbed0fbf34ff66718a4e03c7f40ab2b7a4be..fefd7726bf28a9e817e120be2ce4b73ce01782e5 100644 (file)
--- a/ircplom/client.py
+++ b/ircplom/client.py
@@ -65,7 +65,7 @@ class _ServerCapability:
     data: str
 
     def str_for_log(self, name: str) -> str:
     data: str
 
     def str_for_log(self, name: str) -> str:

-        'Optimized for Client.log per-line listing.'
+        'Optimized for Client._log per-line listing.'

         listing = '+' if self.enabled else '-'
         listing += f' {name}'
         if self.data:
         listing = '+' if self.enabled else '-'
         listing += f' {name}'
         if self.data:


@@ -180,10 +180,10 @@ class Client(ABC, ClientQueueMixin):
             self.conn_setup.port = PORT_SSL
         self.client_id = self.conn_setup.hostname
         super().__init__(client_id=self.client_id, **kwargs)
             self.conn_setup.port = PORT_SSL
         self.client_id = self.conn_setup.hostname
         super().__init__(client_id=self.client_id, **kwargs)

-        self.log = Logger(self._log)
+        self._log = Logger(self._do_log)

         self.update_login(nick_confirmed=False,
                           nickname=self.conn_setup.nickname)
         self.update_login(nick_confirmed=False,
                           nickname=self.conn_setup.nickname)

-        self.log.add(f'connecting {self.conn_setup}')
+        self._log.add(f'connecting {self.conn_setup}')

         self.start_connecting()
 
     def start_connecting(self) -> None:
         self.start_connecting()
 
     def start_connecting(self) -> None:


@@ -200,7 +200,7 @@ class Client(ABC, ClientQueueMixin):
                                            client_id=self.client_id)
                 self._client_trigger('_on_connect')
             except IrcConnAbortException as e:
                                            client_id=self.client_id)
                 self._client_trigger('_on_connect')
             except IrcConnAbortException as e:

-                self.log.alert(str(e))
+                self._log.alert(str(e))

             except Exception as e:  # pylint: disable=broad-exception-caught
                 self._put(ExceptionEvent(e))
 
             except Exception as e:  # pylint: disable=broad-exception-caught
                 self._put(ExceptionEvent(e))
 


@@ -209,9 +209,9 @@ class Client(ABC, ClientQueueMixin):
     def _on_connect(self) -> None:
         'Steps to perform right after connection.'
         assert self.conn is not None
     def _on_connect(self) -> None:
         'Steps to perform right after connection.'
         assert self.conn is not None

-        self.log.add('connected to server (SSL: '
-                     f'{"yes" if self.conn.ssl else "no"})',
-                     stream=STREAM_GLOB)
+        self._log.add('connected to server (SSL: '
+                      f'{"yes" if self.conn.ssl else "no"})',
+                      stream=STREAM_GLOB)

         self._caps.challenge('LS', '302')
         self.send(IrcMessage(verb='USER',
                              params=(getuser(), '0', '*',
         self._caps.challenge('LS', '302')
         self.send(IrcMessage(verb='USER',
                              params=(getuser(), '0', '*',


@@ -219,7 +219,7 @@ class Client(ABC, ClientQueueMixin):
         self.send(IrcMessage(verb='NICK', params=(self.conn_setup.nickname,)))
 
     @abstractmethod
         self.send(IrcMessage(verb='NICK', params=(self.conn_setup.nickname,)))
 
     @abstractmethod

-    def _log(self, msg: str, stream: str = STREAM_SERVER) -> None:
+    def _do_log(self, msg: str, stream: str = STREAM_SERVER) -> None:

         'Write msg into log of stream, whatever shape that may have.'
 
     def send(self,
         'Write msg into log of stream, whatever shape that may have.'
 
     def send(self,


@@ -229,12 +229,12 @@ class Client(ABC, ClientQueueMixin):
              ) -> None:
         'Send line-separator-delimited message over socket.'
         if not self.conn:
              ) -> None:
         'Send line-separator-delimited message over socket.'
         if not self.conn:

-            self.log.alert('cannot send, connection seems closed')
+            self._log.alert('cannot send, connection seems closed')

             return
         self.conn.send(msg)
         if to_log:
             return
         self.conn.send(msg)
         if to_log:

-            self.log.add(to_log, prefix='', stream=stream)
-        self.log.add(msg.raw, prefix=_LOG_PREFIX_SEND_RAW, stream=STREAM_RAW)
+            self._log.add(to_log, prefix='', stream=stream)
+        self._log.add(msg.raw, prefix=_LOG_PREFIX_SEND_RAW, stream=STREAM_RAW)

 
     def update_login(self, nick_confirmed: bool, nickname: str = '') -> None:
         '''Manage conn_setup.nickname, .nick_confirmed.
 
     def update_login(self, nick_confirmed: bool, nickname: str = '') -> None:
         '''Manage conn_setup.nickname, .nick_confirmed.


@@ -247,17 +247,17 @@ class Client(ABC, ClientQueueMixin):
             verb = ('set' if first_run
                     else f'changed from "{self.conn_setup.nickname}"')
             self.conn_setup.nickname = nickname
             verb = ('set' if first_run
                     else f'changed from "{self.conn_setup.nickname}"')
             self.conn_setup.nickname = nickname

-            self.log.add(f'{prefix} {verb} to "{nickname}"',
-                         stream=STREAM_GLOB)
+            self._log.add(f'{prefix} {verb} to "{nickname}"',
+                          stream=STREAM_GLOB)

         if first_run or nick_confirmed != self.nick_confirmed:
             self.nick_confirmed = nick_confirmed
             if not first_run:
         if first_run or nick_confirmed != self.nick_confirmed:
             self.nick_confirmed = nick_confirmed
             if not first_run:

-                self.log.add(f'{prefix} {"" if nick_confirmed else "un"}'
-                             'confirmed')
+                self._log.add(f'{prefix} {"" if nick_confirmed else "un"}'
+                              'confirmed')

 
     def close(self) -> None:
         'Close both recv Loop and socket.'
 
     def close(self) -> None:
         'Close both recv Loop and socket.'

-        self.log.add(msg='disconnecting from server', stream=STREAM_GLOB)
+        self._log.add(msg='disconnecting from server', stream=STREAM_GLOB)

         self._caps.clear()
         if self.conn:
             self.conn.close()
         self._caps.clear()
         if self.conn:
             self.conn.close()


@@ -266,7 +266,7 @@ class Client(ABC, ClientQueueMixin):
 
     def handle_msg(self, msg: IrcMessage) -> None:
         'Process incoming msg towards appropriate client steps.'
 
     def handle_msg(self, msg: IrcMessage) -> None:
         'Process incoming msg towards appropriate client steps.'

-        self.log.add(msg.raw, prefix=_LOG_PREFIX_RECV_RAW, stream=STREAM_RAW)
+        self._log.add(msg.raw, prefix=_LOG_PREFIX_RECV_RAW, stream=STREAM_RAW)

         match msg.verb:
             case 'PING':
                 self.send(IrcMessage(verb='PONG', params=(msg.params[0],)))
         match msg.verb:
             case 'PING':
                 self.send(IrcMessage(verb='PONG', params=(msg.params[0],)))


@@ -276,12 +276,12 @@ class Client(ABC, ClientQueueMixin):
                 self.update_login(nickname=msg.params[0], nick_confirmed=True)
             case 'PRIVMSG':
                 nickname = msg.source.split('!')[0]
                 self.update_login(nickname=msg.params[0], nick_confirmed=True)
             case 'PRIVMSG':
                 nickname = msg.source.split('!')[0]

-                self.log.add(f'< [{nickname}] {msg.params[-1]}',
-                             stream=nickname,
-                             prefix=_LOG_PREFIX_PRIVMSG)
+                self._log.add(f'< [{nickname}] {msg.params[-1]}',
+                              stream=nickname,
+                              prefix=_LOG_PREFIX_PRIVMSG)

             case 'CAP':
                 for to_log in self._caps.process_msg(msg.params[1:]):
             case 'CAP':
                 for to_log in self._caps.process_msg(msg.params[1:]):

-                    self.log.add(to_log)
+                    self._log.add(to_log)

                 if self._caps.sasl_wait:
                     if self.conn_setup.password:
                         self.send(IrcMessage('AUTHENTICATE', ('PLAIN',)))
                 if self._caps.sasl_wait:
                     if self.conn_setup.password:
                         self.send(IrcMessage('AUTHENTICATE', ('PLAIN',)))


@@ -296,7 +296,7 @@ class Client(ABC, ClientQueueMixin):
                     self.send(IrcMessage('AUTHENTICATE', (auth,)))
             case '903' | '904':
                 if msg.verb == '904':
                     self.send(IrcMessage('AUTHENTICATE', (auth,)))
             case '903' | '904':
                 if msg.verb == '904':

-                    self.log.alert('SASL authentication failed')
+                    self._log.alert('SASL authentication failed')

                 self._caps.challenge('END')
 
 
                 self._caps.challenge('END')
 
 

diff --git a/ircplom/client_tui.py b/ircplom/client_tui.py
index d3182d974dc853766329feb209e04581355a14f6..acb5b463eba536b1c3d031dbadabaab6576e73e9 100644 (file)
--- a/ircplom/client_tui.py
+++ b/ircplom/client_tui.py
@@ -186,7 +186,7 @@ class _ClientKnowingTui(Client):
         self._put(TuiEvent.affector('for_client_do').kw(
             client_id=self.client_id, todo=todo, **kwargs))
 
         self._put(TuiEvent.affector('for_client_do').kw(
             client_id=self.client_id, todo=todo, **kwargs))
 

-    def _log(self, msg: str, stream: str = STREAM_SERVER) -> None:
+    def _do_log(self, msg: str, stream: str = STREAM_SERVER) -> None:

         self._client_tui_trigger('log', stream=stream, msg=msg)
 
     def update_login(self, nick_confirmed: bool, nickname: str = '') -> None:
         self._client_tui_trigger('log', stream=stream, msg=msg)
 
     def update_login(self, nick_confirmed: bool, nickname: str = '') -> None: