swarmauri_tool_subprocess 0.11.0.dev3__py3-none-any.whl

swarmauri_tool_subprocess/SubprocessTool.py

@@ -0,0 +1,128 @@
+"""
+SubprocessTool.py
+
+Provide a tool for executing shell commands via Python's ``subprocess``
+module.
+
+This module exposes ``SubprocessTool``, a first-class Swarmauri tool that
+runs a command in a subprocess and returns a structured result containing
+``status``, ``stdout``, ``stderr``, and ``exit_code``. It defaults to
+``shell=False`` and supports both string
+commands (split via ``shlex``) and explicit argument vectors.
+"""
+
+from typing import Dict, List, Literal, Optional, Union
+
+from pydantic import Field
+from swarmauri_base.ComponentBase import ComponentBase  # type: ignore[import-untyped]
+from swarmauri_base.tools.ParameterBase import ParameterBase  # type: ignore[import-untyped]
+from swarmauri_base.tools.ToolBase import ToolBase  # type: ignore[import-untyped]
+
+
+from swarmauri_process_subprocess import SubprocessBackend
+
+
+@ComponentBase.register_type(ToolBase, "SubprocessTool")
+class SubprocessTool(ToolBase):  # type: ignore[misc]
+    """
+    Execute a shell command and return its output.
+
+    This tool wraps Python's ``subprocess`` module and returns a
+    structured dictionary containing the captured ``stdout``, ``stderr``,
+    and ``exit_code``. Runtime failures such as timeouts and missing
+    executables are surfaced through a ``status`` field instead of raising
+    exceptions, keeping execution results distinguishable from tool or
+    runtime errors.
+
+    Attributes:
+        version (str): The tool version.
+        parameters (List[ParameterBase]): The declared tool parameters.
+        name (str): The registered tool name.
+        description (str): A human-readable description of the tool.
+        type (Literal["SubprocessTool"]): The component type discriminator.
+    """
+
+    version: str = "1.0.0"
+    parameters: List[ParameterBase] = Field(
+        default_factory=lambda: [
+            ParameterBase(
+                name="command",
+                input_type="string",
+                description="Command to execute",
+                required=True,
+            ),
+            ParameterBase(
+                name="timeout",
+                input_type="number",
+                description="Optional timeout in seconds",
+                required=False,
+            ),
+            ParameterBase(
+                name="shell",
+                input_type="boolean",
+                description="Run command through the shell",
+                required=False,
+            ),
+            ParameterBase(
+                name="cwd",
+                input_type="string",
+                description="Working directory",
+                required=False,
+            ),
+            ParameterBase(
+                name="env",
+                input_type="object",
+                description="Child environment, defaulting to the parent",
+                required=False,
+            ),
+        ]
+    )
+    name: str = "SubprocessTool"
+    description: str = (
+        "Executes a command in a subprocess and captures its output."
+    )
+    type: Literal["SubprocessTool"] = "SubprocessTool"
+
+    def __call__(
+        self,
+        command: Union[str, List[str]],
+        timeout: Optional[float] = None,
+        shell: bool = False,
+        cwd: Optional[str] = None,
+        env: Optional[Dict[str, str]] = None,
+    ) -> Dict[str, Union[str, int, None]]:
+        """
+        Execute a command and return its stdout, stderr, and exit code.
+
+        Support both string commands (split via ``shlex.split``) and
+        argument vectors (list of strings). Default to ``shell=False`` for
+        native executables. Non-zero exit codes are preserved without
+        being conflated with tool or runtime failures; timeouts and missing
+        executables are reported via the ``status`` field.
+
+        Args:
+            command (Union[str, List[str]]): The command to execute. Pass a
+                list of strings for native argument handling.
+            timeout (Optional[float]): Optional timeout in seconds. A
+                ``status`` of ``"timeout"`` is returned on expiry.
+            shell (bool): Whether to run the command through the platform
+                shell. Defaults to ``False``.
+            cwd (Optional[str]): Optional working directory for the
+                subprocess. Omitted means the parent's working directory.
+            env (Optional[Dict[str, str]]): Complete replacement child
+                environment. Omitted means inherit the parent's environment.
+
+        Argument lists require ``shell=False``. Shell mode accepts only a
+        string and executes it through the platform shell. Use argument lists
+        for Windows paths and platform-neutral quoting. A timeout kills and
+        waits for the direct child. Timed Windows calls capture to disk.
+
+        Returns:
+            Dict[str, Union[str, int, None]]: A dictionary containing
+                ``status`` (``"success"``, ``"timeout"``, ``"not_found"``,
+                or ``"runtime_error"``), ``stdout``, ``stderr``, and
+                ``exit_code``.
+        """
+        return SubprocessBackend.run(
+            command, timeout=timeout, shell=shell, cwd=cwd, env=env
+        )

swarmauri_tool_subprocess/__init__.py

@@ -0,0 +1,10 @@
+from importlib import metadata as _metadata
+
+from .SubprocessTool import SubprocessTool
+
+__all__ = ["SubprocessTool"]
+
+try:
+    __version__ = _metadata.version("swarmauri_tool_subprocess")
+except _metadata.PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.0.0"

swarmauri_tool_subprocess-0.11.0.dev3.dist-info/METADATA

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: swarmauri_tool_subprocess
+Version: 0.11.0.dev3
+Summary: Run subprocesses with argument lists, timeouts, and structured results.
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: swarmauri,sdk,standards,tool,subprocess,tooling
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Development Status :: 1 - Planning
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: swarmauri_base (>=0.11.0.dev6,<0.12)
+Requires-Dist: swarmauri_core (>=0.11.0.dev6,<0.12)
+Requires-Dist: swarmauri_process_subprocess (>=0.1.0,<0.2)
+Description-Content-Type: text/markdown
+
+![Swarmauri Logo](https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/master/assets/swarmauri.brand.theme.svg)
+
+<p align="center">
+    <a href="https://pypi.org/project/swarmauri_tool_subprocess/">
+        <img src="https://img.shields.io/pypi/dm/swarmauri_tool_subprocess" alt="PyPI - Downloads"/></a>
+    <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/standards/swarmauri_tool_subprocess/">
+        <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/standards/swarmauri_tool_subprocess.svg"/></a>
+    <a href="https://pypi.org/project/swarmauri_tool_subprocess/">
+        <img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_subprocess" alt="PyPI - Python Version"/></a>
+    <a href="https://pypi.org/project/swarmauri_tool_subprocess/">
+        <img src="https://img.shields.io/pypi/l/swarmauri_tool_subprocess" alt="PyPI - License"/></a>
+    <a href="https://pypi.org/project/swarmauri_tool_subprocess/">
+        <img src="https://img.shields.io/pypi/v/swarmauri_tool_subprocess?label=swarmauri_tool_subprocess&color=green" alt="PyPI - swarmauri_tool_subprocess"/></a>
+    <a href="https://discord.gg/N4UpBuQv8T">
+        <img src="https://img.shields.io/badge/Discord-Join%20Chat-5865F2?logo=discord&logoColor=white" alt="Discord"/></a></p>
+
+# Swarmauri Tool Subprocess
+
+Execute subprocess commands and capture output, timeouts, and exit codes.
+
+## Features
+
+- Execute argument vectors without shell expansion by default.
+- Capture stdout, stderr, and integer exit codes, including nonzero codes.
+- Distinguish completed commands, missing executables, timeouts, and errors.
+- Select a child working directory and an explicit replacement environment.
+- Discover the component through the `swarmauri.tools` entry point and facade.
+- Preserve the original standard import through a lazy compatibility adapter.
+- Share execution with the standard kernel, which can run the legacy tool by itself.
+
+## Installation
+
+```bash
+uv add swarmauri_tool_subprocess
+pip install swarmauri_tool_subprocess
+```
+
+## Usage
+
+```python
+import sys
+from swarmauri_tool_subprocess import SubprocessTool
+
+tool = SubprocessTool()
+result = tool([sys.executable, "-c", "print('hello')"], timeout=5)
+assert result["stdout"].strip() == "hello"
+assert result["exit_code"] == 0
+```
+
+Use argument vectors for commands containing paths or arguments with spaces,
+particularly on Windows. With `shell=False`, string commands use POSIX
+`shlex.split` quoting; they are not parsed by the Windows command processor.
+
+Shell mode accepts strings only and executes arbitrary syntax through the
+platform shell (`/bin/sh` on POSIX or the configured Windows command processor):
+
+```python
+result = tool("echo first && echo second", shell=True, timeout=5)
+```
+
+Only trusted callers should choose shell commands, executables, working
+directories, and environment values. Windows native mode (`shell=False`)
+resolves the executable from the parent search environment and requires a
+native `.exe` or `.com`. Use a trusted absolute executable path for deterministic
+selection. To invoke trusted batch syntax, use explicit shell mode. Windows
+may otherwise parse batch arguments through its command interpreter.
+
+`cwd=None` inherits the parent's working directory. `env=None` deliberately
+inherits the parent's environment for compatibility. Pass `env={...}` to supply
+the complete child environment; it is not merged with the parent. Include any
+platform-required variables (such as `SystemRoot` on Windows) and an appropriate
+`PATH` when needed, or use an absolute executable path. Avoid forwarding secrets
+the child does not need.
+
+`timeout=None` imposes no timeout. A supplied timeout applies to the direct
+child after process creation. Timed Windows calls capture output in temporary
+files, so inherited output handles cannot make the timeout wait for pipe EOF.
+On success, capture is a snapshot taken after the direct child exits.
+Descendants can continue running and retain inherited temporary handles until
+they exit. Keep subprocess execution under the service's trust policy.
+
+## Results and migration
+
+The standalone API returns `status`, `stdout`, `stderr`, and `exit_code`:
+
+| Status | Meaning | Exit code |
+|---|---|---|
+| `success` | Process completed, including nonzero exit codes | Integer |
+| `timeout` | Process exceeded the timeout | `None` |
+| `not_found` | Executable or requested working directory was not found | `127` |
+| `runtime_error` | Invalid arguments or another execution failure | `None` |
+
+`success` describes process completion, not application success; check
+`exit_code == 0` before treating a command as successful. Passing an argument
+list with `shell=True`, an empty command, or malformed quoting returns
+`runtime_error` without starting a child.
+
+Existing code can continue to use the original case-sensitive import:
+
+```python
+from swarmauri_standard.tools.SubprocessTool import SubprocessTool
+
+result = SubprocessTool()("echo hello", shell=True)
+assert result["exit_code"] == "0"
+```
+
+The compatibility adapter emits a `DeprecationWarning` and retains the original
+three-key result and string exit codes: numeric strings for completed commands,
+`"timeout"` for timeouts, and `"error"` for execution failures. Import from the
+standalone package when adopting the richer typed results and `cwd`/`env`
+options. Importing the compatibility module alone does not load the standalone
+package.
+The lowercase module spelling introduced in the PR is also accepted as an
+import alias. Both spellings share the same module and legacy result contract.
+

swarmauri_tool_subprocess-0.11.0.dev3.dist-info/RECORD

@@ -0,0 +1,8 @@
+swarmauri_tool_subprocess/SubprocessTool.py,sha256=E5iC7navPdKyxekGgPWmhCwyuftd7rmsjba151TqXSQ,5119
+swarmauri_tool_subprocess/__init__.py,sha256=6_47i3-F9I40amLIbhDhO1jTb6nVxGxb5HPUdWL3_ao,274
+swarmauri_tool_subprocess-0.11.0.dev3.dist-info/METADATA,sha256=huHhmhWd8lcjh2jXAj5B3GmzOkZnoxgK5IFeF8iwNYs,6608
+swarmauri_tool_subprocess-0.11.0.dev3.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+swarmauri_tool_subprocess-0.11.0.dev3.dist-info/entry_points.txt,sha256=wWIdvMC5K4SX6Axp3Tc9V03yxJsTC1QX36b-GyvtdZQ,75
+swarmauri_tool_subprocess-0.11.0.dev3.dist-info/licenses/LICENSE,sha256=djUXOlCxLVszShEpZXshZ7v33G-2qIC_j9KXpWKZSzQ,11359
+swarmauri_tool_subprocess-0.11.0.dev3.dist-info/licenses/NOTICE,sha256=VfAL5X7ziNvo-D3n5KC0OJscjJ6cHcF5CwRHzM3S9cc,150
+swarmauri_tool_subprocess-0.11.0.dev3.dist-info/RECORD,,

swarmauri_tool_subprocess-0.11.0.dev3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.5.0
+Root-Is-Purelib: true
+Tag: py3-none-any

swarmauri_tool_subprocess-0.11.0.dev3.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[swarmauri.tools]
+SubprocessTool=swarmauri_tool_subprocess:SubprocessTool
+

swarmauri_tool_subprocess-0.11.0.dev3.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2025] [Jacob Stewart @ Swarmauri]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

swarmauri_tool_subprocess-0.11.0.dev3.dist-info/licenses/NOTICE

@@ -0,0 +1,4 @@
+Swarmauri SDK
+
+This package is part of the Swarmauri SDK and is distributed under the
+Apache License, Version 2.0. See LICENSE for the license terms.