sshreader 6.2.0__tar.gz → 6.3.0__tar.gz

{sshreader-6.2.0 → sshreader-6.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sshreader
-Version: 6.2.0
+Version: 6.3.0
 Summary: Multi-threading/processing wrapper for Paramiko
 Author-Email: Jesse Almanrode <jesse@almanrode.com>
 License: LGPL-3.0-or-later
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Project-URL: homepage, http://sshreader.readthedocs.io/
@@ -28,6 +29,8 @@ Description-Content-Type: text/markdown
 
 ![logo](./logo.png)
 
+[![Python Tests](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml)
+
 A Python Module for multiprocessing/threading ssh connections in order to make ssh operations
 across multiple servers parallel.  It utilizes the [Paramiko](http://www.paramiko.org/) module 
 for its ssh client.
@@ -62,14 +65,13 @@ The documentation for [SSHreader][] can be found at [ReadTheDocs.](https://sshre
 
 Comments and enhancements are very welcome.
 
-Report any issues or feature requests on the [BitBucket bug
-tracker](https://bitbucket.org/isaiah1112/sshreader/issues?status=new&status=open). Please include a minimal
-not-working example which reproduces the bug and, if appropriate, the
+Report any issues or feature requests on the [GitHub Issue Tracker](https://github.com/isaiah1112/sshreader/issues). 
+Please include a minimal not-working example which reproduces the bug and, if appropriate, the
 traceback information.  Please do not request features already being worked
 towards.
 
-Code contributions are encouraged: please feel free to [fork the
-project](https://bitbucket.org/isaiah1112/sshreader) and submit pull requests to the develop branch.
+Code contributions are encouraged: please feel free to [fork the project](https://github.com/isaiah1112/sshreader) 
+and submit pull requests to the develop branch.
 
 ## Extras
 
@@ -83,4 +85,4 @@ to process.
 
 [GNU Lesser General Public License v3.0]: http://choosealicense.com/licenses/lgpl-3.0/ "LGPL v3"
 
-[sshreader]: https://bitbucket.org/isaiah1112/sshreader "SSHreader Package"
+[sshreader]: https://github.com/isaiah1112/sshreader "SSHreader Package"

{sshreader-6.2.0 → sshreader-6.3.0}/README.md

@@ -1,5 +1,7 @@
 ![logo](./logo.png)
 
+[![Python Tests](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml)
+
 A Python Module for multiprocessing/threading ssh connections in order to make ssh operations
 across multiple servers parallel.  It utilizes the [Paramiko](http://www.paramiko.org/) module 
 for its ssh client.
@@ -34,14 +36,13 @@ The documentation for [SSHreader][] can be found at [ReadTheDocs.](https://sshre
 
 Comments and enhancements are very welcome.
 
-Report any issues or feature requests on the [BitBucket bug
-tracker](https://bitbucket.org/isaiah1112/sshreader/issues?status=new&status=open). Please include a minimal
-not-working example which reproduces the bug and, if appropriate, the
+Report any issues or feature requests on the [GitHub Issue Tracker](https://github.com/isaiah1112/sshreader/issues). 
+Please include a minimal not-working example which reproduces the bug and, if appropriate, the
 traceback information.  Please do not request features already being worked
 towards.
 
-Code contributions are encouraged: please feel free to [fork the
-project](https://bitbucket.org/isaiah1112/sshreader) and submit pull requests to the develop branch.
+Code contributions are encouraged: please feel free to [fork the project](https://github.com/isaiah1112/sshreader) 
+and submit pull requests to the develop branch.
 
 ## Extras
 
@@ -55,4 +56,4 @@ to process.
 
 [GNU Lesser General Public License v3.0]: http://choosealicense.com/licenses/lgpl-3.0/ "LGPL v3"
 
-[sshreader]: https://bitbucket.org/isaiah1112/sshreader "SSHreader Package"
+[sshreader]: https://github.com/isaiah1112/sshreader "SSHreader Package"

{sshreader-6.2.0 → sshreader-6.3.0}/pyproject.toml

@@ -11,7 +11,7 @@ dependencies = [
     "python-hostlist<2,>=1",
 ]
 name = "sshreader"
-version = "6.2.0"
+version = "6.3.0"
 description = "Multi-threading/processing wrapper for Paramiko"
 readme = "README.md"
 classifiers = [
@@ -25,6 +25,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
@@ -76,7 +77,9 @@ build-backend = "pdm.backend"
 test = [
     "coverage<8,>=7",
     "discover<1.0,>=0.4",
+    "pytest>=8.4.2",
     "ruff<1.0.0,>=0.9.9",
+    "ty>=0.0.5",
 ]
 docs = [
     "sphinx<8,>=7",

{sshreader-6.2.0 → sshreader-6.3.0}/sshreader/__init__.py

@@ -1,6 +1,6 @@
 """A Python Package for parallelizing ssh connections via threading and multiprocessing.
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by

{sshreader-6.2.0 → sshreader-6.3.0}/sshreader/customtypes.py

@@ -1,6 +1,6 @@
 """ Typing module for sshreader
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by

{sshreader-6.2.0 → sshreader-6.3.0}/sshreader/scripts/__init__.py

@@ -1,6 +1,6 @@
 """ Scripts portion of sshreader package
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by

{sshreader-6.2.0 → sshreader-6.3.0}/sshreader/scripts/pydsh.py

@@ -1,6 +1,6 @@
 """ A Pythonic implementation of pdsh powered by sshreader
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by
@@ -162,10 +162,11 @@ def cli(**kwargs):
     if kwargs['file']:
         mkpath = click.Path(exists=True, dir_okay=False)
         script_path = mkpath(kwargs['cmd'])
-        script_name = os.path.split(script_path)[1]
+        # Ensure script_path is a str for os.path functions (type-checker safe)
+        script_name = os.path.basename(str(script_path))
         log.info('Creating copy_script prehook for: ' + script_name)
         prehook = sshreader.Hook(copy_script, args=[script_path], ssh_established=True)
-        with open(script_path) as s:
+        with open(str(script_path)) as s:
             script = s.readline()
         if script.startswith('#!') is False:
             raise click.UsageError('Script must start with #!')
@@ -196,7 +197,7 @@ def cli(**kwargs):
                 kwargs['keyfile'] = sshenv.dsa_key
                 log.info('Using DSA private key file')
         else:
-            if len(sshenv.agent_keys) == 0:
+            if sshenv.agent_keys is None or len(sshenv.agent_keys) == 0:
                 if not all((kwargs['username'], kwargs['password'])):
                     raise click.ClickException('Unable to find ssh key to use and password not supplied.')
             else:
@@ -214,7 +215,7 @@ def cli(**kwargs):
     # If you specify a password or prompt for one it overrides the ssh key
     if not kwargs['password']:
         if not kwargs['prompt']:
-            if not kwargs['keyfile'] and len(sshenv.agent_keys) == 0:
+            if not kwargs['keyfile'] and (sshenv.agent_keys is None or len(sshenv.agent_keys) == 0):
                 raise click.ClickException('Unable to find ssh key to use and password not supplied or prompt enabled.')
         else:
             log.info('Prompting for password and disabling discovered SSH keyfiles')

{sshreader-6.2.0 → sshreader-6.3.0}/sshreader/ssh.py

@@ -1,6 +1,6 @@
 """A wrapper for Paramiko that attempts to make ssh sessions easier to work with.
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by
@@ -173,7 +173,7 @@ class SSH:
                 else:
                     result = Command(cmd=command, stdout=stdout.read().strip(), stderr=None,
                                      return_code=stdout.channel.recv_exit_status())
-            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):
+            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):  # ty:ignore[possibly-missing-submodule]
                 result = Command(cmd=command, stdout='command timed out', stderr=None, return_code=124)
         else:
             try:
@@ -184,7 +184,7 @@ class SSH:
                 else:
                     result = Command(cmd=command, stdout=stdout.read().strip(), stderr=stderr.read().strip(),
                                      return_code=stdout.channel.recv_exit_status())
-            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):
+            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):  # ty:ignore[possibly-missing-submodule]
                 result = Command(cmd=command, stdout='', stderr='command timed out', return_code=124)
         return result
 
@@ -226,7 +226,7 @@ class SSH:
         """
         if self.__alive():
             raise paramiko.SSHException(f"connection to {self.host} already established")
-        paramiko.util.logging.getLogger().setLevel(logging.CRITICAL)  # Keeping paramiko from logging errors to stdout
+        paramiko.util.logging.getLogger().setLevel(logging.CRITICAL)  # Keeping paramiko from logging errors to stdout  # ty:ignore[possibly-missing-submodule]
         if not self.keyfile and len(paramiko.Agent().get_keys()) == 0 and not all((self.username, self.password)):
             paramiko.SSHException('username and password or keyfile not provided')
         if self.keyfile:

{sshreader-6.2.0 → sshreader-6.3.0}/sshreader/utils.py

@@ -1,6 +1,6 @@
 """ All the classes and functions that make sshreader tick
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by
@@ -175,8 +175,8 @@ class ServerJob:
             self.ssh_timeout = timeout[0]
             self.cmd_timeout = timeout[1]
         else:
-            self.ssh_timeout = timeout
-            self.cmd_timeout = timeout
+            self.ssh_timeout = timeout if timeout is not None else 0.5
+            self.cmd_timeout = timeout if timeout is not None else 0.5
         if pre_hook:
             if isinstance(pre_hook, Hook):
                 self.pre_hook = pre_hook
@@ -220,8 +220,8 @@ class ServerJob:
                 log.debug(f'{self.name}: running prehook')
                 self.pre_hook.run(self)
             try:
-                self._conn = SSH(self.name, username=self.username, password=self.password, keyfile=self.key,
-                                 port=self.ssh_port, connect=False, rsa_sha2=self.rsa_sha2)
+                self._conn = SSH(self.name, username=self.username or '', password=self.password or '', keyfile=self.key,
+                                 port=self.ssh_port, connect=False, rsa_sha2=self.rsa_sha2 or True)
                 self._conn.connect(timeout=self.ssh_timeout)
                 log.debug(f'{self.name}: ssh connection established')
             except Exception as errorMsg:
@@ -354,7 +354,7 @@ def sshread(serverjobs: list, pcount: Optional[int] = None, tcount: Optional[int
 
     if pcount is None:
         # Limit the number of threads to spawn
-        if tcount == 0:
+        if tcount == 0 or tcount is None:
             tcount = int(min(totaljobs, cpu_limit()))
         else:
             tcount = int(min(tcount, totaljobs))
@@ -399,10 +399,10 @@ def sshread(serverjobs: list, pcount: Optional[int] = None, tcount: Optional[int
     log.debug(f'main waiting for {totaljobs} ServerJobs to finish')
     while result_queue.full() is False:
         if progress_bar:
-            bar.update(item_counter.value)
+            bar.update(item_counter.value)  # ty:ignore[unresolved-attribute]
         time.sleep(1)
     if progress_bar:
-        bar.finish()
+        bar.finish()  # ty:ignore[unresolved-attribute]
 
     if len(threads) > 0:
         log.info(f'joining {len(threads)} threads')