types-pysftp

What it is and what it does

types-pysftp is a type stub package that provides static type annotations for the pysftp SFTP client library. It allows type checkers like mypy and pyright to understand and validate the types of pysftp's API, catching type errors in code that uses pysftp before runtime. The package is generated from and maintained as part of the typeshed project, the standard repository of type stubs for the Python ecosystem.

The package targets pysftp version 0.2.* and has been tested with mypy 2.1.0 and pyright 1.1.410. It depends on types-paramiko for type information about paramiko, which pysftp itself uses. Installation is straightforward and adds no runtime overhead—it only affects static analysis. However, the description explicitly notes that types-pysftp is unmaintained and will not receive updates; fixes should be contributed to typeshed directly.

Use it for:

• Enable mypy or pyright to type-check code that calls pysftp methods, catching parameter and return type mismatches.
• Provide IDE autocompletion and inline type hints when writing code that uses pysftp.
• Validate SFTP connection and file transfer operations in a CI/CD pipeline using static type checking.
• Document the expected types of pysftp's public API for developers unfamiliar with the library.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides type hints for the pysftp package, enabling static type checkers like mypy and pyright to validate code that uses pysftp for SFTP operations.

Yes, if you use pysftp and run static type checking with mypy or pyright. Install it alongside pysftp to enable type validation. Be aware that the package is unmaintained and targets only pysftp 0.2.*; if you use a different version or need updated stubs, contribute fixes to typeshed directly rather than expecting updates here.

Install

types-pysftp on PyPI

pip install types-pysftp

uv add types-pysftp

poetry add types-pysftp

Installing types-pysftp

Before you install

Low friction installation as a pure Python stub package. Actively maintained within the typeshed project, though the description notes types-pysftp itself is unmaintained and won't receive updates beyond what typeshed provides.

License in practice

Licensed under Apache-2.0 (permissive), imposing no significant restrictions on use or redistribution.

Quickstart

pip install types-pysftp

# In your code using pysftp:
import pysftp

with pysftp.Connection('host', username='user', password='pass') as sftp:
    sftp.get('remote.txt', 'local.txt')

Requires Python 3.10 or later; pysftp itself must be installed separately for runtime use.

Verify before relying

• Whether the stub package remains synchronized with pysftp 0.2.* releases after the stated unmaintained status.
• Compatibility with type checkers other than mypy 2.1.0 and pyright 1.1.410.

Package facts

Evidence: types_pysftp-0.2.17.20260613-py3-none-any.whl

Tags

More Software Development packages