Improve string representations of SummaryCounters (#1233)

Instead of for example {'nodes_created': 42, 'labels_removed': 0, '_contains_system_updates': True} the `repr` string representation is now SummaryCounters({'nodes-created': 42, 'labels-removed': 0, 'contains-system-updates': True}) or similar. This is more in line with Python's recommendations: > If at all possible, this should look like a valid Python expression that > could be used to recreate an object with the same value (given an appropriate > environment). If this is not possible, a string of the form > <...some useful description...> should be returned. > > -- https://docs.python.org/3/reference/datamodel.html#object.__repr__ Further, the `str` representation has been adjusted from for instance {'nodes_created': 42, 'labels_removed': 0, '_contains_system_updates': True} to SummaryCounters{nodes_created: 42, contains_updates: True, contains_system_updates: True} representing all non-default attributes/properties of the object. Co-authored-by: Max Gustafsson <61233757+MaxAake@users.noreply.github.com>

Author: robsdedude

CHANGELOG.md

@@ -193,7 +193,9 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
 - The driver incorrectly applied a timeout hint received from the server to both read and write I/O operations.
  It is now only applied to read I/O operations. 
  In turn, a new configuration option `connection_write_timeout` with a default value of `30 seconds` is introduced.
-- Adjust `repr` string representation of spatial types to conform with Python's recommendations.
+- Adjust string representation(s) of several types:
+ - `SummaryCounters`: `repr` and `str` to conform with Python's recommendations.
+ - `Point` and its subclasses: `repr` to conform with Python's recommendations.
 
 
 ## Version 5.28

src/neo4j/_work/summary.py

@@ -330,6 +330,28 @@ def status_precedence(status: GqlStatusObject) -> int:
  return self._gql_status_objects
 
 
+_COUNTER_KEY_TO_ATTR_NAME = {
+ "nodes-created": "nodes_created",
+ "nodes-deleted": "nodes_deleted",
+ "relationships-created": "relationships_created",
+ "relationships-deleted": "relationships_deleted",
+ "properties-set": "properties_set",
+ "labels-added": "labels_added",
+ "labels-removed": "labels_removed",
+ "indexes-added": "indexes_added",
+ "indexes-removed": "indexes_removed",
+ "constraints-added": "constraints_added",
+ "constraints-removed": "constraints_removed",
+ "system-updates": "system_updates",
+ "contains-updates": "_contains_updates",
+ "contains-system-updates": "_contains_system_updates",
+}
+
+_COUNTER_ATTR_NAME_TO_KEY = {
+ v: k for k, v in _COUNTER_KEY_TO_ATTR_NAME.items()
+}
+
+
 class SummaryCounters:
  """Contains counters for various operations that a query triggered."""
 
@@ -373,29 +395,33 @@ class SummaryCounters:
  _contains_system_updates = None
 
  def __init__(self, statistics) -> None:
- key_to_attr_name = {
- "nodes-created": "nodes_created",
- "nodes-deleted": "nodes_deleted",
- "relationships-created": "relationships_created",
- "relationships-deleted": "relationships_deleted",
- "properties-set": "properties_set",
- "labels-added": "labels_added",
- "labels-removed": "labels_removed",
- "indexes-added": "indexes_added",
- "indexes-removed": "indexes_removed",
- "constraints-added": "constraints_added",
- "constraints-removed": "constraints_removed",
- "system-updates": "system_updates",
- "contains-updates": "_contains_updates",
- "contains-system-updates": "_contains_system_updates",
- }
  for key, value in dict(statistics).items():
- attr_name = key_to_attr_name.get(key)
+ attr_name = _COUNTER_KEY_TO_ATTR_NAME.get(key)
  if attr_name:
  setattr(self, attr_name, value)
 
  def __repr__(self) -> str:
- return repr(vars(self))
+ statistics = {
+ _COUNTER_ATTR_NAME_TO_KEY[k]: v
+ for k, v in vars(self).items()
+ if k in _COUNTER_ATTR_NAME_TO_KEY
+ }
+ return f"{self.__class__.__name__}({statistics!r})"
+
+ def __str__(self) -> str:
+ attrs = []
+ for k, v in vars(self).items():
+ if k.startswith("_"): # hide private attributes
+ continue
+ if hasattr(self.__class__, k) and getattr(self.__class__, k) == v:
+ # hide default values
+ continue
+ attrs.append(f"{k}: {v}")
+ attrs.append(f"contains_updates: {self.contains_updates}")
+ attrs.append(
+ f"contains_system_updates: {self.contains_system_updates}"
+ )
+ return f"SummaryCounters{{{', '.join(attrs)}}}"
 
  @property
  def contains_updates(self) -> bool: