parametrise log_method_calls decorator for excluding logging of properties, private methods, and dunders

Author: thomas6785

todoist_api_python/_core/utils.py

@@ -107,7 +107,9 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
-def log_method_calls(exclude_dunder: bool = True) -> Callable[[type], type]:
+def log_method_calls(
+    exclude_properties: bool = True, exclude_private: bool = True, exclude_dunder: bool = True
+) -> Callable[[type], type]:
     """
     Class decorator to log calls to all methods of a class. Arguments and returned values are
     included in the log.
@@ -121,6 +123,10 @@ def class_decorator(cls: type) -> type:
             if callable(attr_value):
                 if exclude_dunder and attr_name.startswith("__") and attr_name.endswith("__"):
                     continue
+                if exclude_private and attr_name.startswith("_"):
+                    continue
+                if exclude_properties and isinstance(getattr(cls, attr_name, None), property):
+                    continue
                 decorated_attr = log_calls(attr_value)
                 setattr(cls, attr_name, decorated_attr)
         return cls

todoist_api_python/api.py

@@ -85,7 +85,7 @@
 ViewStyle = Annotated[str, Predicate(lambda x: x in ("list", "board", "calendar"))]
 
 
-@log_method_calls(exclude_dunder=True)
+@log_method_calls()
 class TodoistAPI:
     """
     Client for the Todoist API.