qase-python-commons 4.0.1__py3-none-any.whl → 4.1.0__py3-none-any.whl

qase/commons/config.py

@@ -1,18 +1,28 @@
 import os
 import json
-from .logger import Logger
+from .logger import Logger, LoggingOptions
 from .models.config.qaseconfig import QaseConfig, Mode
+from .utils import QaseUtils
 
 
 class ConfigManager:
 
     def __init__(self, config_file='./qase.config.json'):
-        self.logger = Logger()
         self.__config_file = config_file
         self.config = QaseConfig()
 
+        # Initialize temporary logger for error handling during config loading
+        self.logger = Logger(debug=False)
+        
         self.__load_file_config()
         self.__load_env_config()
+        
+        # Re-initialize logger with proper logging options after config is loaded
+        logging_options = LoggingOptions(
+            console=self.config.logging.console if self.config.logging.console is not None else True,
+            file=self.config.logging.file if self.config.logging.file is not None else self.config.debug
+        )
+        self.logger = Logger(debug=self.config.debug, logging_options=logging_options)
 
     def validate_config(self):
         errors: list[str] = []
@@ -201,6 +211,9 @@ class ConfigManager:
                                         xfail_status.get("xpass")
                                     )
 
+                    if config.get("logging"):
+                        self.config.set_logging(config.get("logging"))
+
         except Exception as e:
             self.logger.log("Failed to load config from file", "error")
 
@@ -326,5 +339,11 @@ class ConfigManager:
                 if key == 'QASE_PYTEST_XFAIL_STATUS_XPASS':
                     self.config.framework.pytest.xfail_status.set_xpass(value)
 
+                if key == 'QASE_LOGGING_CONSOLE':
+                    self.config.logging.set_console(QaseUtils.parse_bool(value))
+
+                if key == 'QASE_LOGGING_FILE':
+                    self.config.logging.set_file(QaseUtils.parse_bool(value))
+
         except Exception as e:
-            self.logger.log("Failed to load config from env vars {e}", "error")
+            self.logger.log(f"Failed to load config from env vars {e}", "error")

qase/commons/logger.py

@@ -1,14 +1,39 @@
 import os
 import datetime
 import threading
+from typing import Optional
+
+
+class LoggingOptions:
+    def __init__(self, console: bool = True, file: bool = False):
+        self.console = console
+        self.file = file
 
 
 class Logger:
     _log_file = None
 
-    def __init__(self, debug: bool = False, prefix: str = '', dir: str = os.path.join('.', 'logs')) -> None:
+    def __init__(self, debug: bool = False, prefix: str = '', dir: str = os.path.join('.', 'logs'), 
+                 logging_options: Optional[LoggingOptions] = None) -> None:
         self.debug = debug
-        if self.debug:
+        self.prefix = prefix
+        self.dir = dir
+        
+        # Initialize logging options
+        if logging_options is None:
+            # Default behavior: console always enabled, file enabled only in debug mode
+            self.logging_options = LoggingOptions(
+                console=True,
+                file=debug
+            )
+        else:
+            self.logging_options = logging_options
+        
+        # Override with environment variables if set
+        self._load_env_logging_options()
+        
+        # Setup file logging if enabled
+        if self.logging_options.file:
             if Logger._log_file is None:
                 timestamp = self._get_timestamp()
                 filename = f'{prefix}_{timestamp}.log'
@@ -21,16 +46,38 @@ class Logger:
 
             self.lock = threading.Lock()
 
+    def _load_env_logging_options(self):
+        """Load logging options from environment variables"""
+        # QASE_LOGGING_CONSOLE
+        console_env = os.environ.get('QASE_LOGGING_CONSOLE')
+        if console_env is not None:
+            self.logging_options.console = console_env.lower() in ('true', '1', 'yes', 'on')
+        
+        # QASE_LOGGING_FILE
+        file_env = os.environ.get('QASE_LOGGING_FILE')
+        if file_env is not None:
+            self.logging_options.file = file_env.lower() in ('true', '1', 'yes', 'on')
+        
+        # Legacy QASE_DEBUG support
+        debug_env = os.environ.get('QASE_DEBUG')
+        if debug_env is not None and debug_env.lower() in ('true', '1', 'yes', 'on'):
+            # When debug is enabled via env, enable file logging if not explicitly disabled
+            if not hasattr(self.logging_options, 'file') or self.logging_options.file is None:
+                self.logging_options.file = True
+
     def log(self, message: str, level: str = 'info'):
         time_str = self._get_timestamp("%H:%M:%S")
         log = f"[Qase][{time_str}][{level}] {message}\n"
 
-        try:
-            print(log, end='')
-        except (OSError, IOError):
-            pass
+        # Console output
+        if self.logging_options.console:
+            try:
+                print(log, end='')
+            except (OSError, IOError):
+                pass
 
-        if self.debug:
+        # File output
+        if self.logging_options.file:
             with self.lock:
                 with open(Logger._log_file, 'a', encoding='utf-8') as f:
                     f.write(log)
@@ -39,6 +86,15 @@ class Logger:
         if self.debug:
             self.log(message, 'debug')
 
+    def log_error(self, message: str):
+        self.log(message, 'error')
+
+    def log_warning(self, message: str):
+        self.log(message, 'warning')
+
+    def log_info(self, message: str):
+        self.log(message, 'info')
+
     @staticmethod
     def _get_timestamp(fmt: str = "%Y%m%d"):
         now = datetime.datetime.now()

qase/commons/models/config/qaseconfig.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import List, Dict
+from typing import List, Dict, Optional
 
 from .framework import Framework
 from .report import ReportConfig
@@ -14,6 +14,21 @@ class Mode(Enum):
     off = "off"
 
 
+class LoggingConfig(BaseModel):
+    console: Optional[bool] = None
+    file: Optional[bool] = None
+
+    def __init__(self):
+        self.console = None
+        self.file = None
+
+    def set_console(self, console: bool):
+        self.console = console
+
+    def set_file(self, file: bool):
+        self.file = file
+
+
 class ExecutionPlan(BaseModel):
     path: str = None
 
@@ -37,6 +52,7 @@ class QaseConfig(BaseModel):
     framework: Framework = None
     exclude_params: list = None
     status_mapping: Dict[str, str] = None
+    logging: LoggingConfig = None
 
     def __init__(self):
         self.mode = Mode.off
@@ -49,6 +65,7 @@ class QaseConfig(BaseModel):
         self.profilers = []
         self.exclude_params = []
         self.status_mapping = {}
+        self.logging = LoggingConfig()
 
     def set_mode(self, mode: str):
         if any(mode == e.value for e in Mode.__members__.values()):
@@ -75,3 +92,9 @@ class QaseConfig(BaseModel):
 
     def set_status_mapping(self, status_mapping: Dict[str, str]):
         self.status_mapping = status_mapping
+
+    def set_logging(self, logging_config: dict):
+        if logging_config.get("console") is not None:
+            self.logging.set_console(QaseUtils.parse_bool(logging_config.get("console")))
+        if logging_config.get("file") is not None:
+            self.logging.set_file(QaseUtils.parse_bool(logging_config.get("file")))

qase/commons/reporters/core.py

@@ -24,7 +24,8 @@ class QaseCoreReporter:
                  reporter_name: Union[str, None] = None):
         config.validate_config()
         self.config = config.config
-        self.logger = Logger(self.config.debug)
+        # Use the logger from ConfigManager instead of creating a new one
+        self.logger = config.logger
         self._execution_plan = None
         self.profilers = []
         self.overhead = 0

{qase_python_commons-4.0.1.dist-info → qase_python_commons-4.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qase-python-commons
-Version: 4.0.1
+Version: 4.1.0
 Summary: A library for Qase TestOps and Qase Report
 Author-email: Qase Team <support@qase.io>
 Project-URL: Homepage, https://github.com/qase-tms/qase-python/tree/main/qase-python-commons

{qase_python_commons-4.0.1.dist-info → qase_python_commons-4.1.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 qase/__init__.py,sha256=FLefSJnT6MTsTfZSDjMbMImI6674fAoJ5ZT3PNWGcRo,37
 qase/commons/__init__.py,sha256=3HI65PJES4Q6YvtkSuRPh6tZboTETJo8wbdHlNYaePU,323
-qase/commons/config.py,sha256=EnbPrICXG5kJ6lQGSQO4ZuBqikngmZVbH2bcCxR3qWk,14204
+qase/commons/config.py,sha256=ivunk-6IBfsXyRf-_Y_Je_K8boD4gDupv8v2Yf3nm2M,15162
 qase/commons/loader.py,sha256=-MMY4HgSI6q1xq3NaJoq_w4liM73qdFKjYLVCT1E7Pc,1064
-qase/commons/logger.py,sha256=KEQr8G0eFZxlI3LJIaaNWOKD8o3NhKsZD06swXFn3FI,1313
+qase/commons/logger.py,sha256=V_QTSDWNnUgd0j58rydYYN1AYOu3wa9T2fWjpOyxyuA,3430
 qase/commons/utils.py,sha256=utPRoYyThLs2tgD1lmjkwJ9KZuE7ZjliUiZkJJWFca0,3330
 qase/commons/client/api_v1_client.py,sha256=_dpvldRonALKubInPU03hYhyGJqxeq3DiIuyjDeOngg,11543
 qase/commons/client/api_v2_client.py,sha256=GsIrXJcBw6GtzvJjbjMYa0tvUIxEEe4pALRN2LBMKPM,9043
@@ -22,7 +22,7 @@ qase/commons/models/config/batch.py,sha256=X0H8SVOCCD2pV6LSMqjI-tIjRcLifnrM5Mare
 qase/commons/models/config/connection.py,sha256=wK2fGjc0G0rMVVhPnjw_t_M1YWZwANlhwl-awmI7XSo,516
 qase/commons/models/config/framework.py,sha256=sSWKQp18zxiS_79_XDH2hkHLpYEQnyH3bRquaT8XYYY,1803
 qase/commons/models/config/plan.py,sha256=JbAY7qfGXYreXOLa32OLxw6z0paeCCf87-2b1m8xkks,137
-qase/commons/models/config/qaseconfig.py,sha256=69uiGwgD9Pau1D5hMjGxFIMRKIKF9G_peQGc1DOLEI8,2111
+qase/commons/models/config/qaseconfig.py,sha256=oWc03PKV8-jb3JNgs_tqQP-22wsKZW25eSaAacYl4no,2838
 qase/commons/models/config/report.py,sha256=g3Z2B3Tewaasjc1TMj2mkXxz0Zc1C39sHeTXH0MRM2Y,497
 qase/commons/models/config/run.py,sha256=UGE5PA_EyiFpfIev-TOob1BocxT1vdUdWW3ELMD58zQ,1239
 qase/commons/models/config/testops.py,sha256=rJ9wW-VMt-5XaoPdRUKeM9rlV0eTiRINEhEulFVczv0,1893
@@ -31,7 +31,7 @@ qase/commons/profilers/db.py,sha256=Am1tvvLgJq4_A8JsuSeBGf47BD2lnSX-5KiMjSgr-Ko,
 qase/commons/profilers/network.py,sha256=zKNBnTQG4BMg8dn8O--tQzQLpu-qs5ADhHEnqIas0gM,4950
 qase/commons/profilers/sleep.py,sha256=HT6h0R-2XHZAoBYRxS2T_KC8RrnEoVjP7MXusaE4Nec,1624
 qase/commons/reporters/__init__.py,sha256=J0aNLzb_MPPT_zF8BtX_w9nj_U7Ad06RGpyWK5Pxq1o,169
-qase/commons/reporters/core.py,sha256=4MpiCGypoW0yso2BFjSvE3uTLCTbOinfwoIiYTdLIo4,9477
+qase/commons/reporters/core.py,sha256=FJx1kxXkUz9vwkSAXapkNS3vF97Igvlq7Yyjp-4BpeI,9539
 qase/commons/reporters/report.py,sha256=ZLwtVn5gjwgJFtfbpLUO-vW3M3skEq3AhKJwtmM0nUw,4810
 qase/commons/reporters/testops.py,sha256=uph_8upIt5bu4ncqyK7ehXR9NqtpZ34wGUBFLVJKOpE,7481
 qase/commons/status_mapping/__init__.py,sha256=NPsWKDC7rGSCYfVunnGnHxL0_HmKWH7RBaMjWTH_Mtk,322
@@ -39,7 +39,7 @@ qase/commons/status_mapping/status_mapping.py,sha256=kohSLNK6_qbMSP-M8gxHTTmOECg
 qase/commons/util/__init__.py,sha256=0sRRfrMOIPCHpk9tXM94Pj10qrk18B61qEcbLpRjw_I,74
 qase/commons/util/host_data.py,sha256=n8o5PDs8kELCZZ5GR7Jug6LsgZHWJudU7iRmZHRdrlw,5264
 qase/commons/validators/base.py,sha256=wwSn-4YiuXtfGMGnSKgo9Vm5hAKevVmmfd2Ro6Q7MYQ,173
-qase_python_commons-4.0.1.dist-info/METADATA,sha256=vZW1syFDf3ekHfwfHNEP1HG4LKOH9_do81VCE5hTGgg,1982
-qase_python_commons-4.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-qase_python_commons-4.0.1.dist-info/top_level.txt,sha256=Mn5aFk7H7Uia4s1NRDsvebu8vCrFy9nOuRIBfkIY5kQ,5
-qase_python_commons-4.0.1.dist-info/RECORD,,
+qase_python_commons-4.1.0.dist-info/METADATA,sha256=JcshiFrQAEhDrqLCi3QflCIJcPMfDF4qLsEqLt-ansE,1982
+qase_python_commons-4.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+qase_python_commons-4.1.0.dist-info/top_level.txt,sha256=Mn5aFk7H7Uia4s1NRDsvebu8vCrFy9nOuRIBfkIY5kQ,5
+qase_python_commons-4.1.0.dist-info/RECORD,,