Changelog¶
Versions follow Semantic Versioning (<major>.<minor>.<patch>).
Backward incompatible (breaking) changes will only be introduced in major
versions with advance notice in the Deprecations section of releases.
To be included in v1.2.3.dev298+gc4af16a56 (if present)¶
v1.2.3.dev298+gc4af16a56 [UNRELEASED DRAFT]¶
(2025-10-10)
Bug fixes¶
The bundled libssh 0.11.2 no longer fails, when the SFTP server announces protocol version 3, but does not provide error message and language tag in the
SSH_FXP_STATUSmessage – by @Jakuje.Related issues and pull requests on GitHub: #222.
Fixed reading files over SFTP that go over the pre-defined chunk size.
Prior to this change, the files could end up being corrupted, ending up with the last read chunk written to the file instead of the entire payload.
– by @Jakuje
Related issues and pull requests on GitHub: #638.
Repetitive calls to
exec_channel()no longer crash and return reliable output – by @Jakuje.Related issues and pull requests on GitHub: #658.
Uploading large files over SCP no longer fails – by @Jakuje.
Related issues and pull requests on GitHub: #661.
Improved performance of SFTP transfers by using larger transfer chunks – by @Jakuje.
Related issues and pull requests on GitHub: #664.
Fixed crash when more operations were called after
session.close()– by @Jakuje.Related issues and pull requests on GitHub: #709.
Features¶
The underlying
SSH_OPTIONS_KEY_EXCHANGEoption oflibsshis now available askey_exchange_algorithms– by @NilashishC.Related issues and pull requests on GitHub: #675.
Deprecations (removal in next major release)¶
Removals and backward incompatible breaking changes¶
Improved documentation¶
Added a Communication section to the main documentation page – by @Andersson007.
Related issues and pull requests on GitHub: #640.
Fixed the argument order in the
scp.put()usage example – by @kucharskim.Related issues and pull requests on GitHub: #646.
Packaging updates and notes for downstreams¶
PyPI now only ships PEP 660-compatible manylinux wheels – by @webknjaz.
Related issues and pull requests on GitHub: #562.
The
pytest-forkeddependency of build, development and test environments was removed – by @Jakuje.The wheels are now built in cached container images with a correctly set platform identifier.
– by @webknjaz
Related issues and pull requests on GitHub: #692.
The
manylinuxbuild scripts now limitcmakebelow version 4 – by @webknjaz.Related issues and pull requests on GitHub: #713.
Stopped skipping SCP tests in the RPM spec – by @Jakuje.
Related issues and pull requests on GitHub: #714.
Started bundling a copy of libssh 0.11.1 in platform-specific wheels published on PyPI – by @Jakuje.
Related issues and pull requests on GitHub: #735.
Updated the bundled copy of OpenSSL to the latest version 3.5.0 in
manylinuxwheels – by @Jakuje.Related issues and pull requests on GitHub: #738.
Updated the bundled version of libssh to 0.11.2 in platform-specific wheels published on PyPI – by @Jakuje.
Related issues and pull requests on GitHub: #753.
The RPM spec file no longer makes use of unpackaged dists from PyPI on RHEL. The configuration is almost identical to the one for Fedora. Only the
setuptools-scmspec is temporarily patched to allow older versions under RHEL.– by @webknjaz
Related issues and pull requests on GitHub: #759.
A workaround has been applied to the in-tree build backend that prevents Cython from hanging when
libsshheader files are missing – by @webknjaz.The patch makes
cythonize()single-threaded becausemultiprocessinggets stuck. The upstream will eventually fix this by migrating toconcurrent.futures.Related issues and pull requests on GitHub: #762, #769, #770.
Updated the bundled version of libssh to 0.11.3 in platform-specific wheels published on PyPI – by @Jakuje.
Related issues and pull requests on GitHub: #766.
Contributor-facing changes¶
The manylinux build scripts have been adjusted to resolve the dependency conflict between certain
packagingandsetuptoolsversions – by @webknjaz.Previously, this was making some of the CI jobs crash with a traceback when building said wheels.
Related commits on GitHub: 1dfbf70fdfd99ae75068fdb3630790c96101a96a.
The Git archives are now immutable per the packaging recommendations. This allows downstreams safely use GitHub archive URLs when re-packaging – by @webknjaz.
Related commits on GitHub: ea34887831a0c6547b32cd8c6a035bb77b91e771.
Manylinux wheels are no longer built using custom shell scripts. Instead, this is delegated to the
cibuildwheeltool.– by @webknjaz
Related issues and pull requests on GitHub: #562.
Updated the version of
libsshto the latest release v0.11.1 in the cachedmanylinuxbuild environment container images – by @Jakuje.Related issues and pull requests on GitHub: #636.
All the uses of
actions/upload-artifact@v3andactions/download-artifact@v3have been updated to usev4. This also includes bumpingre-actors/checkout-python-sdisttorelease/v2as it usesactions/download-artifactinternally.– by @NilashishC and @webknjaz
Related issues and pull requests on GitHub: #676.
The
dumb-pypi-produced static package index now renders correct URLs to the distribution packages – by @webknjaz.Related issues and pull requests on GitHub: #678, #679, #749.
The CI is now configured to use tox run --installpkg when testing pre-built dists. This replaces the previously existing tox-level hacks in
test-binary-distsandtest-source-distsenvironments that have now been removed.– by @webknjaz
Related issues and pull requests on GitHub: #688.
The wheel building workflows have been updated to set the OCI image platform identifiers to legal values like
linux/arm64.– by @webknjaz
Related issues and pull requests on GitHub: #692.
The CI is now configured to always set job timeout values. This will ensure that the jobs that get stuck don’t consume all 6 hours just hanging, improving responsiveness and the overall CI/CD resource usage.
– by @webknjaz
Related issues and pull requests on GitHub: #706.
The linting is now configured to check schemas of the Read The Docs configuration file and the GitHub Actions CI/CD workflow files in addition to enforcing timeouts.
– by @webknjaz
Related issues and pull requests on GitHub: #707.
The
multiarch/qemu-user-staticimage got replaced withtonistiigi/binfmtbecause the latter is no longer maintained and the former includes the fixed version of QEMU.– by @webknjaz
Related issues and pull requests on GitHub: #713.
Added Fedora 41 and 42 to CI configuration – by @Jakuje.
Related issues and pull requests on GitHub: #715.
Removed needless step from CI adjusting centos8 repositories – by @Jakuje.
Related issues and pull requests on GitHub: #716.
The CI/CD infrastructure no longer pre-builds custom manylinux images for building wheel targeting
manylinux1,manylinux2010andmanylinux2014tags.– by @webknjaz
Related issues and pull requests on GitHub: #730.
The host OS is now ARM-based when building
manylinux_*_*_aarch64images for CI/CD – by @webknjaz.Related issues and pull requests on GitHub: #731.
False negative warnings reported by
coveragepywhen are now disabled. They are evident whenpytest-covruns with thepytest-xdistintegration.pytest8.4 gives them more visibility and outfilterwarnings = errorsetting was turning them into errors before this change.– by @webknjaz
Related issues and pull requests on GitHub: #732.
GitHub Actions CI/CD no longer runs jobs that install source distributions into the tox environments for testing – by @webknjaz.
This is a temporary workaround for an upstream bug in tox and said jobs are non-essential.
Related issues and pull requests on GitHub: #733.
Updated the pre-built
libffiversion to 3.4.8 in the cachedmanylinuxbuild environment container images – by @Jakuje.Related issues and pull requests on GitHub: #734.
Reverted workaround keeping the old CMake version installed as the new
libsshworks with newer versions – by @Jakuje.Related issues and pull requests on GitHub: #737.
The CI infrastructure now produces
manylinux_2_31_armv7lbase images withlibsshandopensslpre-built – by @Jakuje and @webknjaz.Related issues and pull requests on GitHub: #740.
Started caching
manylinuxbuild images to be used for producing2_34tagged wheels inbuild-manylinux-container-imagesworkflow – by @KB-perByte.Related issues and pull requests on GitHub: #741.
The
reusable-cibuildwheel.ymlworkflow has been refactored to be more generic andci-cd.ymlnow holds all the configuration toggles – by @webknjaz.Related issues and pull requests on GitHub: #750.
Updated the version of
libsshto the latest release v0.11.2 in the cachedmanylinuxbuild environment container images – by @Jakuje.Related issues and pull requests on GitHub: #752.
When building wheels, the source distribution is now passed directly to the
cibuildwheelinvocation – by @webknjaz.Related issues and pull requests on GitHub: #754.
Fixed link to python3-pytest for CentOS 9 Stream as it was recently moved from CRB to AppStream – by @Jakuje.
Related issues and pull requests on GitHub: #758.
The CI/CD jobs for smoke-testing RPMs have been simplified and now, they execute the same steps for all distro types. They make use of
pyproject-rpm-macroseven under RHEL. Installing external RPMs is the only conditional step that is skipped on Fedora.– by @webknjaz
Related issues and pull requests on GitHub: #759.
The
requiressetting has been removed fromtox.ini, which works around the upstream tool bug. This enabled us to re-introduce CI jobs testing against sdist under Python 3.12 and newer – by @webknjaz.Related issues and pull requests on GitHub: #764.
Updated the version of
libsshto the latest release v0.11.3 in the cachedmanylinuxbuild environment container images – by @Jakuje.Related issues and pull requests on GitHub: #765.
Changed tests to use more lightweight ECDSA keys to avoid timeouts – by @Jakuje.
Related issues and pull requests on GitHub: #768.
Released versions¶
v1.2.2¶
(2024-06-27)
Bug fixes¶
v1.2.1¶
(2024-06-27)
Bug fixes¶
Packaging updates and notes for downstreams¶
The RPM specification now opts out of demanding that the compiled C-extensions have a Build ID present under EL – by @webknjaz.
Related commits on GitHub: 9053c1008bb169c8e362a92782d46c7c0d3b1c06, aaa12159b5cdda763a83dcf4ee920510cad83463.
The RPM specification has been updated to pre-build the vendored copy of
setuptools-scmwith the isolation disabled, addressing the build problem in EL 9 – by @webknjaz.Related commits on GitHub: dd85ddefafde8f22ab0239add18a1db9ef789b50.
The RPM definition now runs import self-checks when it is built for Fedora Linux – by @webknjaz.
Related issues and pull requests on GitHub: #615.
Contributor-facing changes¶
RPM builds are now also tested against UBI 9.4 in CI – by @webknjaz.
Related commits on GitHub: e9ad0a7d456c99cc848b30b48569235366273672.
v1.2.0.post4¶
(2024-06-09)
Packaging updates and notes for downstreams¶
Substituting the
ghrole in source distribution long description has been simplify to stop attempting to make URLs to arbitrary GitHub addresses – by @webknjaz.Related commits on GitHub: f4ad1b76.
The in-tree PEP 517 build backend’s regular expression has been hotfixed to replace the “project” substitution correctly – by @webknjaz.
Previously, it was generating a lot of noise instead of a nice description. But not anymore.
Related issues and pull requests on GitHub: #92752210.
v1.2.0.post2¶
(2024-06-08)
Packaging updates and notes for downstreams¶
The automation now replaces the “project” RST substitution in the long description and GitHub Discussions/Releases – by @webknjaz.
Related commits on GitHub: 13374a71.
The CI/CD automation has been fixed to include changelog updates into source distribution tarballs – by @webknjaz.
Related commits on GitHub: 627f718d.
v1.2.0¶
(2024-06-07)
Bug fixes¶
ansible-pylibssh no longer crashes when received EOF or when channel is not explicitly closed – by @pbrezina.
Previously, ansible-pylibssh crashed if
channel.recvwas called andlibsshreturnedSSH_EOFerror. It also crashed on some special occasions where channel was not explicitly closed and the session object was garbage-collected first.Related issues and pull requests on GitHub: #576.
Features¶
Started exposing the
SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPESandSSH_OPTIONS_HOSTKEYSoptions publicly – by @Qalthos.Related issues and pull requests on GitHub: #527.
The
request_exec()method was added to theChannelclass. It exposes an interface for calling the respective low-level C-API of the underlyinglibsshlibrary – by @pbrezina.Additionally, the following calls to
libsshare now available in the same class:request_exec(),send_eof(),request_send_signal()andis_eofwhich is exposed as aproperty.Related issues and pull requests on GitHub: #576.
Improved documentation¶
Fixed spelling of “Connect” in the
Session.connect()docstring – by @donnerhacke.Related issues and pull requests on GitHub: #474.
Added a tip to the installation guide on how to set compiler flags when installing from source – @webknjaz.
Related issues and pull requests on GitHub: #499.
Fixed the example of invoking remote commands by using
Channel.exec_command()in snippets – by @pbrezina.Its previously showcased version wasn’t functional.
Related issues and pull requests on GitHub: #576.
Packaging updates and notes for downstreams¶
A flaw in the logic for copying the project directory into a temporary folder that led to infinite recursion when
TMPDIRwas set to a project subdirectory path. This was happening in Fedora and its downstream due to the use of pyproject-rpm-macros. It was only reproducible withpip wheeland was not affecting thepyproject-buildusers.Related commits on GitHub: 89c9b3a.
From now on, the published distribution package artifacts for the new releases are signed via Sigstore – by @webknjaz.
This is happening as a part of the GitHub Actions CI/CD workflow automation and the signatures are uploaded to the corresponding GitHub Release pages.
Related commits on GitHub: 986988a.
The platform-specific macOS wheels are now built using the Python interpreter from https://python.org. They are tagged with
macosx_10_9– by @webknjaz.Related issues and pull requests on GitHub: #333.
The
tomlbuild time dependency has been replaced withtomli– by @webknjaz.The
tomlidistribution is only pulled in under Python versions below 3.11. On 3.11 and higher, the standard library moduletomllibis now used instead.Related issues and pull requests on GitHub: #501.
Started using the built-in
setuptools-scmGit archive support under Python 3.7 and higher – @webknjaz.Related issues and pull requests on GitHub: #502.
Added support for Python 3.12 – by @Qalthos.
It is now both tested in the CI and is advertised through the Trove classifiers.
Related issues and pull requests on GitHub: #532.
The
Cythonbuild time dependency now has the minimum version of 3.0 under Python 3.12 and higher – by @webknjaz.The previous versions of
Cythonare still able to build the project under older Python versions.Related issues and pull requests on GitHub: #540.
PEP 660 is now enabled – @webknjaz.
Previously, due to restrictive PEP 517 hook reimports, our in-tree build backend was losing non-PEP 517 hooks implemented in newer versions of
setuptoolsbut not the earlier ones. This is now addressed by reexporting everything thatsetuptoolsexposes with a wildcard.Related issues and pull requests on GitHub: #541.
The
setuptools-scmbuild dependency CI pin was updated to 8.1.0 — this version fixes a date parsing incompatibility introduced by Git 2.45.0 (pypa/setuptools_scm#1038, pypa/setuptools_scm#1039) – by @webknjaz.Related issues and pull requests on GitHub: #601.
Contributor-facing changes¶
The Changelog page for the tagged release builds on Read The Docs does not attempt showing the draft section anymore – by @webknjaz.
Related commits on GitHub: 852d259.
Adjusted the publishing workflow automation to pre-configure Git before attempting to create a tag when building a source distribution – by @webknjaz.
Related commits on GitHub: f07296f.
The CI configuration for building the macOS platform-specific wheels switched to using
cibuildwheel– by @webknjaz.Related issues and pull requests on GitHub: #333.
The OS-level tox package was upgraded to v3.28.0 in the UBI9 CI runtime – by @Qalthos.
Fixed spelling of “Connect” in the
Session.connect()docstring – by @donnerhacke.Related issues and pull requests on GitHub: #474.
The Packit CI access to the internet has been restored – by @Qalthos.
Related issues and pull requests on GitHub: #507.
Started building
manylinux_2_28base images for testing and packaging in the CI/CD infrastructure – by @Qalthos.Related issues and pull requests on GitHub: #533.
Switched back to using Cython’s native plugin for measuring code coverage – by @webknjaz.
Related issues and pull requests on GitHub: #538.
Added separate changelog fragment types for contributor- and downstream-facing patches – by @webknjaz.
Their corresponding identifiers are
contribandpackagingrespectively. They are meant to be used for more accurate classification, where one would resort to usingmiscotherwise.Related issues and pull requests on GitHub: #539.
PEP 660 is now enabled – @webknjaz.
This effectively means that the ecosystem-native editable install mode started working properly.
Related issues and pull requests on GitHub: #541.
The duplicated jobs matrices for building manylinux wheels now reside in a single GitHub Actions CI/CD reusable workflow definition.
Related issues and pull requests on GitHub: #559.
The duplicated jobs matrices of the text jobs now reside in a single GitHub Actions CI/CD reusable workflow definition.
Related issues and pull requests on GitHub: #560.
Fixed the location of release workflow in the Release Guide document – by @Qalthos.
Related issues and pull requests on GitHub: #565.
The
setuptools-scmbuild dependency CI pin was updated to 8.1.0 — this version fixes a date parsing incompatibility introduced by Git 2.45.0 (pypa/setuptools_scm#1039, pypa/setuptools_scm#1038) – by @webknjaz.Related issues and pull requests on GitHub: #601.
The CI/CD configuration was fixed to allow publishing to PyPI and other targets disregarding the test stage outcome. This used to be a bug in the workflow definition that has now been fixed.
Related issues and pull requests on GitHub: #602.
v1.1.0 (2022-12-05)¶
Features¶
Deprecations (removal in next major release)¶
Documentation¶
Added a Release Guide for making new releases – by @webknjaz (#413)
Miscellaneous¶
Started testing RPM packaging spec with Packit service – by @webknjaz and @TomasTomecek (#227, #246)
Removed the remains of Python 2 compatiblity code from the in-tree PEP 517 build backend – by @webknjaz (#377)
Fixed removing
expandvarsfrompyproject.tomlin an RPM spec – by @webknjazBefore this patch, the
sedinvocation removed entirebuild-system.requiresentry from there, in rare cases but this won’t be happening anymore. (#378)Declared official support of CPython 3.11 – by @Qalthos (#396)
Started shipping sdists built with Cython v0.29.32 – by @webknjaz (#399)
Started building RPMs with Cython v0.29.32 – by @webknjaz (#402)
Added an SSH connection re-try helper to tests – by @webknjaz (#405)
v1.0.0 (2022-09-14)¶
Features¶
Added
password_promptargument toconnect()to override the default prompt of “password:” when using keyboard-interactive authentication – by @Qalthos (#331)Added support for
:fd:socket option – by @sabedevops (#343)
Miscellaneous¶
v0.4.0 (2022-04-26)¶
Bugfixes¶
Improved
channel.exec_commandto always use a newly createdssh_channelto avoid segfaults on repeated calls – by @Qalthos (#280)Fixed password prompt match in
pylibsshext.session.Session.authenticate_interactive()to strip whitespace, check that the prompt only ends withpassword:, and added a little extra logging – by @dalrrard (#311)
Backward incompatible changes¶
v0.3.0 (2021-11-03)¶
Bugfixes¶
Features¶
Documentation¶
Miscellaneous¶
Started building AARCH64 base images with Buildah+Podman in GitHub Actions CI/CD – @webknjaz (#181)
Restructured the in-tree PEP 517 build backend into multiple submodules moving the entry-point to
pep517_backend.hooksthat also facilitates extraction of user-definedconfig_settingspassed by the end-user (packager) via thebuildCLI command – @webknjaz (#200)Updated manylinux build script to build libssh with GSSAPI enabled – @Qalthos (#203)
Added an initial RPM spec continuously tested in the CI – @webknjaz (#205)
Added additional details when SFTP write errors are raised – by @Qalthos (#216)
Made
auditwheelonly keep one platform tag in the produced wheel names – @webknjaz (#224)Improved manylinux build scripts to expect dual-aliased manylinux tags produced for versions 1/2010/2014 along with their PEP 600 counterparts after
auditwheel repair– @webknjaz (#226)Enabled self-test checks in the RPM spec for Fedora – @webknjaz (#228)
Enabled self-test checks in the RPM spec for CentOS – @webknjaz (#235)
Enabled self-test checks in the RPM spec for RHEL – @webknjaz (#236)
Added
NAME = "VALUE"to flake8-eradicate whitelist to work around test false positive introduced in flake8-eradicate 1.1.0 – by @Qalthos (#258)Stopped testing
pylibsshbinary wheels under Ubuntu 16.04 in GitHub Actions CI/CD because it is EOL now – @webknjaz (#260)Fixed failing fast on problems with
rpmbuildin GitHub Actions CI/CD under Fedora – @webknjaz (#261)Declare
python3-pipa build dependency under Fedora fixing the RPM creation job in GitHub Actions CI/CD under Fedora – @webknjaz (#262)Replaced git protocols in pre-commit config with https now that GitHub has turned off git protocol access – @Qalthos (#266)
v0.2.0 (2021-03-01)¶
Bugfixes¶
Features¶
Documentation¶
Miscellaneous¶
Migrated the “draft changelog” plugin to the external sphinxcontrib-towncrier implementation – by @webknjaz (#123)
Declared official support of CPython 3.9 – by @webknjaz (#152)
v0.1.0 (2020-08-12)¶
Bugfixes¶
Enhanced sftp error handling code to match with libssh error messages – by @ganeshrn (#27)
Fixed session timeout issue, the data type of timeout is expected by
ssh_options_setis of typelong int– by @ganeshrn (#46)Fixed sftp file get issue. On py2 The file
write()method returnsNoneon py2 if bytes are written to file successfully, whereas on py3 it returns total number of bytes written to file. Added a fix to check for the number of bytes written only in the case whenwrite()does not returnNone– by @ganeshrn (#58)Fixed double close issue, added logic to free the channel allocated memory within __dealloc__() – by @ganeshrn (#113)
Features¶
Added cython extension for libssh client API’s initial commit – by @ganeshrn (#1)
Added proxycommand support for session and update session exeception to
LibsshSessionException– by @ganeshrn (#10)Added support for host key checking with authentication – by @ganeshrn (#15)
Changed pylibssh dir to pylibsshext to avoid ns collision – by @ganeshrn (#25)
Added sftp get functionality to fetch file from remote host – by @amolkahat (#26)
Added support to receive bulk response for remote shell – by @ganeshrn (#40)
Added the support for keyboard-authentication method – by @Qalthos (#105)
Backward incompatible changes¶
Documentation¶
Miscellaneous¶
Updated requirements file to replace
requirements.txtwithrequirements-build.in– by @akasurde (#14)Made tox’s main env pick up the in-tree PEP 517 build backend – by @webknjaz (#72)
Refactored sphinx RST parsing in towncrier extension – by @ewjoachim (#119)
Hotfixed the directive in the in-tree sphinx extension to always trigger the changelog document rebuilds so that it’d pick up any changelog fragments from disk – by @webknjaz (#120)
Turned the Townrier fragments README doc title into subtitle – by @webknjaz
The effect is that it doesn’t show up in the side bar as an individual item anymore. (#125)
Integrated Markdown support into docs via the MyST parser – by @webknjaz (#126)
Switched the builder on Read the Docs to dirhtml so it now generates a dir-based URL layout for the website – by @webknjaz (#127)
Enabled sphinx.ext.autosectionlabel Sphinx extension to automatically generate reference targets for document sections that can be linked against using
:ref:– by @webknjaz (#128)