methodlogger 0.1.1

Log entry and exit of methods with a decorator

methodlogger

methodlogger is a lightweight Python decorator that logs the entry and exit of methods or functions. It is ideal for debugging, performance tracing, and audit logging in both standalone Python projects and frameworks like Odoo.

---

📦 Installation

pip install methodlogger

---

🚀 What Does It Do?

The @log_method decorator wraps any function or method and:

• Logs when it enters and exits.
• Supports custom log messages.
• Includes timestamp logging (optional).
• Uses Python’s logging module — works with any existing log setup.
• Fully configurable, and supports external integration (Odoo, JSON config, etc.)

---

✅ Features

• 🧩 Plug-and-play decorator
• 📃 Optional custom message per method
• ⏱ Show timestamps in logs
• ⚙️ Globally configurable via log_config
• 🧠 Clean integration with Odoo’s logging and startup config

---

🔧 Configuration (log_config)

The decorator reads configuration from a central dictionary:

from methodlogger import log_config

log_config["enabled"] = True                      # Enable/disable all logging
log_config["default_message"] = "Executing"       # Fallback message if none provided
log_config["log_level"] = "INFO"                  # Log level (INFO, DEBUG, etc.)
log_config["show_time"] = True                    # Show timestamps in log

---

💡 Use Cases

• Debugging production code

• Tracking performance

• Building audit logs

• Understanding 3rd-party library behavior

---

🧪 Basic Example

from methodlogger.decorators import log_method

@log_method("Processing say_hello()")
def say_hello():
    print("Hello!")

say_hello()

[2025-06-23 14:10:12] Entering: say_hello - Processing say_hello()
Hello!
[2025-06-23 14:10:12] Exiting : say_hello - Processing say_hello()

You can also use it with no arguments:

@log_method()
def compute():
    return 42