fs.sshfs

Fixed

• SSHFS.move not supporting the preserve_time argument (#51).

Added

• SSHFS.upload (resp. download) implementation using paramiko.SFTP.putfo
  (resp. getfo).
• This changelog file.

Changed

• Switched from Travis-CI and AppVeyor to GitHub Actions for continuous integration.
• Rewrote README.rst in Markdown format.
• Mark the project as Stable in setup.cfg classifiers.

Added

• Semantic version specifiers to dependencies in setup.cfg.

Added

• Explicit support for Python 3.8.

Fixed

• Issue with SSHFS.close when exiting while an SSHFS instance is still open.

Added

• Dedicated implementation of SSHFS.scandir using paramiko.SFTP.listdir_attr
  (@jwnimmer-tri #37).

Fixed

• Assume unknown platform is _exec_command throws an exception
  (@mrk-its #35).

Added

• Explicit support for Python 3.7.
• Section documenting the support of sftp FS URLs to README.rst.
• support_rename key to the SSHFS.getmeta options.
• SSHFS.move implementation using the paramiko.SFTP.rename function.

Fixed

• Typos in README.rst
  (@jayvdb #28,
  @timnyborg #32).

Changed

• Replace cached-property dependency with improved property-cached fork.

Added

• prefetch argument to SSHFS.openbin to enable prefetching files when
  they are open in reading mode.

Added

• Support for passing arbitrary arguments to paramiko.SSHClient.connect
  in SSHFS.__init__ (@paulgessinger #23).

Added

• Explicit support for fs ~=2.2.

Changed

• Bumped minimum required fs version to v2.2.0.

Fixed

• Explicitly register SSHOpener as an opener with fs.opener.registry.install
  for cases where the setuptools metadata are unavailable and entry points
  cannot be loaded.

Fixed

• License file not being packed in wheel distributions.

Removed

• enum34 optional dependency, originally required for Python < 3.4.
• Unneeded imports in the fs.sshfs submodules.

Fixed

• Test dependencies being unconditionally installed
  (@ReimarBauer #1).

Added

• Missing docstrings to fs.sshfs module members.
• SSFS.geturl implementation, allowing to retrieve an SSH URL
  for the download purpose.
• Allow SSHFS to use SSH configuration values (from ~/.ssh/config for instance)
  if the given host is found in it.

Changed

• Make tests run against the local version of the code, allowing tests to
  run without having to install the module first.
• Rewrite docstrings in Google style to be consistent with PyFilesystem2
  documentation style.

Removed

• SSHFS.getsyspath implementation.

Fixed

• Potential bug occuring with _SSHFileWrapper.truncate(0).
• seek and truncate methods of _SSHFileWrapper returning None.

Fixed

• Make SSHFile record the mode it was created with.

Added

• semantic-version test requirement.
• SSHFS.islink method with behaviour matching OSFS.islink.
• Additional documentation of constructor arguments in SSHFS docstring.
• Independent timeout for arbitrary SSH commands (#39).
• Support for passing arbitrary paramiko.MissingHostKeyPolicy to SSHFS.

Changed

• SSHFS.getinfo now follows symlinks like OSFS.getinfo.

Fixed

• Threading issue with SSHFile all sharing the same connection, causing
  issues with code working on several files in parallel.
  (@willmcgugan #17)
• SSHFile not being writable when opened in exclusive mode.

Changed

• Dropped support for Python 3.3 and Python 3.4.
• Bumped minimum required fs version to v2.1.0.
• Cache SSHFS.locale and SSHFS.platform properties using cached-property.
• SSHFS now uses the timeout argument it received on initialization when
  running an arbitrary command on the remote server.

Fixed

• Catch all exceptions and not just FSError in SSHOpener.

Changed

• Make SSHFile transfers to be pipelined by default to increase performance.