Skip to content

Commit b841844

Browse files
committed
refactor: update logging format to use %-style for consistency
1 parent 843e12c commit b841844

2 files changed

Lines changed: 20 additions & 49 deletions

File tree

src/mistapi/__api_session.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ def _load_env(self, env_file=None) -> None:
308308
os.path.expanduser("~"), env_file.replace("~/", "")
309309
)
310310
env_file = os.path.abspath(env_file)
311-
CONSOLE.debug(f"Loading settings from {env_file}")
311+
CONSOLE.debug("Loading settings from %s", env_file)
312312
LOGGER.debug("apisession:_load_env:loading settings from %s", env_file)
313313
dotenv_path = Path(env_file)
314314
load_dotenv(dotenv_path=dotenv_path, override=True)
@@ -389,10 +389,10 @@ def set_cloud(self, cloud_uri: str) -> None:
389389
LOGGER.debug(
390390
"apisession:set_cloud:Mist Cloud configured to %s", self._cloud_uri
391391
)
392-
CONSOLE.debug(f"Mist Cloud configured to {self._cloud_uri}")
392+
CONSOLE.debug("Mist Cloud configured to %s", self._cloud_uri)
393393
else:
394394
LOGGER.error("apisession:set_cloud: %s is not valid", cloud_uri)
395-
CONSOLE.error(f"{cloud_uri} is not valid")
395+
CONSOLE.error("%s is not valid", cloud_uri)
396396

397397
def get_cloud(self):
398398
"""
@@ -467,7 +467,7 @@ def set_email(self, email: str | None = None) -> None:
467467
else:
468468
self.email = input("Login: ")
469469
LOGGER.info("apisession:set_email:email configured to %s", self.email)
470-
CONSOLE.debug(f"Email configured to {self.email}")
470+
CONSOLE.debug("Email configured to %s", self.email)
471471

472472
def set_password(self, password: str | None = None) -> None:
473473
"""
@@ -713,7 +713,7 @@ def _process_login(self, retry: bool = True) -> str | None:
713713
LOGGER.error(
714714
"apisession:_process_login:authentication failed:%s", error
715715
)
716-
CONSOLE.error(f"Authentication failed: {error}\r\n")
716+
CONSOLE.error("Authentication failed: %s\r\n", error)
717717
self.email = None
718718
self._password = None
719719
LOGGER.info(

src/mistapi/__logger.py

Lines changed: 15 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -150,60 +150,31 @@ def sanitize(self, data) -> str:
150150
sanitized_data = self.sensitive_pattern.sub(r'\1"******"', data_str)
151151
return sanitized_data
152152

153-
def critical(self, message) -> None:
154-
"""
155-
Docstring for critical
153+
def _format(self, message, args) -> str:
154+
"""Apply %-style formatting if args are provided, then sanitize."""
155+
if args:
156+
message = str(message) % args
157+
return self.sanitize(message)
156158

157-
:param self: Description
158-
:param message: Description
159-
:type message: str
160-
"""
159+
def critical(self, message, *args) -> None:
161160
if self.level <= 50 and self.level > 0:
162-
print(f"[{magenta('CRITICAL ')}] {self.sanitize(message)}")
163-
164-
def error(self, message) -> None:
165-
"""
166-
Docstring for error
161+
print(f"[{magenta('CRITICAL ')}] {self._format(message, args)}")
167162

168-
:param self: Description
169-
:param message: Description
170-
:type message: str
171-
"""
163+
def error(self, message, *args) -> None:
172164
if self.level <= 40 and self.level > 0:
173-
print(f"[{red(' ERROR ')}] {self.sanitize(message)}")
174-
175-
def warning(self, message) -> None:
176-
"""
177-
Docstring for warning
165+
print(f"[{red(' ERROR ')}] {self._format(message, args)}")
178166

179-
:param self: Description
180-
:param message: Description
181-
:type message: str
182-
"""
167+
def warning(self, message, *args) -> None:
183168
if self.level <= 30 and self.level > 0:
184-
print(f"[{yellow(' WARNING ')}] {self.sanitize(message)}")
185-
186-
def info(self, message) -> None:
187-
"""
188-
Docstring for info
169+
print(f"[{yellow(' WARNING ')}] {self._format(message, args)}")
189170

190-
:param self: Description
191-
:param message: Description
192-
:type message: str
193-
"""
171+
def info(self, message, *args) -> None:
194172
if self.level <= 20 and self.level > 0:
195-
print(f"[{green(' INFO ')}] {self.sanitize(message)}")
173+
print(f"[{green(' INFO ')}] {self._format(message, args)}")
196174

197-
def debug(self, message) -> None:
198-
"""
199-
Docstring for debug
200-
201-
:param self: Description
202-
:param message: Description
203-
:type message: str
204-
"""
175+
def debug(self, message, *args) -> None:
205176
if self.level <= 10 and self.level > 0:
206-
print(f"[{white('DEBUG ')}] {self.sanitize(message)}")
177+
print(f"[{white('DEBUG ')}] {self._format(message, args)}")
207178

208179
def _set_log_level(
209180
self, console_log_level: int = 20, logging_log_level: int = 10

0 commit comments

Comments
 (0)