Skip to content

asyncssh 2.22.0

Version history | Download JSON

  • PyPI https://pypi.org/project/asyncssh/
    Repository https://github.com/ronf/asyncssh

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 4614
    "Any" : 15
    "Untyped" : 298
    • 94.0% coverage
    • 93.6% coverage (strict)
    • 4927 typable
      • 4614 typed
      • 298 untyped
      • 15 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 598
    "classes" : 3949
    "other" : 73
    • 157 functions (+2 overloads)
      • 441 parameters
    • 230 classes
      • 1356 methods (+7 overloads)
        • 2531 parameters
      • 62 properties
    • 61 modules
      • 73 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
asyncssh 0.0% 0.0% 0 0
asyncssh.agent 95.5% 95.5% 66 0
asyncssh.agent_unix 100.0% 100.0% 2 0
asyncssh.agent_win32 100.0% 100.0% 2 0
asyncssh.asn1 81.8% 81.8% 88 0
asyncssh.auth 94.5% 94.5% 55 0
asyncssh.auth_keys 94.4% 94.4% 18 0
asyncssh.channel 98.4% 97.4% 307 0
asyncssh.client 100.0% 100.0% 37 0
asyncssh.compression 100.0% 100.0% 18 0
asyncssh.config 92.6% 92.6% 108 0
asyncssh.connection 98.3% 98.2% 829 1
asyncssh.constants 0.0% 0.0% 0 0
asyncssh.crypto.chacha 93.8% 93.8% 32 0
asyncssh.crypto.cipher 92.6% 92.6% 27 0
asyncssh.crypto.dh 83.3% 83.3% 6 0
asyncssh.crypto.dsa 100.0% 100.0% 20 0
asyncssh.crypto.ec 95.7% 95.7% 23 0
asyncssh.crypto.ec_params 100.0% 100.0% 13 0
asyncssh.crypto.ed 87.1% 87.1% 31 0
asyncssh.crypto.kdf 100.0% 100.0% 6 0
asyncssh.crypto.misc 92.9% 92.9% 14 0
asyncssh.crypto.pq 87.5% 87.5% 8 0
asyncssh.crypto.rsa 100.0% 100.0% 29 0
asyncssh.crypto.umac 0.0% 0.0% 4 0
asyncssh.crypto.x509 73.4% 73.4% 64 0
asyncssh.ecdsa 0.0% 0.0% 1 1
asyncssh.editor 95.9% 95.9% 121 0
asyncssh.encryption 97.7% 97.7% 128 0
asyncssh.forward 95.3% 90.7% 43 0
asyncssh.gss 57.1% 57.1% 14 4
asyncssh.gss_unix 92.6% 92.6% 27 0
asyncssh.gss_win32 77.4% 77.4% 31 0
asyncssh.kex 94.6% 94.6% 37 0
asyncssh.kex_dh 0.0% 0.0% 0 0
asyncssh.kex_rsa 0.0% 0.0% 0 0
asyncssh.keysign 92.3% 92.3% 13 0
asyncssh.known_hosts 96.4% 96.4% 28 0
asyncssh.listener 94.9% 94.9% 79 0
asyncssh.logging 85.7% 85.7% 42 0
asyncssh.mac 96.0% 96.0% 25 0
asyncssh.misc 81.9% 81.9% 155 0
asyncssh.packet 98.2% 98.2% 57 0
asyncssh.pattern 93.8% 93.8% 16 0
asyncssh.pbe 100.0% 100.0% 42 0
asyncssh.pkcs11 94.1% 94.1% 34 0
asyncssh.process 94.4% 93.4% 198 0
asyncssh.public_key 91.9% 91.9% 528 0
asyncssh.rsa 92.3% 92.3% 52 0
asyncssh.saslprep 100.0% 100.0% 2 0
asyncssh.scp 93.3% 93.3% 15 0
asyncssh.server 100.0% 100.0% 70 0
asyncssh.session 100.0% 98.2% 55 0
asyncssh.sftp 93.5% 93.5% 960 0
asyncssh.sk 95.0% 95.0% 20 1
asyncssh.socks 90.3% 90.3% 31 0
asyncssh.stream 93.2% 89.7% 117 0
asyncssh.subprocess 96.2% 92.5% 53 0
asyncssh.tuntap 93.0% 93.0% 57 0
asyncssh.version 0.0% 0.0% 0 0
asyncssh.x11 95.7% 95.7% 69 0

Incomplete Annotations

asyncssh.agent (3 missing, 0 any)

Symbol Typable Typed Any
meth SSHAgentKeyPair.init 5 4 0
meth SSHAgentClient.init 2 1 0
meth SSHAgentListener.init 4 3 0

asyncssh.asn1 (16 missing, 0 any)

Symbol Typable Typed Any
meth DERTag.init 4 3 0
meth ObjectIdentifier.init 2 1 0
attr ObjectIdentifier.value 1 0 0
meth BitString.init 4 3 0
attr BitString.value 1 0 0
attr BitString.unused 1 0 0
meth IA5String.init 2 1 0
attr IA5String.value 1 0 0
meth RawDERObject.init 4 3 0
attr RawDERObject.asn1_class 1 0 0
attr RawDERObject.tag 1 0 0
attr RawDERObject.content 1 0 0
meth TaggedDERObject.init 4 3 0
attr TaggedDERObject.asn1_class 1 0 0
attr TaggedDERObject.tag 1 0 0
attr TaggedDERObject.value 1 0 0

asyncssh.auth (3 missing, 0 any)

Symbol Typable Typed Any
meth ServerAuth.init 5 4 0
meth ClientAuth.init 3 2 0
meth Auth.init 3 2 0

asyncssh.auth_keys (1 missing, 0 any)

Symbol Typable Typed Any
meth SSHAuthorizedKeys.init 2 1 0

asyncssh.channel (5 missing, 3 any)

Symbol Typable Typed Any
meth SSHTunTapChannel.init 7 6 0
meth SSHServerChannel.init 12 11 0
meth SSHClientChannel.init 8 7 0
meth SSHChannel.init 7 6 0
meth SSHChannel.get_extra_info 3 3 2
meth SSHChannel.set_extra_info 2 2 1
attr SSHChannel._handler_names 1 0 0

asyncssh.config (8 missing, 0 any)

Symbol Typable Typed Any
attr SSHClientConfig._handlers 1 0 0
attr SSHServerConfig._handlers 1 0 0
meth SSHConfig.init 5 4 0
meth SSHConfig._expand_token 2 0 0
meth SSHConfig._expand_env 2 0 0
attr SSHConfig.loaded 1 0 0

asyncssh.connection (14 missing, 1 any)

Symbol Typable Typed Any
func create_connection 5 4 0
func get_server_host_key 14 13 0
func connect 11 10 0
func create_server 5 4 0
func get_server_auth_methods 15 14 0
func listen_reverse 15 14 0
meth SSHServerConnection.init 6 5 0
func listen 15 14 0
meth SSHAcceptor.init 3 2 0
meth SSHAcceptor.getattr 2 2 1
meth SSHClientConnection.init 6 5 0
meth SSHClientConnection.start_sftp_client 6 4 0
func connect_reverse 11 10 0
meth SSHConnectionOptions.init 3 2 0

asyncssh.crypto.chacha (2 missing, 0 any)

Symbol Typable Typed Any
meth ChachaCipher.init 2 1 0
attr chacha_available 1 0 0

asyncssh.crypto.cipher (2 missing, 0 any)

Symbol Typable Typed Any
meth BasicCipher.init 4 3 0
meth GCMCipher.init 4 3 0

asyncssh.crypto.dh (1 missing, 0 any)

Symbol Typable Typed Any
meth DH.init 3 2 0

asyncssh.crypto.ec (1 missing, 0 any)

Symbol Typable Typed Any
meth ECDH.init 2 1 0

asyncssh.crypto.ed (4 missing, 0 any)

Symbol Typable Typed Any
attr curve448_available 1 0 0
attr curve25519_available 1 0 0
attr ed25519_available 1 0 0
attr ed448_available 1 0 0

asyncssh.crypto.misc (1 missing, 0 any)

Symbol Typable Typed Any
meth CryptoKey.init 2 1 0

asyncssh.crypto.pq (1 missing, 0 any)

Symbol Typable Typed Any
meth PQDH.init 2 1 0

asyncssh.crypto.umac (4 missing, 0 any)

Symbol Typable Typed Any
attr umac32 1 0 0
attr umac64 1 0 0
attr umac128 1 0 0
attr umac96 1 0 0

asyncssh.crypto.x509 (17 missing, 0 any)

Symbol Typable Typed Any
meth X509Certificate.init 3 2 0
attr X509Certificate.data 1 0 0
attr X509Certificate.subject 1 0 0
attr X509Certificate.issuer 1 0 0
attr X509Certificate.key_data 1 0 0
attr X509Certificate.openssl_cert 1 0 0
attr X509Certificate.subject_hash 1 0 0
attr X509Certificate.issuer_hash 1 0 0
attr X509Certificate.user_principals 1 0 0
attr X509Certificate.host_principals 1 0 0
meth X509Name.init 2 1 0
attr X509Name._escape 1 0 0
attr X509Name._unescape 1 0 0
attr X509Name._split_rdn 1 0 0
attr X509Name._split_name 1 0 0
attr X509Name._to_oid 1 0 0
meth X509NamePattern.init 2 1 0

asyncssh.ecdsa (1 missing, 0 any)

Symbol Typable Typed Any
attr PRIME_FIELD 1 0 0

asyncssh.editor (5 missing, 0 any)

Symbol Typable Typed Any
meth SSHLineEditorChannel.init 6 5 0
meth SSHLineEditorChannel.getattr 2 1 0
meth SSHLineEditorSession.init 3 2 0
meth SSHLineEditorSession.getattr 2 1 0
meth SSHLineEditor.init 8 7 0

asyncssh.encryption (3 missing, 0 any)

Symbol Typable Typed Any
meth BasicEncryption.init 3 2 0
meth GCMEncryption.init 2 1 0
meth ChachaEncryption.init 2 1 0

asyncssh.forward (2 missing, 2 any)

Symbol Typable Typed Any
meth SSHForwarder.init 3 2 0
meth SSHForwarder.get_extra_info 3 3 2
meth SSHLocalForwarder.init 3 2 0

asyncssh.gss (6 missing, 0 any)

Symbol Typable Typed Any
meth GSSServer.init 3 2 0
meth GSSClient.init 4 3 0
meth GSSError.init 4 3 0
attr GSSError.maj_code 1 0 0
attr GSSError.min_code 1 0 0
attr GSSError.token 1 0 0

asyncssh.gss_unix (2 missing, 0 any)

Symbol Typable Typed Any
meth GSSBase.init 3 2 0
meth GSSClient.init 4 3 0

asyncssh.gss_win32 (7 missing, 0 any)

Symbol Typable Typed Any
meth GSSBase.init 2 1 0
meth GSSClient.init 4 3 0
meth GSSServer.init 3 2 0
meth GSSError.init 5 4 0
attr GSSError.maj_code 1 0 0
attr GSSError.min_code 1 0 0
attr GSSError.token 1 0 0

asyncssh.kex (2 missing, 0 any)

Symbol Typable Typed Any
meth Kex.init 4 3 0
attr Kex.algorithm 1 0 0

asyncssh.keysign (1 missing, 0 any)

Symbol Typable Typed Any
meth SSHKeySignKeyPair.init 4 3 0

asyncssh.known_hosts (1 missing, 0 any)

Symbol Typable Typed Any
meth SSHKnownHosts.init 2 1 0

asyncssh.listener (4 missing, 0 any)

Symbol Typable Typed Any
meth SSHUNIXClientListener.init 8 7 0
meth SSHClientListener.init 6 5 0
meth SSHForwardListener.init 5 4 0
meth SSHTCPClientListener.init 9 8 0

asyncssh.logging (6 missing, 0 any)

Symbol Typable Typed Any
attr logger 1 0 0
meth SSHLogger.init 4 3 0
meth SSHLogger.log 5 3 0
attr SSHLogger._pkg_logger 1 0 0
attr sftp_logger 1 0 0

asyncssh.mac (1 missing, 0 any)

Symbol Typable Typed Any
meth MAC.init 3 2 0

asyncssh.misc (28 missing, 0 any)

Symbol Typable Typed Any
meth BreakReceived.init 2 1 0
attr BreakReceived.msec 1 0 0
meth HostKeyNotVerifiable.init 3 2 0
meth PermissionDenied.init 3 2 0
meth SignalReceived.init 2 1 0
attr SignalReceived.signal 1 0 0
meth ProtocolError.init 3 2 0
meth PasswordChangeRequired.init 3 2 0
attr PasswordChangeRequired.prompt 1 0 0
attr PasswordChangeRequired.lang 1 0 0
meth Error.init 4 3 0
attr Error.code 1 0 0
attr Error.reason 1 0 0
attr Error.lang 1 0 0
meth MACError.init 3 2 0
meth ConnectionLost.init 3 2 0
meth KeyExchangeFailed.init 3 2 0
meth ProtocolNotSupported.init 3 2 0
meth CompressionError.init 3 2 0
meth ServiceNotAvailable.init 3 2 0
meth TerminalSizeChanged.init 5 4 0
attr TerminalSizeChanged.width 1 0 0
attr TerminalSizeChanged.height 1 0 0
attr TerminalSizeChanged.pixwidth 1 0 0
attr TerminalSizeChanged.pixheight 1 0 0
meth IllegalUserName.init 3 2 0
meth Options.init 3 2 0
meth Record.init 3 2 0

asyncssh.packet (1 missing, 0 any)

Symbol Typable Typed Any
meth SSHPacket.init 2 1 0

asyncssh.pattern (1 missing, 0 any)

Symbol Typable Typed Any
meth CIDRHostPattern.init 2 1 0

asyncssh.pkcs11 (2 missing, 0 any)

Symbol Typable Typed Any
meth SSHPKCS11KeyPair.init 5 4 0
meth SSHPKCS11Session.init 4 3 0

asyncssh.process (11 missing, 2 any)

Symbol Typable Typed Any
meth ProcessError.init 11 10 0
attr ProcessError.env 1 0 0
attr ProcessError.command 1 0 0
attr ProcessError.subsystem 1 0 0
attr ProcessError.exit_status 1 0 0
attr ProcessError.exit_signal 1 0 0
attr ProcessError.returncode 1 0 0
attr ProcessError.stdout 1 0 0
attr ProcessError.stderr 1 0 0
meth SSHServerProcess.init 5 4 0
meth SSHProcess.init 2 1 0
meth SSHProcess.get_extra_info 3 3 2

asyncssh.public_key (43 missing, 0 any)

Symbol Typable Typed Any
meth SSHKey.init 2 1 0
meth SSHKey.generate 3 2 0
meth SSHKey.write_private_key 4 2 0
meth SSHKey.write_public_key 4 2 0
meth SSHKey.append_private_key 4 2 0
meth SSHKey.append_public_key 4 2 0
meth SSHKeyPair.init 11 10 0
attr SSHKeyPair.key_algorithm 1 0 0
attr SSHKeyPair.key_public_data 1 0 0
attr SSHKeyPair.use_executor 1 0 0
attr SSHKeyPair.use_webauthn 1 0 0
attr SSHKeyPair.algorithm 1 0 0
attr SSHKeyPair.sig_algorithms 1 0 0
attr SSHKeyPair.host_key_algorithms 1 0 0
attr SSHKeyPair.public_data 1 0 0
attr SSHKeyPair.sig_algorithm 1 0 0
func generate_private_key 4 3 0
meth SSHCertificate.init 7 6 0
attr SSHCertificate.algorithm 1 0 0
attr SSHCertificate.sig_algorithms 1 0 0
attr SSHCertificate.host_key_algorithms 1 0 0
attr SSHCertificate.key 1 0 0
attr SSHCertificate.public_data 1 0 0
meth SSHX509Certificate.init 4 3 0
attr SSHX509Certificate.subject 1 0 0
attr SSHX509Certificate.issuer 1 0 0
attr SSHX509Certificate.issuer_hash 1 0 0
attr SSHX509Certificate.user_principals 1 0 0
attr SSHX509Certificate.x509_cert 1 0 0
meth SSHLocalKeyPair.init 5 4 0
meth SSHX509CertificateChain.init 5 4 0
attr SSHX509CertificateChain.subject 1 0 0
attr SSHX509CertificateChain.issuer 1 0 0
attr SSHX509CertificateChain.user_principals 1 0 0
meth SSHOpenSSHCertificate.init 13 12 0
attr SSHOpenSSHCertificate.principals 1 0 0
attr SSHOpenSSHCertificate.options 1 0 0
attr SSHOpenSSHCertificate.signing_key 1 0 0
attr OMIT 1 0 0

asyncssh.rsa (4 missing, 0 any)

Symbol Typable Typed Any
attr RSAKey.pkcs8_oid 1 0 0
attr RSAKey.cert_algorithms 1 0 0
attr RSAKey.x509_algorithms 1 0 0
attr RSAKey.all_sig_algorithms 1 0 0

asyncssh.scp (1 missing, 0 any)

Symbol Typable Typed Any
func scp 9 8 0

asyncssh.session (0 missing, 1 any)

Symbol Typable Typed Any
meth SSHSession.connection_made 2 2 1

asyncssh.sftp (62 missing, 0 any)

Symbol Typable Typed Any
meth SFTPEOFError.init 3 2 0
meth SFTPQuotaExceeded.init 3 2 0
meth SFTPFileIsADirectory.init 3 2 0
meth SFTPLinkLoop.init 3 2 0
meth SFTPInvalidFilename.init 3 2 0
meth SFTPNoSuchPath.init 3 2 0
meth SFTPInvalidParameter.init 3 2 0
meth SFTPFailure.init 3 2 0
meth SFTPPermissionDenied.init 3 2 0
meth SFTPAttrs._format_ns 2 1 0
meth SFTPNotADirectory.init 3 2 0
meth SFTPWriteProtect.init 3 2 0
meth SFTPClient.init 4 3 0
meth SFTPClient.stat 4 3 0
meth SFTPClient.lstat 3 2 0
meth SFTPDeletePending.init 3 2 0
meth SFTPLockConflict.init 3 2 0
meth SFTPFileCorrupt.init 3 2 0
meth SFTPNoSpaceOnFilesystem.init 3 2 0
meth SFTPOwnerInvalid.init 3 2 0
meth SFTPUnknownPrincipal.init 4 3 0
attr SFTPUnknownPrincipal.unknown_names 1 0 0
meth SFTPBadMessage.init 3 2 0
meth SFTPInvalidHandle.init 3 2 0
meth SFTPByteRangeLockConflict.init 3 2 0
meth SFTPByteRangeLockRefused.init 3 2 0
meth SFTPConnectionLost.init 3 2 0
meth SFTPNoConnection.init 3 2 0
meth SFTPNoMedia.init 3 2 0
meth SFTPFileAlreadyExists.init 3 2 0
meth SFTPGroupInvalid.init 3 2 0
meth SFTPCannotDelete.init 3 2 0
meth SFTPClientFile.init 8 7 0
meth SFTPClientFile.stat 2 1 0
attr SFTPClientFile.read_len 1 0 0
attr SFTPClientFile.write_len 1 0 0
meth SFTPOpUnsupported.init 3 2 0
meth SFTPServer.init 3 2 0
meth SFTPDirNotEmpty.init 3 2 0
meth SFTPNoMatchingByteRangeLock.init 3 2 0
meth SFTPNoSuchFile.init 3 2 0
meth SFTPServerFile.init 3 2 0
meth SFTPClientHandler.init 6 5 0
attr local_fs 1 0 0
meth SFTPServerHandler.init 5 4 0
attr SFTPServerHandler._vendor_id 1 0 0
meth LocalFile.init 2 1 0
meth SFTPServerFS.init 2 1 0
attr LocalFS.limits 1 0 0
meth SFTPGlob.init 3 1 0
meth SFTPGlob._report_match 3 0 0
meth SFTPGlob._stat 2 1 0
meth SFTPGlob._scandir 2 1 0
meth SFTPGlob.match 4 3 0
meth SFTPHandler.init 3 2 0
meth SFTPHandler._log_extensions 2 1 0
attr SFTPHandler._handler_names 1 0 0
attr SFTPHandler._realpath_check_names 1 0 0
attr SFTPHandler.limits 1 0 0

asyncssh.sk (1 missing, 0 any)

Symbol Typable Typed Any
attr sk_use_webauthn 1 0 0

asyncssh.socks (3 missing, 0 any)

Symbol Typable Typed Any
attr SOCKS5_OK_RESPONSE_HDR 1 0 0
meth SSHSOCKSForwarder.init 3 2 0
attr SOCKS4_OK_RESPONSE 1 0 0

asyncssh.stream (8 missing, 4 any)

Symbol Typable Typed Any
meth SSHWriter.init 4 3 0
meth SSHWriter.get_extra_info 3 3 2
meth SSHReader.init 4 3 0
meth SSHReader.get_extra_info 3 3 2
meth SSHReader.readuntil 3 2 0
meth SSHStreamSession.readuntil 4 3 0
meth SSHServerStreamSession.init 5 2 0
meth SSHSocketStreamSession.init 2 1 0

asyncssh.subprocess (2 missing, 2 any)

Symbol Typable Typed Any
meth SSHSubprocessTransport.init 2 1 0
meth SSHSubprocessPipe.init 3 2 0
meth SSHSubprocessPipe.get_extra_info 3 3 2

asyncssh.tuntap (4 missing, 0 any)

Symbol Typable Typed Any
meth SSHTunTapTransport.init 3 2 0
meth SSHDarwinUTunTransport.init 3 2 0
meth SSHLinuxTunTapTransport.init 4 3 0
meth SSHTunTapOSXTransport.init 4 3 0

asyncssh.x11 (3 missing, 0 any)

Symbol Typable Typed Any
meth SSHX11ClientForwarder.init 3 2 0
meth SSHX11ServerListener.init 3 2 0
meth SSHX11ClientListener.init 6 5 0

Type-Ignore Comments

Flavor Count
type: ignore 7