ansible-pylibssh 1.2.2

Nightlies @ Dumb PyPI @ GitHub Pages

我们在tags和devel的push上发布nightlies。它们托管在由dumb-pypi生成的基于GitHub Pages的索引上。

网页视图位于https://ansible.github.io/pylibssh/。

$ pip install \
    --extra-index-url=https://ansible.github.io/pylibssh/simple/ \
    --pre \
    ansible-pylibssh

要求

您需要Python 3.6以上版本。

pylibssh需要特别安装libssh。

• libssh版本为0.9.0及以上。

  要安装libssh，请参考其下载页面。

构建模块

在本地环境中，假设系统上已存在libssh共享库，构建工具链存在且环境变量设置正确。

$ git clone https://github.com/ansible/pylibssh.git
$ cd pylibssh
$ pip install tox
$ tox -e build-dists

manylinux兼容的wheel文件

$ git clone https://github.com/ansible/pylibssh.git
$ cd pylibssh
$ pip install tox
$ tox -e build-dists-manylinux1-x86_64  # with Docker

# or with Podman
$ DOCKER_EXECUTABLE=podman tox -e build-dists-manylinux1-x86_64

# to enable shell script debug mode use
$ tox -e build-dists-manylinux1-x86_64 -- -e DEBUG=1

许可协议

此库根据LGPL 2或更高版本进行分发，请参阅此存储库中的LICENSE.rst文件。

错误修复

• 通过SCP下载超过64KB的文件不再失败 – 由@Jakuje。

  相关问题和GitHub上的拉取请求： #621。

错误修复

• 通过SCP下载不存在的远程文件不再导致程序崩溃 – 由@Jakuje。

  相关问题和GitHub上的拉取请求： #208，#325，#620。

打包更新和下游说明

• RPM规范现在不再要求编译的C扩展在EL下存在Build ID – 由@webknjaz。

  相关提交在GitHub上： 9053c1008bb169c8e362a92782d46c7c0d3b1c06，aaa12159b5cdda763a83dcf4ee920510cad83463。

• RPM规范已更新，以预先构建带有隔离禁用的setuptools-scm的 vendored副本，解决EL 9中的构建问题 – 由@webknjaz。

  相关提交在GitHub上： dd85ddefafde8f22ab0239add18a1db9ef789b50。

• RPM定义现在在构建为Fedora Linux时运行导入自检 – 由@webknjaz。

  相关问题和GitHub上的拉取请求： #615。

针对贡献者的更改

• RPM构建现在也已在CI中测试UBI 9.4 – 由@webknjaz。

  相关提交在GitHub上： e9ad0a7d456c99cc848b30b48569235366273672。

打包更新和下游说明

• 在源分发长描述中替换gh角色的自动化已简化，以停止尝试将URL转换为任意的GitHub地址 – 由@webknjaz。

  相关提交在GitHub上： f4ad1b76。

• 树内PEP 517构建后端的正则表达式已被热修复，以正确替换“项目”替换 – 由@webknjaz。

  之前，它生成了很多噪音，而不是一个很好的描述。但现在不再是这样了。

  相关问题和GitHub上的拉取请求： #92752210。

打包更新和下游说明

• 自动化现在替换了长描述和GitHub讨论/发布中的“项目”RST替换 – 由@webknjaz。

  相关提交在GitHub上： 13374a71。

• CI/CD 自动化已修复，以将更改日志更新包含到源分发 tar 包中 - 由 @webknjaz 完成。

  GitHub 上的相关提交： 627f718d。

错误修复

• 当接收到 EOF 或通道未显式关闭时，ansible-pylibssh 不会再崩溃 - 由 @pbrezina 完成。

  以前，如果调用 channel.recv 时 libssh 返回 SSH_EOF 错误，或者在某些特定情况下通道未显式关闭且会话对象首先被垃圾回收，ansible-pylibssh 会崩溃。

  GitHub 上的相关问题和拉取请求： #576。

特性

• 开始公开 SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES 和 SSH_OPTIONS_HOSTKEYS 选项 - 由 @Qalthos 完成。

  GitHub 上的相关问题和拉取请求： #527。

• 已向 Channel 类添加 request_exec() 方法。它公开了一个接口，用于调用底层 libssh 库的相应低级 C-API - 由 @pbrezina 完成。

  此外，以下对 libssh 的调用现在可在同一类中找到： request_exec()、send_eof()、request_send_signal() 和 is_eof（作为属性公开）。

  GitHub 上的相关问题和拉取请求： #576。

改进了文档

• 修复了 Session.connect() 文档字符串中“Connect”的拼写错误 - 由 @donnerhacke 完成。

  GitHub 上的相关问题和拉取请求： #474。

• 在源代码安装指南中添加了设置编译器标志的提示 - @webknjaz。

  GitHub 上的相关问题和拉取请求： #499。

• 通过在片段中使用 Channel.exec_command() 修复了调用远程命令的示例 - 由 @pbrezina 完成。

  之前展示的版本无法正常工作。

  GitHub 上的相关问题和拉取请求： #576。

打包更新和下游说明

• 在将项目目录复制到临时文件夹的逻辑中存在缺陷，当 TMPDIR 设置为项目子目录路径时会导致无限递归。这发生在 Fedora 及其下游，由于使用了 pyproject-rpm-macros。只有通过 pip wheel 才能重现，并且不会影响 pyproject-build 用户。

  由 @hroncok 和 @webknjaz 完成

  GitHub 上的相关提交： 89c9b3a。

• 从现在开始，新版本发布时发布的分发包工件将通过 Sigstore 进行签名 - 由 @webknjaz 完成。

  这是 GitHub Actions CI/CD 工作流自动化的一部分，签名将上传到相应的 GitHub 发布页面。

  GitHub 上的相关提交： 986988a。

• 平台特定的macOS wheel现在使用来自https://www.pythonlang.cn的Python解释器构建。它们被标记为macosx_10_9 – 由@webknjaz。

  GitHub上的相关问题和拉取请求： #333。

• 构建时依赖的toml已被替换为tomli – 由@webknjaz。

  在Python 3.11及以下版本中，tomli发行版才会被拉入。在3.11及以上版本中，现在使用标准库模块tomllib。

  GitHub上的相关问题和拉取请求： #501。

• 从Python 3.7及以上版本开始使用内置的setuptools-scm Git存档支持 – @webknjaz。

  GitHub上的相关问题和拉取请求： #502。

• 增加了对Python 3.12的支持 – 由@Qalthos。

  现在在CI中进行测试，并通过Trove分类器进行宣传。

  GitHub上的相关问题和拉取请求： #532。

• 在Python 3.12及以上版本中，Cython构建时依赖的最小版本为3.0 – 由@webknjaz。

  之前的Cython版本仍然可以在旧版本的Python下构建项目。

  GitHub上的相关问题和拉取请求： #540。

• PEP 660现在已启用 – @webknjaz。

  以前，由于受限制的PEP 517钩子重导入，我们的树内构建后端在较新版本的setuptools中实现但不在早期版本中实现了non-PEP 517钩子时丢失。现在通过使用通配符重新导出setuptools公开的一切来解决这个问题。

  GitHub上的相关问题和拉取请求： #541。

• setuptools-scm构建依赖的CI固定版本已更新到8.1.0 — 该版本修复了Git 2.45.0引入的日期解析不兼容性（GitHub: pypa/setuptools_scm#1038，GitHub: pypa/setuptools_scm#1039） – 由@webknjaz。

  GitHub上的相关问题和拉取请求： #601。

针对贡献者的更改

• 在Read The Docs上标记的发布版本的更改日志页面不再尝试显示草稿部分 – 由@webknjaz。

  GitHub上的相关提交： 852d259。

• 调整了发布工作流程自动化，在构建源分发版时尝试创建标签之前预先配置Git – 由@webknjaz。

  GitHub上的相关提交： f07296f。

• 构建macOS平台特定wheel的CI配置已切换到使用cibuildwheel – 由@webknjaz。

  GitHub上的相关问题和拉取请求： #333。

• 在UBI9 CI运行时中，将OS级别的tox包升级到v3.28.0 – 由@Qalthos。

  GitHub上的相关问题和拉取请求： #461，#473。

• 修复了 Session.connect() 文档字符串中“Connect”的拼写错误 - 由 @donnerhacke 完成。

  GitHub 上的相关问题和拉取请求： #474。

• Packit CI对互联网的访问已恢复 – 由@Qalthos。

  GitHub上的相关问题和拉取请求： #507。

• 开始构建用于测试和打包的 manylinux_2_28 基础镜像 - 由 @Qalthos。

  GitHub上的相关问题和拉取请求： #533。

• 切换回使用 Cython 的原生插件来测量代码覆盖率 - 由 @webknjaz。

  GitHub上的相关问题和拉取请求： #538。

• 添加了针对贡献者和下游补丁的单独的变更日志片段类型 - 由 @webknjaz。

  它们相应的标识符分别是 contrib 和 packaging。它们旨在用于更准确的分类，否则人们会使用 misc。

  GitHub上的相关问题和拉取请求： #539。

• PEP 660现在已启用 – @webknjaz。

  这意味着生态原生可编辑安装模式开始正常工作。

  GitHub上的相关问题和拉取请求： #541。

• 现在，构建 manylinux 轮的重复工作矩阵现在位于单个 GitHub Actions CI/CD 可重复工作流程定义中。

  – @webknjaz

  GitHub上的相关问题和拉取请求： #559。

• 文本工作的重复工作矩阵现在位于单个 GitHub Actions CI/CD 可重复工作流程定义中。

  – @webknjaz

  GitHub上的相关问题和拉取请求： #560。

• 在 发布指南 文档中修复了发布工作流程的位置 - 由 @Qalthos。

  GitHub上的相关问题和拉取请求： #565。

• 更新了 setuptools-scm 构建依赖项的 CI 锁定到 8.1.0 - 此版本修复了 Git 2.45.0 引入的日期解析不兼容性（GitHub: pypa/setuptools_scm#1039，GitHub: pypa/setuptools_scm#1038）- 由 @webknjaz。

  GitHub上的相关问题和拉取请求： #601。

• 修复了 CI/CD 配置，以便在测试阶段结果不考虑的情况下发布到 PyPI 和其他目标。这曾经是工作流程定义中的一个错误，现已修复。

  – 由 @pbrezina 和 @webknjaz。

  GitHub上的相关问题和拉取请求： #602。

特性

• 开始构建使用 libssh v0.9.6 的 manylinux 轮 - 由 @webknjaz (#441)

弃用（在下一个主要版本中删除）

• 由于 GitHub 正在取消其 CI 镜像，项目停止在 Ubuntu 18.04 VM 下进行测试 - 由 @webknjaz (#379)

文档

• 添加了制作新发布的 发布指南 - 由 @webknjaz (#413)

杂项

• 开始使用 Packit 服务测试 RPM 打包规范 - 由 @webknjaz 和 @TomasTomecek (#227，#246)

• 从树内PEP 517构建后端移除了Python 2兼容性代码 - 由@webknjaz（#377）完成

• 修复了在RPM规范中从pyproject.toml中移除expandvars的问题 - 由@webknjaz

  在此补丁之前，sed调用会从那里移除整个build-system.requires条目，尽管这种情况很少发生，但这种情况将不再发生。（#378）

• 宣布正式支持CPython 3.11 - 由@Qalthos（#396）

• 开始提供使用Cython v0.29.32构建的sdists - 由@webknjaz（#399）

• 开始使用Cython v0.29.32构建RPMs - 由@webknjaz（#402）

• 在测试中添加了SSH连接重试辅助工具 - 由@webknjaz（#405）

特性

• 将password_prompt参数添加到connect()，以覆盖使用键盘交互认证时的默认提示“password:” - 由@Qalthos（#331）

• 添加了对:fd:套接字选项的支持 - 由@sabedevops（#343）

杂项

• 重新编写构建脚本来修复许多linux容器生成问题 - 由@Qalthos（#321）

• 在s390x上重新启用CI构建 - 由@Qalthos（#322）

错误修复

• 改进了channel.exec_command，始终使用新创建的ssh_channel以避免在重复调用时发生段错误 - 由@Qalthos（#280）

• 修复了在pylibsshext.session.Session.authenticate_interactive()中的密码提示匹配问题，移除空白字符，检查提示是否以“password:”结尾，并添加了一些额外的日志记录 - 由@dalrrard（#311）

不兼容的更改

• 取消了对Python 2.7和3.5的支持，并标记了对3.10的支持 - 由@Qalthos（#314）

错误修复

• 将sftp.sftp_get更改为将文件写入为字节而不是假设文件是有效的UTF8 - 由@Qalthos（#216）

特性

• 开始为AARCH64、ppc64le和s390x架构构建平台特定的manylinux2010、manylinux2014和manylinux_2_24轮文件，这是由PEP 599和PEP 600引入的 - @webknjaz（#187）

• 添加了对gssapi-with-mic认证的支持 - 由@Qalthos（#195）

文档

• 在我们的安装指南中修复了指向pip升级文档的链接 - @webknjaz（#225）

杂项

• 使用Buildah+Podman在GitHub Actions CI/CD中开始构建AARCH64基本镜像 - @webknjaz (#181)

• 切换到使用pep517库的build CLI - @webknjaz (#199)

• 重构了树内PEP 517构建后端为多个子模块，将入口点移动到pep517_backend.hooks，这也有助于提取通过build CLI命令传递的用户定义的config_settings - @webknjaz (#200)

• 更新了manylinux构建脚本，以启用GSSAPI构建libssh - @Qalthos (#203)

• 添加了初始RPM规范，并在CI中进行持续测试 - @webknjaz (#205)

• 当出现SFTP写入错误时，添加了额外的详细信息 - 由@Qalthos (#216)

• auditwheel现在只在生成的wheel名称中保留一个平台标签 - @webknjaz (#224)

• 改进了许多linux构建脚本，以期望1/2010/2014版本的双别名manylinux标签及其PEP 600对应物在auditwheel repair之后 - @webknjaz (#226)

• 在Fedora的RPM规范中启用了自检检查 - @webknjaz (#228)

• 在CentOS的RPM规范中启用了自检检查 - @webknjaz (#235)

• 在RHEL的RPM规范中启用了自检检查 - @webknjaz (#236)

• 将NAME = "VALUE"添加到flake8-eradicate白名单中，以解决flake8-eradicate 1.1.0引入的测试假阳性 - 由@Qalthos (#258)

• 由于Ubuntu 16.04现已EOL，在GitHub Actions CI/CD中停止测试pylibssh二进制轮 - @webknjaz (#260)

• 在GitHub Actions CI/CD的Fedora下修复了rpmbuild的问题导致的失败 - @webknjaz (#261)

• 在Fedora下将python3-pip声明为构建依赖项，修复了GitHub Actions CI/CD下的RPM创建工作 - @webknjaz (#262)

• 由于GitHub已关闭git协议访问，现在在pre-commit配置中将git协议替换为https - @Qalthos (#266)

错误修复

• 修复了在特定发行版上构建时出现的undefined symbol: ssh_disconnect和相关问题 - 由@Qalthos (#63, #153, #158)

• 修复了在ssh_channel_read_nonblocking失败时传递给"Negative size passed to PyBytes_FromStringAndSize"的负大小问题 - 由@Qalthos (#168)

特性

• 增加了SCP支持 - 由@Qalthos (#151, #157)

文档

• 在文档中添加了初始用户指南 - 由@ganeshrn 和 @webknjaz (#141)

• 在文档中添加了初始测试指南 - 由@ganeshrn 和 @webknjaz (#142)

• 在文档中添加了初始安装指南 - 由@ganeshrn 和 @webknjaz (#145)

杂项

• 将“草稿变更日志”插件迁移到外部sphinxcontrib-towncrier实现 - 由@webknjaz (#123)

• 宣布官方支持CPython 3.9 - 由@webknjaz (#152)

错误修复

• 增强sftp错误处理代码以匹配libssh错误消息 - 由@ganeshrn (#27)

• 修复了会话超时问题，ssh_options_set期望的timeout数据类型为long int - 由@ganeshrn (#46)

• 修复了sftp文件获取问题。在py2中，如果成功写入文件，write()方法返回None，而在py3中，它返回写入到文件的总字节数。添加了一个修复，仅在write()不返回None时检查写入的字节数 - 由@ganeshrn (#58)

• 修复了双重关闭问题，在__dealloc__()中添加了释放分配的channel内存的逻辑 - 由@ganeshrn (#113)

特性

• 添加了libssh客户端API的cython扩展的初始提交 - 由@ganeshrn (#1)

• 为会话添加了proxycommand支持，并将会话异常更新为LibsshSessionException - 由@ganeshrn (#10)

• 添加了对使用身份验证的host key检查的支持 - 由@ganeshrn (#15)

• 将pylibssh目录更改为pylibsshext以避免命名空间冲突 - 由@ganeshrn (#25)

• 为从远程主机获取文件添加了sftp获取功能 - 由@amolkahat (#26)

• 为远程shell添加了对大量响应的支持 - 由@ganeshrn (#40)

• 添加了对键盘身份验证方法的支持 - 由@Qalthos (#105)

不兼容的更改

• 将包名更新为 ansible-pylibssh，以反映该库仅打算实现一组必要的API，以实现Ansible连接插件 - 由 @ganeshrn (#1)

文档

• 记录了如何组合 Towncrier 新闻片段 - 由 @webknjaz (#124)

• 记录了如何为文档做出贡献 - 由 @webknjaz (#126)

杂项

• 更新了需求文件，将 requirements.txt 替换为 requirements-build.in - 由 @akasurde (#14)

• 使tox的主环境能够使用树内的 PEP 517 构建后端 - 由 @webknjaz (#72)

• 重构了towncrier扩展中的sphinx RST解析 - 由 @ewjoachim (#119)

• 修复了树内sphinx扩展中的指令，使其始终触发变更日志文档的重建，以便能够从磁盘上获取任何变更日志片段 - 由 @webknjaz (#120)

• 将Townrier片段README文档标题改为副标题 - 由 @webknjaz

  结果是它不再作为单独的项目在侧边栏中显示。 (#125)

• 通过MyST解析器将Markdown支持集成到文档中 - 由 @webknjaz (#126)

• 将Read the Docs上的构建器切换到dirhtml，因此现在为网站生成基于目录的URL布局 - 由 @webknjaz (#127)

• 启用了 sphinx.ext.autosectionlabel Sphinx 扩展，以自动生成可使用 :ref: 链接的文档部分的目标 - 由 @webknjaz (#128)