pep/poezio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

logger: Prefix private functions with an underscore.

Browse source
This commit is contained in:
Emmanuel Gil Peyrot 2018-10-16 19:39:12 +02:00
parent d626aa1533
commit a630f4a13d
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
poezio/logger.py
View file

@ -56,7 +56,7 @@ class LogMessage(LogItem):
self.nick = nick self.nick = nick
def parse_log_line(msg: str) -> Optional[LogItem]: def _parse_log_line(msg: str) -> Optional[LogItem]:
match = re.match(MESSAGE_LOG_RE, msg) match = re.match(MESSAGE_LOG_RE, msg)
if match: if match:
return LogMessage(*match.groups()) return LogMessage(*match.groups())
@ -169,14 +169,14 @@ class Logger:
# do that efficiently, instead of seek()s and read()s which are costly. # do that efficiently, instead of seek()s and read()s which are costly.
with fd: with fd:
try: try:
lines = get_lines_from_fd(fd, nb=nb) lines = _get_lines_from_fd(fd, nb=nb)
except Exception: # file probably empty except Exception: # file probably empty
log.error( log.error(
'Unable to mmap the log file for (%s)', 'Unable to mmap the log file for (%s)',
filename, filename,
exc_info=True) exc_info=True)
return None return None
return parse_log_lines(lines) return _parse_log_lines(lines)
def log_message(self, def log_message(self,
jid: str, jid: str,
@ -193,7 +193,7 @@ class Logger:
""" """
if not config.get_by_tabname('use_log', jid): if not config.get_by_tabname('use_log', jid):
return True return True
logged_msg = build_log_message(nick, msg, date=date, typ=typ) logged_msg = _build_log_message(nick, msg, date=date, typ=typ)
if not logged_msg: if not logged_msg:
return True return True
if jid in self._fds.keys(): if jid in self._fds.keys():
@ -260,10 +260,10 @@ class Logger:
return True return True
def build_log_message(nick: str, def _build_log_message(nick: str,
msg: str, msg: str,
date: Optional[datetime] = None, date: Optional[datetime] = None,
typ: int = 1) -> str: typ: int = 1) -> str:
""" """
Create a log message from a nick, a message, optionally a date and type Create a log message from a nick, a message, optionally a date and type
message types: message types:
@ -290,7 +290,7 @@ def build_log_message(nick: str,
return logged_msg + ''.join(' %s\n' % line for line in lines) return logged_msg + ''.join(' %s\n' % line for line in lines)
def get_lines_from_fd(fd: IO[Any], nb: int = 10) -> List[str]: def _get_lines_from_fd(fd: IO[Any], nb: int = 10) -> List[str]:
""" """
Get the last log lines from a fileno Get the last log lines from a fileno
""" """
@ -309,7 +309,7 @@ def get_lines_from_fd(fd: IO[Any], nb: int = 10) -> List[str]:
return lines return lines
def parse_log_lines(lines: List[str]) -> List[Dict[str, Any]]: def _parse_log_lines(lines: List[str]) -> List[Dict[str, Any]]:
""" """
Parse raw log lines into poezio log objects Parse raw log lines into poezio log objects
""" """
@ -323,7 +323,7 @@ def parse_log_lines(lines: List[str]) -> List[Dict[str, Any]]:
idx += 1 idx += 1
log.debug('fail?') log.debug('fail?')
continue continue
log_item = parse_log_line(lines[idx]) log_item = _parse_log_line(lines[idx])
idx += 1 idx += 1
if not isinstance(log_item, LogItem): if not isinstance(log_item, LogItem):
log.debug('wrong log format? %s', log_item) log.debug('wrong log format? %s', log_item)