bear-utils 0.7.23__py3-none-any.whl → 0.7.24__py3-none-any.whl

bear_utils/extras/responses/function_response.py

@@ -5,12 +5,11 @@ from __future__ import annotations
 from io import StringIO
 import json
 from subprocess import CompletedProcess
-from typing import TYPE_CHECKING, Any, Literal, Self, overload
+from typing import Any, Literal, Self, overload
 
 from pydantic import BaseModel, Field, field_validator
 
-if TYPE_CHECKING:
-    from bear_utils.constants.logger_protocol import LoggerProtocol
+from bear_utils.constants.logger_protocol import LoggerProtocol  # noqa: TC001 # DO NOT PUT INTO A TYPE_CHECKING BLOCK
 
 SUCCESS: list[str] = ["name", "success"]
 FAILURE: list[str] = ["name"]
@@ -130,6 +129,25 @@ class FunctionResponse(BaseModel):
         """Check if the response indicates success."""
         return self.returncode == 0
 
+    def sub_task(
+        self,
+        name: str = "",
+        content: str | list[str] = "",
+        error: str | list[str] = "",
+        extra: dict[str, Any] | None = None,
+        returncode: int | None = None,
+        log_output: bool = False,
+    ) -> None:
+        """Add a sub-task response to the FunctionResponse."""
+        func_response: FunctionResponse = FunctionResponse(name=name, logger=self.logger).add(
+            content=content,
+            error=error,
+            returncode=returncode or self.returncode,
+            log_output=log_output,
+            extra=extra,
+        )
+        self.add(content=func_response)
+
     def successful(
         self,
         content: str | list[str] | CompletedProcess,
@@ -184,6 +202,19 @@ class FunctionResponse(BaseModel):
         except Exception as e:
             raise ValueError(f"Failed to add content: {e!s}") from e
 
+    def _handle_function_response(self, func_response: FunctionResponse) -> None:
+        """Handle a FunctionResponse object and update the current response."""
+        if func_response.extra:
+            self.extra.update(func_response.extra)
+        self._add_to_error(error=func_response.error, name=func_response.name)
+        self._add_to_content(content=func_response.content, name=func_response.name)
+
+    def _handle_completed_process(self, result: CompletedProcess[str]) -> None:
+        """Handle a CompletedProcess object and update the FunctionResponse."""
+        self._add_to_content(content=result.stdout.strip() if result.stdout else "")
+        self._add_to_error(error=result.stderr.strip() if result.stderr else "")
+        self.returncode = result.returncode
+
     def add(
         self,
         content: list[str] | str | FunctionResponse | CompletedProcess | None = None,
@@ -205,45 +236,49 @@ class FunctionResponse(BaseModel):
             Self: The updated FunctionResponse instance.
         """
         try:
-            if isinstance(content, FunctionResponse):
-                if content.extra:
-                    self.extra.update(content.extra)
-                self._add_to_error(error=content.error, name=content.name)
-                self._add_to_content(content=content.content, name=content.name)
-                self.number_of_tasks += 1
-            elif isinstance(content, CompletedProcess):
-                result: CompletedProcess[str] = content
-                self._add_to_content(content=result.stdout.strip() if result.stdout else "")
-                self._add_to_error(error=result.stderr.strip() if result.stderr else "")
-                self.returncode = result.returncode
-                self.number_of_tasks += 1
-            elif isinstance(content, str | list):
-                self._add_to_content(content=content)
-                self.number_of_tasks += 1
-            if isinstance(error, str | list):
-                self._add_to_error(error=error)
-            if returncode is not None:
-                self.returncode = returncode
-            if extra is not None and isinstance(extra, dict):
-                self.extra.update(extra)
-            if log_output and self.logger is not None:
-                if content is not None and error is None:
-                    if isinstance(content, list):
-                        for item in content:
-                            self.logger.info(message=f"{self.name}: {item}" if self.name else item)
-                    elif isinstance(content, str):
-                        self.logger.info(message=f"{self.name}: {content}" if self.name else content)
-                elif error is not None and content is None:
-                    if isinstance(error, list):
-                        for err in error:
-                            self.logger.error(message=f"{self.name}: {err}" if self.name else err)
-                    elif isinstance(error, str):
-                        self.logger.error(message=f"{self.name}: {error}" if self.name else error)
-
+            match content:
+                case FunctionResponse():
+                    self._handle_function_response(func_response=content)
+                    self.number_of_tasks += 1
+                case CompletedProcess():
+                    self._handle_completed_process(result=content)
+                    self.number_of_tasks += 1
+                case str() | list() if content:
+                    self._add_to_content(content=content)
+                    self.number_of_tasks += 1
+                case None:
+                    content = None
+                case _:
+                    content = None
+            self._add_to_error(error=error) if isinstance(error, (str | list)) else None
+            self.returncode = returncode if returncode is not None else self.returncode
+            self.extra.update(extra) if isinstance(extra, dict) else None
+            if log_output and self.logger is not None and (content is not None or error is not None):
+                self._log_handling(content=content, error=error, logger=self.logger)
         except Exception as e:
             raise ValueError(f"Failed to add content: {e!s}") from e
         return self
 
+    def _log_handling(
+        self,
+        content: list[str] | str | FunctionResponse | CompletedProcess | None,
+        error: str | list[str] | None,
+        logger: LoggerProtocol,
+    ) -> None:
+        """Log the content and error messages if they exist."""
+        if content is not None and error is None:
+            if isinstance(content, list):
+                for item in content:
+                    logger.info(message=f"{self.name}: {item}" if self.name else item)
+            elif isinstance(content, str):
+                logger.info(message=f"{self.name}: {content}" if self.name else content)
+        elif error is not None and content is None:
+            if isinstance(error, list):
+                for err in error:
+                    logger.error(message=f"{self.name}: {err}" if self.name else err)
+            elif isinstance(error, str):
+                logger.error(message=f"{self.name}: {error}" if self.name else error)
+
     @overload
     def done(self, to_dict: Literal[True], suppress: list[str] | None = None) -> dict[str, Any]: ...
 

bear_utils/files/file_handlers/_base_file_handler.py

@@ -8,12 +8,6 @@ P = ParamSpec("P")
 R = TypeVar("R")
 
 
-def check_data_type(data: dict[str, Any] | str, valid_types: tuple[type, ...]) -> None:
-    """Check if the data is of a valid type for text files."""
-    if not isinstance(data, valid_types):
-        raise TypeError(f"Data must be one of {valid_types}, got {type(data)}")
-
-
 class FileHandler(ABC):
     """Abstract class for file handling with read, write, and present methods
 
@@ -40,7 +34,7 @@ class FileHandler(ABC):
         return file_path.suffix.lstrip(".") in cls.valid_extensions
 
     @classmethod
-    def check_data_type(cls, data: Any) -> Any:
+    def check_data_type(cls, data: dict[str, Any] | str, valid_types: tuple[type, ...]) -> None:
         """Check if the data is of the correct type.
 
         Args:
@@ -49,8 +43,8 @@ class FileHandler(ABC):
         Returns:
             bool: True if the data is of the correct type, False otherwise
         """
-        if not isinstance(data, cls.valid_types):
-            raise TypeError(f"Data must be one of {cls.valid_types}, got {type(data)}")
+        if not isinstance(data, valid_types):
+            raise TypeError(f"Data must be one of {valid_types}, got {type(data)}")
 
     @classmethod
     def ValidateFileType(cls, method: Callable[P, R]) -> Callable[P, R]:  # noqa: N802 disable=invalid-name

bear_utils/files/file_handlers/json_file_handler.py

@@ -4,7 +4,7 @@ import json
 from pathlib import Path
 from typing import Any, ClassVar, overload
 
-from ._base_file_handler import FileHandler, check_data_type
+from ._base_file_handler import FileHandler
 
 
 class JsonFileHandler(FileHandler):
@@ -44,7 +44,7 @@ class JsonFileHandler(FileHandler):
         """Write data to a JSON file."""
         try:
             super().write_file(file_path=file_path, data=data)
-            check_data_type(data=data, valid_types=self.valid_types)
+            self.check_data_type(data=data, valid_types=self.valid_types)
             data = self.present_file(data, indent=indent, sort_keys=sort_keys)
             file_path.write_text(data=data, encoding="utf-8")
         except Exception as e:

bear_utils/files/file_handlers/log_file_handler.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 from typing import Any, ClassVar, cast
 
-from ._base_file_handler import FileHandler, check_data_type
+from ._base_file_handler import FileHandler
 
 
 class LogFileHandler(FileHandler):
@@ -27,7 +27,7 @@ class LogFileHandler(FileHandler):
         """Write data to a log file."""
         try:
             super().write_file(file_path=file_path, data=data)
-            check_data_type(data=data, valid_types=self.valid_types)
+            self.check_data_type(data=data, valid_types=self.valid_types)
             with open(file_path, "w", encoding="utf-8") as file:
                 file.write(cast("str", data))
         except Exception as e:

bear_utils/files/file_handlers/toml_file_handler.py

@@ -30,7 +30,7 @@ class TomlFileHandler(FileHandler):
         """Write data to a TOML file."""
         try:
             super().write_file(file_path=file_path, data=data)
-
+            self.check_data_type(data=data, valid_types=self.valid_types)
             with open(file_path, "w", encoding="utf-8") as file:
                 if isinstance(data, dict):
                     toml.dump(data, file, **kwargs)

bear_utils/files/file_handlers/txt_file_handler.py

@@ -4,7 +4,7 @@ import json
 from pathlib import Path
 from typing import Any, ClassVar, overload
 
-from ._base_file_handler import FileHandler, check_data_type
+from ._base_file_handler import FileHandler
 
 
 class TextFileHandler(FileHandler):
@@ -44,7 +44,7 @@ class TextFileHandler(FileHandler):
         """Write data to a text file."""
         try:
             super().write_file(file_path=file_path, data=data)
-            check_data_type(data, self.valid_types)
+            self.check_data_type(data=data, valid_types=self.valid_types)
             if isinstance(data, dict):
                 data = json.dumps(data, indent=indent, sort_keys=sort_keys)
             elif isinstance(data, list):

bear_utils/files/file_handlers/yaml_file_handler.py

@@ -50,6 +50,7 @@ class YamlFileHandler(FileHandler):
         """Write data to a YAML file."""
         try:
             super().write_file(file_path=file_path, data=data)
+            self.check_data_type(data=data, valid_types=self.valid_types)
             with open(file=file_path, mode="w", encoding="utf-8") as file:
                 yaml.dump(data, stream=file, default_flow_style=False, sort_keys=False, **kwargs)
         except Exception as e:

{bear_utils-0.7.23.dist-info → bear_utils-0.7.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bear-utils
-Version: 0.7.23
+Version: 0.7.24
 Summary: Various utilities for Bear programmers, including a rich logging utility, a disk cache, and a SQLite database wrapper amongst other things.
 Author-email: chaz <bright.lid5647@fastmail.com>
 Requires-Python: >=3.12
@@ -20,7 +20,7 @@ Requires-Dist: tinydb>=4.8.2
 Requires-Dist: toml>=0.10.2
 Description-Content-Type: text/markdown
 
-# Bear Utils v# Bear Utils v0.7.23
+# Bear Utils v# Bear Utils v0.7.24
 
 Personal set of tools and utilities for Python projects, focusing on modularity and ease of use. This library includes components for caching, database management, logging, time handling, file operations, CLI prompts, image processing, clipboard interaction, gradient utilities, event systems, and async helpers.
 

{bear_utils-0.7.23.dist-info → bear_utils-0.7.24.dist-info}/RECORD

@@ -33,19 +33,19 @@ bear_utils/extras/_async_helpers.py,sha256=cxq5d24NHkECmZqTVXEazv6K-XUa7skFnX6KQ
 bear_utils/extras/_tools.py,sha256=OYzGEEp7F6H6qr1t1QlnHTnAb4JaH6p9_maSXeDGFFM,7681
 bear_utils/extras/platform_utils.py,sha256=Ai7ow7S-_cKb5zFwFh8dkC8xmbMJFy-0_-w3NCERdEw,1362
 bear_utils/extras/responses/__init__.py,sha256=U5InC9ec9OI-f_eCi78z8UJsqtgEA5PGBvu94yvgjnA,89
-bear_utils/extras/responses/function_response.py,sha256=GJCYKKXC5U4lT-mBf40YZj5a6UIS3bCRn0qzwM-CETM,12718
+bear_utils/extras/responses/function_response.py,sha256=Zis2uIpGp3Mqbpc0RszyNt2JSsLAiGmWKhgezLjzUTM,14153
 bear_utils/extras/wrappers/__init__.py,sha256=crh4sKOLvuhNMVX5bJYjCFWtXtH7G47UgNPOHq3HXTk,43
 bear_utils/extras/wrappers/add_methods.py,sha256=z2XZG2ZoYOB1MaGiLli4NRyyTeRgBy7tuYsiy8mTa9s,4422
 bear_utils/files/__init__.py,sha256=mIdnFSXoDE64ElM43bN2m6KuafURnN82ki0pdqN8q2o,201
 bear_utils/files/ignore_parser.py,sha256=ipBqUH5ndipPSq27TEsGDa7Sqq53KrczGLZcnNbW9F0,10951
 bear_utils/files/file_handlers/__init__.py,sha256=VF2IlWNr3UqeSvsbh3YCbLw9cLmlyf64mfeOKuhBdvk,136
-bear_utils/files/file_handlers/_base_file_handler.py,sha256=2Df8s-tNfsiQtV_pVFaDJe2sS_edPHbeR9nd5htgfwg,3960
+bear_utils/files/file_handlers/_base_file_handler.py,sha256=Fl45rAuKSY-fVYBP-7o7op6thXlX8FLQbgwXEt4gDLQ,3726
 bear_utils/files/file_handlers/file_handler_factory.py,sha256=fDo2UcWp5-pOMtVWKCTuz-Fw4qSIB9fg5FgNRoYR6g4,9931
-bear_utils/files/file_handlers/json_file_handler.py,sha256=DvGvQ8D4ZFHHswtQQXmuiEY9HMkFA0o68u0_ekwwiXQ,2668
-bear_utils/files/file_handlers/log_file_handler.py,sha256=5yqW-ASikC4T0QPA7dkk-Putc8bEkg2MmZr_RCzYAvI,1542
-bear_utils/files/file_handlers/toml_file_handler.py,sha256=7eXDJBF-376NPe1uq7_Rsy3mER0sbbD5mBahvPJGsm8,2626
-bear_utils/files/file_handlers/txt_file_handler.py,sha256=24PLekOUUh_4XHGHCN61xqlubcM1GWgP6vonzEfoqac,2757
-bear_utils/files/file_handlers/yaml_file_handler.py,sha256=B1R-HgQYkqM93EoXDm0nYPje23KnvEI_sGxpX7lk2OM,2462
+bear_utils/files/file_handlers/json_file_handler.py,sha256=0kqsG5QErFc3TVbK1I1l4cdzSxT6mYCmNuaW7hpFkYo,2656
+bear_utils/files/file_handlers/log_file_handler.py,sha256=RDPOqNE_ujL_IIjfqi89LXNd4jntQ0bYTGqRVKiC_CU,1530
+bear_utils/files/file_handlers/toml_file_handler.py,sha256=YPC9Y8DEURS9v3lV_iEng6URP0q97oDD74qdN870rhg,2699
+bear_utils/files/file_handlers/txt_file_handler.py,sha256=Et_AxKEb3_XpVfJYIIsrHqvmDNXzzrBjmn2Ost3bPPA,2762
+bear_utils/files/file_handlers/yaml_file_handler.py,sha256=iUFAJle2t67SX6uvPiutjdO8gSU1q_rXrZXH9MnJygg,2536
 bear_utils/graphics/__init__.py,sha256=uR_NFKfskJGDPT0PGiw38rRniV945H67fvDALxUTnVw,268
 bear_utils/graphics/bear_gradient.py,sha256=36B9hjU_qDjdgZaVcRl4jE3uQyU8k8G_MiORFzaendE,5272
 bear_utils/graphics/image_helpers.py,sha256=AaDQm6uunIdVkcMSXmoiaNQ68zRQQJ6bbhoApk6GSKU,1649
@@ -78,6 +78,6 @@ bear_utils/monitoring/__init__.py,sha256=9DKNIWTp_voLnaWgiP-wJ-o_N0hYixo-MzjUmg8
 bear_utils/monitoring/_common.py,sha256=LYQFxgTP9fk0cH71IQTuGwBYYPWCqHP_mMRNecoD76M,657
 bear_utils/monitoring/host_monitor.py,sha256=iawDGJWvByUnTanJvgiZMlqSJr3JpEWJdgA99A-fol0,13214
 bear_utils/time/__init__.py,sha256=d9Ovv-Dlx5NWgnOl1hY-evznVm9hboS6ypNp1wDFxQQ,934
-bear_utils-0.7.23.dist-info/METADATA,sha256=wXfmG9H_JcV1OF_uoLJNbIxnVQ2ieEoMXUPa450yTtM,8629
-bear_utils-0.7.23.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bear_utils-0.7.23.dist-info/RECORD,,
+bear_utils-0.7.24.dist-info/METADATA,sha256=UMrwess6tydfPIEh_rszg6XqQ_YyF9VYHgyVpRAn864,8629
+bear_utils-0.7.24.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bear_utils-0.7.24.dist-info/RECORD,,