xbot.plugins.ssh 0.1.0__tar.gz → 0.2.1__tar.gz

{xbot.plugins.ssh-0.1.0/xbot.plugins.ssh.egg-info → xbot_plugins_ssh-0.2.1}/PKG-INFO

@@ -1,27 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: xbot.plugins.ssh
-Version: 0.1.0
+Version: 0.2.1
 Summary: SSH library for xbot.framework
-Home-page: https://github.com/zhaowcheng/xbot.plugins.ssh
-Author: zhaowcheng
-Author-email: zhaowcheng@163.com
-License: UNKNOWN
+Author-email: zhaowcheng <zhaowcheng@163.com>
+License-Expression: BSD-2-Clause
 Project-URL: Homepage, https://github.com/zhaowcheng/xbot.plugins.ssh
 Project-URL: Issues, https://github.com/zhaowcheng/xbot.plugins.ssh/issues
-Platform: UNKNOWN
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.6
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: xbot.framework>=0.5.0
+Requires-Dist: paramiko
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
 
 ## Introduction
 
@@ -144,7 +141,7 @@ with sftpconn.open(p, 'r') as fp:
 
 ## Demo Project
 
-Here is a [demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v0.1.0/demo) project showing how to use `xbot.plugins.ssh` in a test project.
+Here is a [demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v/demo) project showing how to use `xbot.plugins.ssh` in a test project.
 
 ***
 
@@ -269,6 +266,4 @@ with sftpconn.open(p, 'r') as fp:
 
 ## 示例项目
 
-展示如何在一个测试项目中使用本插件的示例：[demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v0.1.0/demo)
-
-
+展示如何在一个测试项目中使用本插件的示例：[demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v/demo)

xbot_plugins_ssh-0.2.1/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xbot.plugins.ssh"
+description = "SSH library for xbot.framework"
+authors = [
+    { name = "zhaowcheng", email = "zhaowcheng@163.com" },
+]
+license = "BSD-2-Clause"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dependencies = [
+    "xbot.framework>=0.5.0",
+    "paramiko",
+]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dynamic = ["version", "readme"]
+
+[project.urls]
+Homepage = "https://github.com/zhaowcheng/xbot.plugins.ssh"
+Issues = "https://github.com/zhaowcheng/xbot.plugins.ssh/issues"
+
+[tool.setuptools.dynamic]
+version = { attr = "xbot.plugins.ssh.version.__version__" }
+
+[tool.setuptools.packages.find]
+include = ["xbot.plugins.ssh*"]
+
+[tool.setuptools.package-data]
+"xbot.plugins.ssh" = ["py.typed"]

xbot_plugins_ssh-0.2.1/setup.py

@@ -0,0 +1,26 @@
+# Build hook: generate long_description from README files,
+# stripping language-switcher headers.
+# All other metadata lives in pyproject.toml.
+import re
+
+from setuptools import setup
+
+
+def _build_long_description() -> str:
+    desc = ""
+    for readme in ("README.md", "README.zh.md"):
+        if desc:
+            desc += "\n***\n\n"
+        with open(readme, encoding="utf8") as f:
+            desc += "".join(f.readlines()[6:])
+    with open("pyproject.toml", encoding="utf8") as f:
+        m = re.search(r'''^version\s*=\s*["']([^"']+)''', f.read(), re.M)
+        version = m.group(1) if m else ""
+    desc = desc.replace("/tree/master/", f"/tree/v{version}/")
+    return desc
+
+
+setup(
+    long_description=_build_long_description(),
+    long_description_content_type="text/markdown",
+)

{xbot.plugins.ssh-0.1.0 → xbot_plugins_ssh-0.2.1}/tests/test_sftp.py

@@ -35,10 +35,21 @@ class TestSFTPConnection(unittest.TestCase):
         os.system('whoami > %s' % os.path.join(cls.LPUTDIR, 'dir', 'subfile'))
 
     @classmethod
-    def tearDownClass(cls):
-        shutil.rmtree(cls.LPUTDIR)
-        shutil.rmtree(cls.LGETDIR)
-        cls.sftp.disconnect()
+    def tearDownClass(cls) -> None:
+        try:
+            if cls.sftp.exists(cls.RPUTDIR):
+                for top, _, files in reversed(
+                    list(cls.sftp.walk(cls.RPUTDIR))
+                ):
+                    for filename in files:
+                        cls.sftp._client.remove(
+                            cls.sftp.join(top, filename)
+                        )
+                    cls.sftp._client.rmdir(top)
+        finally:
+            shutil.rmtree(cls.LPUTDIR, ignore_errors=True)
+            shutil.rmtree(cls.LGETDIR, ignore_errors=True)
+            cls.sftp.disconnect()
 
     def test_01_putdir(self):
         l = os.path.join(self.LPUTDIR, 'dir')

{xbot.plugins.ssh-0.1.0 → xbot_plugins_ssh-0.2.1}/tests/test_ssh.py

@@ -56,7 +56,8 @@ class TestSSHConnection(unittest.TestCase):
     def test_connect_error_ip(self):
         conn = SSHConnection()
         with self.assertRaises(SSHConnectError) as cm:
-            conn.connect('128.0.0.1', self.USER, self.PWD, self.PORT)
+            conn.connect('255.255.255.255',
+                         self.USER, self.PWD, self.PORT)
         self.assertIn('please check whether the network is normal',
                       str(cm.exception))
 

xbot_plugins_ssh-0.2.1/xbot/plugins/ssh/py.typed

@@ -0,0 +1 @@
+

{xbot.plugins.ssh-0.1.0 → xbot_plugins_ssh-0.2.1}/xbot/plugins/ssh/sftp.py

@@ -7,7 +7,7 @@ SFTP module
 import os
 import stat
 
-from typing import Generator
+from typing import Iterator, cast
 from contextlib import contextmanager
 
 from paramiko import Transport, SFTPClient, SFTPFile
@@ -22,10 +22,14 @@ class SFTPConnection(object):
     """
     SFTP connection.
     """
-    def __init__(self):
-        self._sftpclient = None
+    def __init__(self) -> None:
+        self._sftpclient: SFTPClient | None = None
         self._logger = ExtraAdapter(logger, {})
 
+    @property
+    def _client(self) -> SFTPClient:
+        return cast(SFTPClient, self._sftpclient)
+
     def connect(
         self,
         host: str,
@@ -48,9 +52,14 @@ class SFTPConnection(object):
         """
         Close the connection.
         """
-        self._sftpclient.close()
+        self._client.close()
 
-    def getfile(self, rfile: str, ldir: str, filename: str = None) -> None:
+    def getfile(
+        self,
+        rfile: str,
+        ldir: str,
+        filename: str | None = None
+    ) -> None:
         """
         Get `rfile` from SFTP server into `ldir`.
         
@@ -66,9 +75,14 @@ class SFTPConnection(object):
         filename = filename or self.basename(rfile)
         lfile = os.path.join(ldir, filename)
         self._logger.info(f'Getting file {lfile} <= {rfile}')
-        self._sftpclient.get(rfile, lfile)
+        self._client.get(rfile, lfile)
 
-    def putfile(self, lfile: str, rdir: str, filename: str = None) -> None:
+    def putfile(
+        self,
+        lfile: str,
+        rdir: str,
+        filename: str | None = None
+    ) -> None:
         """
         Put `lfile` into the `rdir` of SFTP server.
 
@@ -84,7 +98,7 @@ class SFTPConnection(object):
         filename = filename or os.path.basename(lfile)
         rfile = self.join(rdir, filename)
         self._logger.info(f'Putting file {lfile} => {rfile}')
-        self._sftpclient.put(lfile, rfile)
+        self._client.put(lfile, rfile)
             
     def getdir(self, rdir: str, ldir: str) -> None:
         """
@@ -107,7 +121,7 @@ class SFTPConnection(object):
             for f in files:
                 r = self.join(top, f)
                 l = os.path.join(ldir, f)
-                self._sftpclient.get(r, l)
+                self._client.get(r, l)
             for d in dirs:
                 l = os.path.join(ldir, d)
                 if not os.path.exists(l):
@@ -134,7 +148,7 @@ class SFTPConnection(object):
             for f in files:
                 l = os.path.join(top, f)
                 r = self.join(rdir, f)
-                self._sftpclient.put(l, r)
+                self._client.put(l, r)
             for d in dirs:
                 r = self.join(rdir, d)
                 if not self.exists(r):
@@ -144,8 +158,8 @@ class SFTPConnection(object):
         """
         Similar to os.path.join().
         """
-        paths = [p.rstrip('/') for p in paths]
-        return '/'.join(paths)
+        normalized_paths = [p.rstrip('/') for p in paths]
+        return '/'.join(normalized_paths)
 
     def normpath(self, path: str) -> str:
         """
@@ -161,22 +175,25 @@ class SFTPConnection(object):
         """
         return path.rsplit('/', 1)[-1]
 
-    def exists(self, path: str) -> str:
+    def exists(self, path: str) -> bool:
         """
         Similar to os.path.exists().
         """
         try:
-            self._sftpclient.stat(path)
+            self._client.stat(path)
             return True
         except FileNotFoundError:
             return False
 
-    def walk(self, path: str):
+    def walk(
+        self,
+        path: str
+    ) -> Iterator[tuple[str, list[str], list[str]]]:
         """
         Similar to os.walk().
         """
         dirs, files =  [], []
-        for a in self._sftpclient.listdir_attr(path):
+        for a in self._client.listdir_attr(path):
             if stat.S_ISDIR(a.st_mode):
                 dirs.append(a.filename)
             else:
@@ -187,7 +204,7 @@ class SFTPConnection(object):
             for w in self.walk(self.join(path, d)):
                 yield w
 
-    def makedirs(self, path: str) -> str:
+    def makedirs(self, path: str) -> None:
         """
         Similar to os.makedirs().
         """
@@ -196,15 +213,19 @@ class SFTPConnection(object):
         for p in path.split('/'):
             curpath = self.join(curpath, p)
             if not self.exists(curpath):
-                self._sftpclient.mkdir(curpath)
+                self._client.mkdir(curpath)
 
     @contextmanager
-    def open(self, filepath: str, mode: str = 'r') -> Generator[SFTPFile, str, None]:
+    def open(
+        self,
+        filepath: str,
+        mode: str = 'r'
+    ) -> Iterator[SFTPFile]:
         """
         Similar to builtin open().
         """
         self._logger.info('Open %s with mode=%s' % (filepath, mode))
-        f = self._sftpclient.open(filepath, mode)
+        f = self._client.open(filepath, mode)
         try:
             yield f
         finally:

{xbot.plugins.ssh-0.1.0 → xbot_plugins_ssh-0.2.1}/xbot/plugins/ssh/ssh.py

@@ -8,7 +8,7 @@ import textwrap
 import threading
 import socket
 
-from typing import Generator, Optional, Union
+from typing import Any, Iterator, cast
 from datetime import datetime
 from select import select
 from contextlib import contextmanager
@@ -31,7 +31,12 @@ class SSHCommandResult(str):
     """
     Result of SSH command.
     """
-    def __new__(cls, out: str, rc: int = 0, cmd: str = '') -> str:
+    def __new__(
+        cls: type['SSHCommandResult'],
+        out: str,
+        rc: int = 0,
+        cmd: str = ''
+    ) -> 'SSHCommandResult':
         """
         :param out: output.
         :param rc: return code.
@@ -40,7 +45,7 @@ class SSHCommandResult(str):
         out = remove_ansi_escape_chars(out)
         out = remove_unprintable_chars(out)
         out = '\n'.join(out.splitlines())
-        o = str.__new__(cls, out.strip())
+        o = cast(SSHCommandResult, str.__new__(cls, out.strip()))
         o.__rc = rc
         o.__cmd = cmd
         return o
@@ -61,10 +66,10 @@ class SSHCommandResult(str):
 
     def getfield(
         self,
-        key: str,
+        key: str | int,
         col: int,
-        sep: str = None
-    ) -> Optional[str]:
+        sep: str | None = None
+    ) -> str | None:
         """
         Get a specified field from the output.
 
@@ -98,8 +103,8 @@ class SSHCommandResult(str):
     def getcol(
         self,
         col: int,
-        sep: str = None
-    ) -> list:
+        sep: str | None = None
+    ) -> list[str]:
         """
         Get a specified column from the output.
 
@@ -127,7 +132,7 @@ class SSHConnection(object):
     """
     SSH connection.
     """
-    def __init__(self, shenvs: dict = {}):
+    def __init__(self, shenvs: dict[str, str] = {}) -> None:
         """
         :param shenvs: shell environment variables for method `exec`.
             `LANG` defaults to `en_US.UTF-8`.
@@ -136,11 +141,11 @@ class SSHConnection(object):
         self._logger = ExtraAdapter(logger, {})
         self._sshclient = SSHClient()
         self._sshclient.set_missing_host_key_policy(AutoAddPolicy())
-        self._shenvs = shenvs
+        self._shenvs: dict[str, str] = shenvs
         for k, v in {'LANG': 'en_US.UTF-8',
                      'LANGUAGE': 'en_US.UTF-8'}.items():
             self._shenvs[k] = self._shenvs.get(k, v)
-        self._password = None
+        self._password: str | None = None
         self._cdlock = threading.Lock()
         self._cwd = ''
 
@@ -175,16 +180,16 @@ class SSHConnection(object):
                 f'Authentication failed when SSH connect to {host} with user `{user}`, '
                 f'please check whether the username and password are correct.'
             ) from None
-        except socket.timeout:
-            raise SSHConnectError(
-                f'Timed out when SSH connect to {host}({timeout}s), '
-                'please check whether the network is normal.'
-            ) from None
         except NoValidConnectionsError:
             raise SSHConnectError(
                 f'Could not connect to port {port} on {host}, '
                 'please check whether the port is opened.'
             ) from None
+        except OSError:
+            raise SSHConnectError(
+                f'Could not connect to {host}, '
+                'please check whether the network is normal.'
+            ) from None
         except SSHException as e:
             msg = str(e)
             if 'Error reading SSH protocol banner' in msg:
@@ -203,10 +208,10 @@ class SSHConnection(object):
     def exec(
         self,
         cmd: str,
-        expect: Union[int, str, None] = 0,
+        expect: int | str | None = 0,
         timeout: int = 15,
-        prompts: dict = {},
-        shenvs: dict = {}
+        prompts: dict[str, str] = {},
+        shenvs: dict[str, str] = {}
     ) -> SSHCommandResult:
         """
         Execute a command on the SSH server.
@@ -281,15 +286,22 @@ class SSHConnection(object):
                 raise SSHCommandError(msg)
         return result
 
-    def sudo(self, cmd, *args, **kwargs) -> SSHCommandResult:
+    def sudo(
+        self,
+        cmd: str,
+        *args: Any,
+        **kwargs: Any
+    ) -> SSHCommandResult:
         """
         Execute a command with sudo, arguments are same to `exec`.
         """
-        kwargs['prompts'] = {'[sudo] password': self._password}
+        kwargs['prompts'] = {
+            '[sudo] password': cast(str, self._password)
+        }
         return self.exec(f'sudo {cmd}', *args, **kwargs)
 
     @contextmanager
-    def cd(self, path) -> Generator[None, str, None]:
+    def cd(self, path: str) -> Iterator[None]:
         """
         change current directory.
 
@@ -306,4 +318,3 @@ class SSHConnection(object):
         finally:
             self._cwd = ''
             self._cdlock.release()
-

xbot_plugins_ssh-0.2.1/xbot/plugins/ssh/version.py

@@ -0,0 +1,3 @@
+"""Package version."""
+
+__version__: str = "0.2.1"

{xbot.plugins.ssh-0.1.0 → xbot_plugins_ssh-0.2.1/xbot.plugins.ssh.egg-info}/PKG-INFO

@@ -1,27 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: xbot.plugins.ssh
-Version: 0.1.0
+Version: 0.2.1
 Summary: SSH library for xbot.framework
-Home-page: https://github.com/zhaowcheng/xbot.plugins.ssh
-Author: zhaowcheng
-Author-email: zhaowcheng@163.com
-License: UNKNOWN
+Author-email: zhaowcheng <zhaowcheng@163.com>
+License-Expression: BSD-2-Clause
 Project-URL: Homepage, https://github.com/zhaowcheng/xbot.plugins.ssh
 Project-URL: Issues, https://github.com/zhaowcheng/xbot.plugins.ssh/issues
-Platform: UNKNOWN
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.6
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: xbot.framework>=0.5.0
+Requires-Dist: paramiko
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
 
 ## Introduction
 
@@ -144,7 +141,7 @@ with sftpconn.open(p, 'r') as fp:
 
 ## Demo Project
 
-Here is a [demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v0.1.0/demo) project showing how to use `xbot.plugins.ssh` in a test project.
+Here is a [demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v/demo) project showing how to use `xbot.plugins.ssh` in a test project.
 
 ***
 
@@ -269,6 +266,4 @@ with sftpconn.open(p, 'r') as fp:
 
 ## 示例项目
 
-展示如何在一个测试项目中使用本插件的示例：[demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v0.1.0/demo)
-
-
+展示如何在一个测试项目中使用本插件的示例：[demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v/demo)

xbot_plugins_ssh-0.2.1/xbot.plugins.ssh.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+README.zh.md
+pyproject.toml
+setup.py
+tests/test_sftp.py
+tests/test_ssh.py
+tests/test_utils.py
+xbot.plugins.ssh.egg-info/PKG-INFO
+xbot.plugins.ssh.egg-info/SOURCES.txt
+xbot.plugins.ssh.egg-info/dependency_links.txt
+xbot.plugins.ssh.egg-info/requires.txt
+xbot.plugins.ssh.egg-info/top_level.txt
+xbot/plugins/ssh/__init__.py
+xbot/plugins/ssh/errors.py
+xbot/plugins/ssh/py.typed
+xbot/plugins/ssh/sftp.py
+xbot/plugins/ssh/ssh.py
+xbot/plugins/ssh/utils.py
+xbot/plugins/ssh/version.py

xbot_plugins_ssh-0.2.1/xbot.plugins.ssh.egg-info/requires.txt

@@ -0,0 +1,2 @@
+xbot.framework>=0.5.0
+paramiko

xbot_plugins_ssh-0.2.1/xbot.plugins.ssh.egg-info/top_level.txt

@@ -0,0 +1 @@
+xbot

xbot.plugins.ssh-0.1.0/MANIFEST.in

@@ -1,2 +0,0 @@
-include requirements.txt
-include README*

xbot.plugins.ssh-0.1.0/demo/lib/testbed.py

@@ -1,48 +0,0 @@
-from typing import Union
-
-from xbot.framework import testbed
-from xbot.plugins.ssh.ssh import SSHConnection
-from xbot.plugins.ssh.sftp import SFTPConnection
-
-
-class TestBed(testbed.TestBed):
-    """
-    TestBed for ssh demo.
-    """
-    def __init__(self, filepath: str):
-        """
-        :param filepath: testbed filepath.
-        """
-        super().__init__(filepath)
-        self._conns = {
-            'ssh': {},
-            'sftp': {}
-        }
-
-    def get_conn(
-        self, 
-        typ: str,
-        role: str
-    ) -> Union[SSHConnection, SFTPConnection]:
-        """
-        Get specific connection to the specified role.
-
-        :param typ: connection type, 'ssh' or 'sftp'.
-        :param role: user role.
-        """
-        typs = ('ssh', 'sftp')
-        if typ not in typs:
-            raise ValueError(f'Invalid connection type: {typ}, should be one of {typs}.')
-        for user in self.get('host.users'):
-            if user['role'] == role:
-                if role not in self._conns[typ]:
-                    conn = SSHConnection() if typ == 'ssh' else SFTPConnection()
-                    conn.connect(self.get('host.ip'), 
-                                 user['name'], 
-                                 user['password'], 
-                                 port=self.get('host.sshport'))
-                    self._conns[typ][role] = conn
-                return self._conns[typ][role]
-        raise ValueError(f'No such user: role={role}')
-
-    

xbot.plugins.ssh-0.1.0/demo/lib/testcase.py

@@ -1,15 +0,0 @@
-from xbot.framework import testcase
-
-from .testbed import TestBed
-
-
-class TestCase(testcase.TestCase):
-    """
-    TestCase for ssh demo.
-    """
-    @property
-    def testbed(self) -> TestBed:
-        """
-        TestBed instance.
-        """
-        return self.__testbed