Improve and fix repr methods

Author: Avasam

AutoDuck/Dump2HHC.py

@@ -48,7 +48,7 @@ def __str__(self):
             {"context": self.context, "name": self.name, "contains": self.contains}
         )
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         if len(self.contains) > 0:
             return repr(
                 {"context": self.context, "name": self.name, "contains": self.contains}

CHANGES.txt

@@ -14,6 +14,21 @@ https://mhammond.github.io/pywin32_installers.html .
 Coming in build 311, as yet unreleased
 --------------------------------------
 * Fixed a regression that broke special __dunder__ methods with CoClass. (#1870, #2493, @Avasam, @geppi)
+* Added missing quotes and closing parenthesis to `win32com.client.build.MapEntry`'s `repr` (#2555, @Avasam)
+* The following classes will now use the correct subclass name in `repr`: (#2555, @Avasam)
+  * `win32rcparser.StringDef`
+  * `win32pdhquery.QueryError`
+  * `pywin.tools.browser.HLIPythonObject`
+  * `win32comext.axscript.client.pyscript.NamedScriptAttribute`
+  * `win32comext.axscript.client.error.AXScriptException`
+  * `win32comext.axdebug.debugger.ModuleTreeNode`
+  * `win32com.server.exception.COMException`
+  * `win32com.client.VARIANT`
+* The following classes now produce a valid `eval` string representation when calling `repr`: (#2555, @Avasam)
+  * `pywin.tools.browser.HLIPythonObject`
+  * `win32comext.axscript.client.pyscript.NamedScriptAttribute`
+  * `win32comext.axscript.client.error.AXScriptException`
+  * `win32com.server.exception.COMException`
 
 Build 310, released 2025/03/16
 ------------------------------

Pythonwin/pywin/tools/browser.py

@@ -44,12 +44,10 @@ def __lt__(self, other):
     def __eq__(self, other):
         return self.name == other.name
 
-    def __repr__(self):
-        try:
-            type = self.GetHLIType()
-        except:
-            type = "Generic"
-        return f"HLIPythonObject({type}) - name: {self.name} object: {self.myobject!r}"
+    def __repr__(self) -> str:
+        return (
+            f"{self.__class__.__name__}(name={self.name!r}, object={self.myobject!r})"
+        )
 
     def GetText(self):
         try:

Pythonwin/pywin/tools/regedit.py

@@ -331,11 +331,9 @@ def __eq__(self, other):
             and self.userName == other.userName
         )
 
-    def __repr__(self):
-        return "<{} with root={}, key={}>".format(
-            self.__class__.__name__,
-            self.keyRoot,
-            self.keyName,
+    def __repr__(self) -> str:
+        return (
+            f"<{self.__class__.__name__} with root={self.keyRoot}, key={self.keyName}>"
         )
 
     def GetText(self):

com/win32com/client/__init__.py

@@ -555,7 +555,7 @@ def __dir__(self):
         return list(set(attributes))
 
     # Provide a prettier name than the CLSID
-    def __repr__(self):
+    def __repr__(self) -> str:
         # Need to get the docstring for the module for this class.
         try:
             mod_doc = sys.modules[self.__class__.__module__].__doc__
@@ -630,7 +630,7 @@ def __init__(self, oobj=None):
             oobj = pythoncom.new(self.CLSID)
         self.__dict__["_dispobj_"] = self.default_interface(oobj)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"<win32com.gen_py.{__doc__}.{self.__class__.__name__}>"
 
     def __getattr__(self, attr):
@@ -700,5 +700,5 @@ def _del_value(self):
 
     value = property(_get_value, _set_value, _del_value)
 
-    def __repr__(self):
-        return f"win32com.client.VARIANT({self.varianttype!r}, {self._value!r})"
+    def __repr__(self) -> str:
+        return f"{self.__class__.__qualname__}({self.varianttype!r}, {self._value!r})"

com/win32com/client/build.py

@@ -70,7 +70,7 @@ class NotSupportedException(Exception):
 
 
 class MapEntry:
-    "Simple holder for named attibutes - items in a map."
+    """Simple holder for named attributes - items in a map."""
 
     def __init__(
         self,
@@ -92,17 +92,16 @@ def __init__(
         self.doc = doc
         self.resultCLSID = resultCLSID
         self.resultDocumentation = resultDoc
-        self.wasProperty = (
-            0  # Have I been transformed into a function so I can pass args?
-        )
+        self.wasProperty = 0
+        """Has this MapEntry been transformed into a function so it can pass args?"""
         self.hidden = hidden
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return (
-            "MapEntry(dispid={s.dispid}, desc={s.desc}, names={s.names}, doc={s.doc!r}, "
-            "resultCLSID={s.resultCLSID}, resultDocumentation={s.resultDocumentation}, "
-            "wasProperty={s.wasProperty}, hidden={s.hidden}"
-        ).format(s=self)
+            "MapEntry("
+            + ", ".join([f"{key}{value!r}" for key, value in self.__dict__.items()])
+            + ")"
+        )
 
     def GetResultCLSID(self):
         rc = self.resultCLSID

com/win32com/client/dynamic.py

@@ -220,8 +220,8 @@ def __bool__(self):
         # _Possibly_ want to defer to __len__ if available, but I'm not sure this is
         # desirable???
 
-    def __repr__(self):
-        return "<COMObject %s>" % (self._username_)
+    def __repr__(self) -> str:
+        return f"<COMObject {self._username_}>"
 
     def __str__(self):
         # __str__ is used when the user does "print(object)", so we gracefully

com/win32com/client/genpy.py

@@ -111,7 +111,7 @@ def __lt__(self, other):
             return self.doc < other.doc
         return self.order < other.order
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"OleItem: doc={self.doc!r}, order={self.order}"
 
 

com/win32com/server/exception.py

@@ -77,8 +77,8 @@ def __init__(
         # todo - fill in the exception value
         pythoncom.com_error.__init__(self, scode, self.description, None, -1)
 
-    def __repr__(self):
-        return f"<COM Exception - scode={self.scode}, desc={self.description}>"
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}(scode={self.scode!r}, desc={self.description!r})"
 
 
 def IsCOMException(t=None):

com/win32comext/axdebug/debugger.py

@@ -18,8 +18,8 @@ def __init__(self, module):
         self.realNode = None
         self.cont = codecontainer.SourceModuleContainer(module)
 
-    def __repr__(self):
-        return f"<ModuleTreeNode wrapping {self.module}>"
+    def __repr__(self) -> str:
+        return f"<{self.__class__.__name__} wrapping {self.module}>"
 
     def Attach(self, parentRealNode):
         self.realNode.Attach(parentRealNode)