swarmauri_tool_jupytershutdownkernel 0.7.0.dev2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- swarmauri_tool_jupytershutdownkernel/JupyterShutdownKernelTool.py +148 -0
- swarmauri_tool_jupytershutdownkernel/__init__.py +19 -0
- swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/LICENSE +201 -0
- swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/METADATA +103 -0
- swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/RECORD +6 -0
- swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/WHEEL +4 -0
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# JupyterShutdownKernelTool.py
|
|
2
|
+
#
|
|
3
|
+
# This module defines the JupyterShutdownKernelTool, a component responsible for gracefully
|
|
4
|
+
# shutting down a running Jupyter kernel. It integrates with the system's tool architecture
|
|
5
|
+
# and handles kernel resource release, logging, error handling, and configurable timeouts.
|
|
6
|
+
|
|
7
|
+
import logging
|
|
8
|
+
import time
|
|
9
|
+
from typing import List, Literal, Dict
|
|
10
|
+
|
|
11
|
+
from pydantic import Field
|
|
12
|
+
from jupyter_client import KernelManager
|
|
13
|
+
from jupyter_client.kernelspec import NoSuchKernel
|
|
14
|
+
|
|
15
|
+
from swarmauri_standard.tools.Parameter import Parameter
|
|
16
|
+
from swarmauri_base.tools.ToolBase import ToolBase
|
|
17
|
+
from swarmauri_base.ComponentBase import ComponentBase
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
@ComponentBase.register_type(ToolBase, "JupyterShutdownKernelTool")
|
|
21
|
+
class JupyterShutdownKernelTool(ToolBase):
|
|
22
|
+
"""
|
|
23
|
+
JupyterShutdownKernelTool is a tool that gracefully shuts down a running Jupyter kernel.
|
|
24
|
+
|
|
25
|
+
This tool integrates with the swarmauri framework and extends the ToolBase class to handle
|
|
26
|
+
kernel shutdown logic. It releases all associated kernel resources, supports a configurable
|
|
27
|
+
timeout for the shutdown process, logs shutdown events, and returns a confirmation of success
|
|
28
|
+
or an error message upon failure.
|
|
29
|
+
|
|
30
|
+
Attributes:
|
|
31
|
+
version (str): The version of the JupyterShutdownKernelTool.
|
|
32
|
+
parameters (List[Parameter]): A list of parameters needed to perform the kernel shutdown.
|
|
33
|
+
name (str): The name of the tool.
|
|
34
|
+
description (str): A brief description of the tool's functionality.
|
|
35
|
+
type (Literal["JupyterShutdownKernelTool"]): The type identifier for this tool.
|
|
36
|
+
"""
|
|
37
|
+
|
|
38
|
+
version: str = "1.0.0"
|
|
39
|
+
parameters: List[Parameter] = Field(
|
|
40
|
+
default_factory=lambda: [
|
|
41
|
+
Parameter(
|
|
42
|
+
name="kernel_id",
|
|
43
|
+
input_type="string",
|
|
44
|
+
description="Unique identifier or name of the kernel to be shut down.",
|
|
45
|
+
required=True,
|
|
46
|
+
),
|
|
47
|
+
Parameter(
|
|
48
|
+
name="shutdown_timeout",
|
|
49
|
+
input_type="integer",
|
|
50
|
+
description="Maximum time in seconds to wait for the kernel to shut down cleanly.",
|
|
51
|
+
required=False,
|
|
52
|
+
default=5,
|
|
53
|
+
),
|
|
54
|
+
]
|
|
55
|
+
)
|
|
56
|
+
name: str = "JupyterShutdownKernelTool"
|
|
57
|
+
description: str = (
|
|
58
|
+
"Shuts down a running Jupyter kernel and releases associated resources."
|
|
59
|
+
)
|
|
60
|
+
type: Literal["JupyterShutdownKernelTool"] = "JupyterShutdownKernelTool"
|
|
61
|
+
|
|
62
|
+
def __call__(self, kernel_id: str, shutdown_timeout: int = 5) -> Dict[str, str]:
|
|
63
|
+
"""
|
|
64
|
+
Shuts down the specified Jupyter kernel using the provided kernel_id.
|
|
65
|
+
|
|
66
|
+
Args:
|
|
67
|
+
kernel_id (str): The identifier of the kernel to be shut down.
|
|
68
|
+
shutdown_timeout (int): Time in seconds to wait for the kernel to shut down cleanly.
|
|
69
|
+
|
|
70
|
+
Returns:
|
|
71
|
+
Dict[str, str]: A dictionary containing the status of the operation. If successful,
|
|
72
|
+
it includes the kernel_id and a 'success' message. Otherwise,
|
|
73
|
+
it returns an 'error' message describing the failure.
|
|
74
|
+
|
|
75
|
+
Example:
|
|
76
|
+
>>> tool = JupyterShutdownKernelTool()
|
|
77
|
+
>>> tool("my_kernel_id", 5)
|
|
78
|
+
{'kernel_id': 'my_kernel_id', 'status': 'success', 'message': 'Kernel shut down successfully.'}
|
|
79
|
+
|
|
80
|
+
Raises:
|
|
81
|
+
Exception: If an unexpected error occurs during kernel shutdown.
|
|
82
|
+
"""
|
|
83
|
+
logger = logging.getLogger(__name__)
|
|
84
|
+
logger.info("Initiating shutdown for kernel_id='%s'", kernel_id)
|
|
85
|
+
|
|
86
|
+
try:
|
|
87
|
+
manager = KernelManager(kernel_name=kernel_id)
|
|
88
|
+
# Attempt to load the connection file; if it doesn’t exist or is invalid, this may fail.
|
|
89
|
+
manager.load_connection_file()
|
|
90
|
+
|
|
91
|
+
# Request a graceful shutdown.
|
|
92
|
+
manager.shutdown_kernel(now=False)
|
|
93
|
+
logger.debug(
|
|
94
|
+
"Shutdown request sent to kernel_id='%s'; waiting up to %s seconds.",
|
|
95
|
+
kernel_id,
|
|
96
|
+
shutdown_timeout,
|
|
97
|
+
)
|
|
98
|
+
|
|
99
|
+
# Wait for kernel to terminate, polling periodically.
|
|
100
|
+
elapsed = 0
|
|
101
|
+
poll_interval = 0.5
|
|
102
|
+
while manager.is_alive() and elapsed < shutdown_timeout:
|
|
103
|
+
time.sleep(poll_interval)
|
|
104
|
+
elapsed += poll_interval
|
|
105
|
+
|
|
106
|
+
# If kernel is still alive, attempt a forced shutdown.
|
|
107
|
+
if manager.is_alive():
|
|
108
|
+
logger.warning(
|
|
109
|
+
"Kernel did not shut down within %s seconds; forcing shutdown.",
|
|
110
|
+
shutdown_timeout,
|
|
111
|
+
)
|
|
112
|
+
manager.shutdown_kernel(now=True)
|
|
113
|
+
|
|
114
|
+
# Final check to confirm kernel termination.
|
|
115
|
+
if manager.is_alive():
|
|
116
|
+
error_message = f"Kernel {kernel_id} could not be shut down."
|
|
117
|
+
logger.error(error_message)
|
|
118
|
+
return {
|
|
119
|
+
"kernel_id": kernel_id,
|
|
120
|
+
"status": "error",
|
|
121
|
+
"message": error_message,
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
success_message = f"Kernel {kernel_id} shut down successfully."
|
|
125
|
+
logger.info(success_message)
|
|
126
|
+
return {
|
|
127
|
+
"kernel_id": kernel_id,
|
|
128
|
+
"status": "success",
|
|
129
|
+
"message": success_message,
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
except NoSuchKernel:
|
|
133
|
+
error_message = f"No such kernel: {kernel_id}."
|
|
134
|
+
logger.error(error_message)
|
|
135
|
+
return {"kernel_id": kernel_id, "status": "error", "message": error_message}
|
|
136
|
+
except FileNotFoundError:
|
|
137
|
+
error_message = f"Connection file not found for kernel: {kernel_id}."
|
|
138
|
+
logger.error(error_message)
|
|
139
|
+
return {"kernel_id": kernel_id, "status": "error", "message": error_message}
|
|
140
|
+
except Exception as e:
|
|
141
|
+
logger.exception(
|
|
142
|
+
"An error occurred while shutting down kernel_id='%s'.", kernel_id
|
|
143
|
+
)
|
|
144
|
+
return {
|
|
145
|
+
"kernel_id": kernel_id,
|
|
146
|
+
"status": "error",
|
|
147
|
+
"message": f"Kernel shutdown failed due to unexpected error: {str(e)}",
|
|
148
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from swarmauri_tool_jupytershutdownkernel.JupyterShutdownKernelTool import (
|
|
2
|
+
JupyterShutdownKernelTool,
|
|
3
|
+
)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
__all__ = ["JupyterShutdownKernelTool"]
|
|
7
|
+
|
|
8
|
+
try:
|
|
9
|
+
# For Python 3.8 and newer
|
|
10
|
+
from importlib.metadata import version, PackageNotFoundError
|
|
11
|
+
except ImportError:
|
|
12
|
+
# For older Python versions, use the backport
|
|
13
|
+
from importlib_metadata import version, PackageNotFoundError
|
|
14
|
+
|
|
15
|
+
try:
|
|
16
|
+
__version__ = version("swarmauri_tool_jupytershutdownkernel")
|
|
17
|
+
except PackageNotFoundError:
|
|
18
|
+
# If the package is not installed (for example, during development)
|
|
19
|
+
__version__ = "0.0.0"
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2025] [Jacob Stewart @ Swarmauri]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: swarmauri_tool_jupytershutdownkernel
|
|
3
|
+
Version: 0.7.0.dev2
|
|
4
|
+
Summary: A tool designed to shut down a running Jupyter kernel programmatically using jupyter_client, releasing all associated resources.
|
|
5
|
+
License: Apache-2.0
|
|
6
|
+
Author: Jacob Stewart
|
|
7
|
+
Author-email: jacob@swarmauri.com
|
|
8
|
+
Requires-Python: >=3.10,<3.13
|
|
9
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
|
+
Requires-Dist: jupyter_client (>=8.6.3)
|
|
15
|
+
Requires-Dist: swarmauri_base
|
|
16
|
+
Requires-Dist: swarmauri_core
|
|
17
|
+
Requires-Dist: swarmauri_standard
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
|
|
20
|
+
<!-- Swarmauri Branding & Badges -->
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<p align="center">
|
|
24
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupytershutdownkernel/">
|
|
25
|
+
<img src="https://img.shields.io/pypi/dm/swarmauri_tool_jupytershutdownkernel" alt="PyPI - Downloads"/></a>
|
|
26
|
+
<a href="https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupytershutdownkernel">
|
|
27
|
+
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupytershutdownkernel&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false" alt="GitHub Hits"/></a>
|
|
28
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupytershutdownkernel/">
|
|
29
|
+
<img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_jupytershutdownkernel" alt="PyPI - Python Version"/></a>
|
|
30
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupytershutdownkernel/">
|
|
31
|
+
<img src="https://img.shields.io/pypi/l/swarmauri_tool_jupytershutdownkernel" alt="PyPI - License"/></a>
|
|
32
|
+
<br />
|
|
33
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupytershutdownkernel/">
|
|
34
|
+
<img src="https://img.shields.io/pypi/v/swarmauri_tool_jupytershutdownkernel?label=swarmauri_tool_jupytershutdownkernel&color=green" alt="PyPI - swarmauri_tool_jupytershutdownkernel"/></a>
|
|
35
|
+
</p>
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
# swarmauri_tool_jupytershutdownkernel
|
|
40
|
+
|
|
41
|
+
The swarmauri_tool_jupytershutdownkernel package provides a straightforward solution to shut down a running Jupyter kernel programmatically. It uses jupyter_client under the hood and is integrated into the Swarmauri framework ecosystem. This tool can be useful for automated resource management, testing scenarios that require repeated kernel restarts, or any workflow that programmatically terminates Jupyter kernels.
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
You can install this module directly via PyPI using pip:
|
|
46
|
+
|
|
47
|
+
pip install swarmauri_tool_jupytershutdownkernel
|
|
48
|
+
|
|
49
|
+
This will install the package and its dependencies, including jupyter_client and the Swarmauri libraries required by JupyterShutdownKernelTool.
|
|
50
|
+
|
|
51
|
+
Ensure you are running a Python version between 3.10 and 3.13, and that you have the appropriate Swarmauri core/base packages installed. Typically, pip will handle these dependencies automatically.
|
|
52
|
+
|
|
53
|
+
## Usage
|
|
54
|
+
|
|
55
|
+
After installation, you can use the JupyterShutdownKernelTool to shut down a running Jupyter kernel by referencing it within your Python scripts or tools.
|
|
56
|
+
|
|
57
|
+
Here’s a quick example of how to import and use JupyterShutdownKernelTool:
|
|
58
|
+
|
|
59
|
+
--------------------------------------------------------------------------------
|
|
60
|
+
Example:
|
|
61
|
+
|
|
62
|
+
from swarmauri_tool_jupytershutdownkernel import JupyterShutdownKernelTool
|
|
63
|
+
|
|
64
|
+
def shutdown_kernel_example(kernel_identifier: str):
|
|
65
|
+
"""
|
|
66
|
+
Demonstrates shutting down a Jupyter kernel using the JupyterShutdownKernelTool.
|
|
67
|
+
"""
|
|
68
|
+
# Instantiate the tool
|
|
69
|
+
shutdown_tool = JupyterShutdownKernelTool()
|
|
70
|
+
|
|
71
|
+
# Perform kernel shutdown
|
|
72
|
+
response = shutdown_tool(kernel_id=kernel_identifier, shutdown_timeout=5)
|
|
73
|
+
|
|
74
|
+
# Print the result
|
|
75
|
+
print(response)
|
|
76
|
+
--------------------------------------------------------------------------------
|
|
77
|
+
|
|
78
|
+
1. Create an instance of JupyterShutdownKernelTool.
|
|
79
|
+
2. Invoke it like a function, passing the kernel_id (the unique identifier for your kernel) and an optional shutdown_timeout in seconds.
|
|
80
|
+
3. The method returns a dictionary with the key-value pairs indicating whether the shutdown was successful or if an error occurred.
|
|
81
|
+
|
|
82
|
+
### Detailed Usage Instructions
|
|
83
|
+
|
|
84
|
+
• Ensure the kernel you want to shut down is running and that its connection file is accessible.
|
|
85
|
+
• Pass the kernel's ID or name to the tool.
|
|
86
|
+
• Optionally configure the shutdown_timeout parameter (default is 5s) to give the tool more or less time to perform a graceful shutdown.
|
|
87
|
+
• Check the returned dictionary to confirm a successful shutdown or to see an error message for troubleshooting.
|
|
88
|
+
|
|
89
|
+
### Dependencies
|
|
90
|
+
|
|
91
|
+
• jupyter_client – Underlies the kernel shutdown implementation.
|
|
92
|
+
• swarmauri_core / swarmauri_base – Provide the foundational classes (ComponentBase and ToolBase).
|
|
93
|
+
• pydantic – Used internally for type validation in Swarmauri parameters.
|
|
94
|
+
|
|
95
|
+
Below is a reference to the core files where the functionality resides:
|
|
96
|
+
|
|
97
|
+
1. JupyterShutdownKernelTool.py
|
|
98
|
+
2. __init__.py
|
|
99
|
+
3. pyproject.toml
|
|
100
|
+
|
|
101
|
+
In particular, JupyterShutdownKernelTool.py includes the main logic for stopping a Jupyter kernel and handles creditable outcomes like missing kernels, missing connection files, or forced terminations if the kernel does not shut down gracefully within the allotted time.
|
|
102
|
+
|
|
103
|
+
We hope this tool helps you manage Jupyter kernels more effectively, freeing you to focus on other aspects of your workflows!
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
swarmauri_tool_jupytershutdownkernel/JupyterShutdownKernelTool.py,sha256=Xwpt4il7Xs1Sy-PGlNsbAM566PyV36virNJcGWjZWZU,6124
|
|
2
|
+
swarmauri_tool_jupytershutdownkernel/__init__.py,sha256=WRd6rSiTN_RYJ5MXkQYkHl1mt_PueY9c1Cabva93cas,588
|
|
3
|
+
swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/LICENSE,sha256=djUXOlCxLVszShEpZXshZ7v33G-2qIC_j9KXpWKZSzQ,11359
|
|
4
|
+
swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/METADATA,sha256=Eh-AFMuIddrnuoDkmTjm5fCbYIgGfftj_ag_7XaGC_Q,5626
|
|
5
|
+
swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
|
|
6
|
+
swarmauri_tool_jupytershutdownkernel-0.7.0.dev2.dist-info/RECORD,,
|