Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add types and type checking so mypy type checking is happy #265

Open
keithel-qt opened this issue Oct 6, 2022 · 0 comments
Open

Add types and type checking so mypy type checking is happy #265

keithel-qt opened this issue Oct 6, 2022 · 0 comments

Comments

@keithel-qt
Copy link

Mypy is presently not happy with sshtunnel, as it is not annotated with python types in it's variables and function signatures.

If you try importing sshtunnel in a project, and you run mypy against it, you will get messages similar to this:

myproject/ssh_tunnel.py:2: error: Skipping analyzing "sshtunnel": module is installed, but missing library stubs or py.typed marker
myproject/main.py:13: error: Skipping analyzing "sshtunnel": module is installed, but missing library stubs or py.typed marker
myproject/main.py:13: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 2 errors in 2 files (checked 32 source files)
[cargo-make] ERROR - Error while executing command, exit code: 1
[cargo-make] WARN - Build Failed.

I created this issue to track progress of sshtunnel working well with Mypy - being able to check sshtunnel's static typing.
This also would encompass adding static typing to sshtunnel, which will aid testing.

@tamird tamird mentioned this issue Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant