1.3.0 Added educational mode

Author: MattFor

CHANGELOG.md

@@ -1,15 +1,74 @@
 # Changelog
 
+## [1.3.0] - 2026-03-24
+
+### Added
+
+* **Educational logging mode (`mode="edu"`)**
+
+    * Human-readable, step-by-step output for learning and algorithm tracing
+    * Function calls rendered as:
+
+      ```
+      Calling foo(1, b=2)
+      ```
+    * Automatic argument formatting (args + kwargs)
+    * Omits empty kwargs
+
+* **Nested function call tracing**
+
+    * Logs calls inside functions (e.g. `outer.inner()`)
+
+* **Context-aware logging**
+
+    * `log()` inside decorated functions now inherits:
+
+        * `mode`
+        * `show_time`
+        * `show_file`
+        * `show_lineno`
+
+### Improved
+
+* **Output clarity in educational mode**
+
+    * Removed internal noise (`<func ...>`, debug artifacts)
+    * Simplified function names (no test/module prefixes)
+    * More natural mutation messages:
+
+      ```
+      Added 5 to arr -> [1, 2, 5]
+      ```
+
+### Fixed
+
+* Formatter crash (`UnboundLocalError: prefix`)
+* Incorrect call argument display (`{'args': ..., 'kwargs': ...}`)
+* Missing nested call events due to tracer scope issues
+
+### Tests
+
+* Added educational mode test coverage:
+
+    * Call formatting
+    * Argument rendering
+    * Nested function tracing
+    * Inherited logging behavior
+    * Human-readable mutations
+    * Output cleanliness
+
 ## [1.2.0] - 2026-03-23
 
 ### Added
+
 - `@log(level=...)` for verbosity control (`call`, `state`, `full`)
 - `@log(filter=[...])` to log only selected variables
 - Per-function file logging via `@log(filepath=...)`
 - Global file logging support
 - Decorator-only logging mode toggle
 
 ### Improved
+
 - Overall logging flexibility and usability
 - Reduced noise in complex traces
 
@@ -18,34 +77,39 @@
 ## [1.1.5] - 2026-03-23
 
 ### Changed
+
 - Updated README documentation
 
 ---
 
 ## [1.1.4] - 2026-03-23
 
 ### Fixed
+
 - Class wrapping issues
 
 ---
 
 ## [1.1.3] - 2026-03-23
 
 ### Fixed
+
 - Wrapped object representation
 
 ---
 
 ## [1.1.2] - 2026-03-23
 
 ### Fixed
+
 - Incorrect wrapping of callables
 
 ---
 
 ## [1.1.1] - 2026-03-23
 
 ### Fixed
+
 - Mutation tracking issues
 - Nested path logging bugs
 - Test failures
@@ -55,16 +119,19 @@
 ## [1.1.0] - 2026-03-23
 
 ### Added
+
 - Mutation logging support for tracked objects
 
 ### Improved
+
 - Core logging capabilities
 
 ---
 
 ## [1.0.0] - 2026-03-23
 
 ### Added
+
 - Initial release
 - Variable logging with name inference
 - Function tracing

README.md

@@ -1,4 +1,4 @@
-![PyPI](https://img.shields.io/pypi/v/logeye?cachebust=RANDOM)
+![PyPI](https://img.shields.io/pypi/v/logeye?cachebust=1774323493)
 ![Python](https://img.shields.io/pypi/pyversions/logeye)
 ![License](https://img.shields.io/github/license/MattFor/LogEye)
 
@@ -510,5 +510,5 @@ MIT License © 2026
 
 See [LICENSE](LICENSE) for details.
 
-Version 1.2.0
+Version 1.3.0
 

demo/demo_educational.py

@@ -0,0 +1,39 @@
+from logeye import log
+
+
+@log(mode="edu")
+def radix_sort_lsd(arr):
+	if not arr:
+		return arr
+
+	max_num = max(arr)
+	exp = 1  # 1, 10, 100...
+
+	while max_num // exp > 0:
+		buckets = [[] for _ in range(10)]
+
+		# Distribute into buckets
+		for num in arr:
+			digit = (num // exp) % 10
+			buckets[digit].append(num)
+
+		# Collect back
+		arr = []
+		for i, bucket in enumerate(buckets):
+			arr.extend(bucket)
+
+		# Wrapper options automatically passed here!!!!
+		log("After pass: $arr")
+
+		exp *= 10
+
+	return arr
+
+
+if __name__ == "__main__":
+	data = [170, 45, 75, 90, 802, 24, 2, 66]
+
+	sorted_data = radix_sort_lsd(data)
+
+	# Match pretty output
+	log("Sorted: $sorted_data", show_file=False, show_lineno=False)

logeye/__init__.py

@@ -4,7 +4,7 @@
 from .core import log, watch
 from .formatting import set_output_formatter, reset_output_formatter
 from .config import toggle_logs, toggle_decorator_log_only, toggle_message_metadata, toggle_global_log_file, \
-	set_path_mode, set_global_log_file
+	set_path_mode, set_global_log_file, _normalize_mode
 
 w = watch
 

logeye/config.py

@@ -12,6 +12,11 @@
 # Whether message logs include timestamp + file info
 _SHOW_MESSAGE_META = True
 _DECORATORS_ONLY = False
+_LOG_MODE = "full"  # "full" | "educational"
+
+_SHOW_TIME = True
+_SHOW_FILE = True
+_SHOW_LINENO = True
 
 _PROJECT_ROOT = os.getcwd()
 _LIBRARY_ROOT = os.path.dirname(__file__)
@@ -80,3 +85,17 @@ def set_path_mode(mode: str):
 		raise ValueError("mode must be: absolute, project, file")
 
 	_PATH_MODE = mode
+
+
+# =========
+#   OTHER
+# =========
+
+def _normalize_mode(mode: str) -> str:
+	if mode in ("edu", "educational"):
+		return "educational"
+
+	if mode == "full":
+		return "full"
+
+	raise ValueError("mode must be: full, edu, educational")