TODO/tweak to PKey.__repr__

paramiko · May 25, 2023 · fd06863 · fd06863
1 parent 72898db
commit fd06863
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/paramiko/pkey.py b/paramiko/pkey.py
@@ -249,12 +249,18 @@ def __init__(self, msg=None, data=None):
         """
         pass
 
+    # TODO: arguably this might want to be __str__ instead? ehh
+    # TODO: ditto the interplay between showing class name (currently we just
+    # say PKey writ large) and algorithm (usually == class name, but not
+    # always, also sometimes shows certificate-ness)
+    # TODO: if we do change it, we also want to tweak eg AgentKey, as it
+    # currently displays agent-ness with a suffix
     def __repr__(self):
         comment = ""
         # Works for AgentKey, may work for others?
         if hasattr(self, "comment") and self.comment:
             comment = f", comment={self.comment!r}"
-        return f"{self.__class__.__name__}(alg={self.algorithm_name}, bits={self.get_bits()}, fp={self.fingerprint}{comment})"  # noqa
+        return f"PKey(alg={self.algorithm_name}, bits={self.get_bits()}, fp={self.fingerprint}{comment})"  # noqa
 
     # TODO 4.0: just merge into __bytes__ (everywhere)
     def asbytes(self):

diff --git a/tests/auth.py b/tests/auth.py
@@ -404,7 +404,7 @@ def repr_shows_pkey_repr(self):
             source = InMemoryPrivateKey("foo", pkey)
             assert (
                 repr(source)
-                == "InMemoryPrivateKey(pkey=Ed25519Key(alg=ED25519, bits=256, fp=SHA256:J6VESFdD3xSChn8y9PzWzeF+1tl892mOy2TqkMLO4ow))"  # noqa
+                == "InMemoryPrivateKey(pkey=PKey(alg=ED25519, bits=256, fp=SHA256:J6VESFdD3xSChn8y9PzWzeF+1tl892mOy2TqkMLO4ow))"  # noqa
             )
 
         def repr_appends_agent_flag_when_AgentKey(self):
@@ -413,7 +413,7 @@ def repr_appends_agent_flag_when_AgentKey(self):
             source = InMemoryPrivateKey("foo", pkey)
             assert (
                 repr(source)
-                == "InMemoryPrivateKey(pkey=AgentKey(alg=ED25519, bits=256, fp=SHA256:J6VESFdD3xSChn8y9PzWzeF+1tl892mOy2TqkMLO4ow)) [agent]"  # noqa
+                == "InMemoryPrivateKey(pkey=PKey(alg=ED25519, bits=256, fp=SHA256:J6VESFdD3xSChn8y9PzWzeF+1tl892mOy2TqkMLO4ow)) [agent]"  # noqa
             )
 
     class OnDiskPrivateKey_: