metrun 0.1.1__tar.gz

metrun-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

metrun-0.1.1/PKG-INFO

@@ -0,0 +1,338 @@
+Metadata-Version: 2.4
+Name: metrun
+Version: 0.1.1
+Summary: Execution Intelligence Tool — Bottleneck Engine + Human Report Generator
+License-Expression: Apache-2.0
+Keywords: profiling,performance,bottleneck,tracing,flamegraph
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=7.0
+Requires-Dist: goal>=2.1.0
+Requires-Dist: costs>=0.1.20
+Requires-Dist: pfix>=0.1.60
+Provides-Extra: flamegraph
+Requires-Dist: flameprof>=0.4; extra == "flamegraph"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: flameprof>=0.4; extra == "dev"
+Requires-Dist: goal>=2.1.0; extra == "dev"
+Requires-Dist: costs>=0.1.20; extra == "dev"
+Requires-Dist: pfix>=0.1.60; extra == "dev"
+Dynamic: license-file
+
+# metrun — Execution Intelligence Tool
+
+## AI Cost Tracking
+
+![AI Cost](https://img.shields.io/badge/AI%20Cost-$0.75-brightgreen) ![AI Model](https://img.shields.io/badge/AI%20Model-openrouter%2Fqwen%2Fqwen3-coder-next-lightgrey)
+
+This project uses AI-generated code. Total cost: **$0.7500** with **5** AI commits.
+
+Generated on 2026-04-06 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/models/openrouter/qwen/qwen3-coder-next)
+
+---
+
+> **metrun** doesn't just show you data — it tells you *what the problem is and how to fix it.*
+
+## What is metrun?
+
+`metrun` is a Python performance analysis library that turns raw profiling data into an **intelligible execution report**: bottleneck scores, dependency graphs, critical path highlighting, and actionable fix suggestions — all in one tool.
+
+```
+❌ traditional profilers → "here is your data"
+✅ metrun               → "here is your problem and why it exists"
+```
+
+---
+
+## Features
+
+| Feature | Description |
+|---|---|
+| 🧠 **Bottleneck Engine** | Builds an execution graph, computes `score = time + calls + nested amplification`, ranks hotspots |
+| 📊 **Human Report Generator** | Emoji-annotated report with time %, call count, score and diagnosis per function |
+| 🧨 **Critical Path** | Finds the hottest nested call chain root → leaf |
+| 💡 **Fix Suggestion Engine** | Library-specific advice per diagnosis: `lru_cache`, `asyncio`, `numba`, `viztracer`, `scalene` … |
+| 🔥 **ASCII Flamegraph** | Terminal-friendly proportional bar chart, zero extra dependencies |
+| 🖼️ **SVG Flamegraph** | Interactive SVG via [`flameprof`](https://pypi.org/project/flameprof/) |
+| 🔌 **cProfile Bridge** | Use stdlib `cProfile` as the profiling backend; feed results into the Bottleneck Engine |
+| ⌨️ **CLI** | `metrun profile`, `metrun inspect`, `metrun flame` commands |
+
+---
+
+## Installation
+
+```bash
+pip install metrun            # core (click included)
+pip install metrun[flamegraph] # + SVG flamegraph support (flameprof)
+```
+
+---
+
+## Quick Start
+
+### Decorator tracing
+
+```python
+from metrun import trace, get_records, analyse, print_report
+
+@trace
+def slow_query(n):
+    return sum(i * i for i in range(n))
+
+@trace
+def handler(items):
+    return [slow_query(i) for i in items]
+
+handler(list(range(100)))
+
+bottlenecks = analyse(get_records())
+print_report(bottlenecks)
+```
+
+### Context-manager tracing
+
+```python
+from metrun import section, get_records, analyse, print_report
+
+with section("data_load"):
+    data = load_from_db()
+
+with section("transform"):
+    result = process(data)
+
+print_report(analyse(get_records()))
+```
+
+### Full enhanced report
+
+```python
+from metrun import analyse, get_records, print_report
+
+records = get_records()
+bottlenecks = analyse(records)
+
+print_report(
+    bottlenecks,
+    show_graph=True,           # dependency graph
+    show_critical_path=True,   # hottest call chain
+    records=records,
+    show_suggestions=True,     # fix advice
+)
+```
+
+---
+
+## Example output
+
+```
+🔥 METRUN PERFORMANCE REPORT
+=============================
+
+🔴 slow_query
+   → time:      0.8200s  (78.2%)
+   → calls:     12,430
+   → score:     12.9
+   → diagnosis: 🔥 loop hotspot
+
+── Critical Path ─────────────────────────────
+🧨 Critical Path  (depth=2, hottest leaf: 0.8200s)
+
+  handler  [1.0500s, 1 calls]
+    └─ slow_query  [0.8200s, 12430 calls]   ← 🔥 hottest leaf (0.8200s)
+
+── Fix Suggestions ───────────────────────────
+  💡 Fix suggestions for: slow_query
+     1. Cache repeated results with lru_cache [functools]
+           from functools import lru_cache
+
+           @lru_cache(maxsize=None)
+           def slow_query(x): ...
+
+     2. Vectorise the loop with NumPy [numpy]
+           import numpy as np
+           result = np.sum(arr ** 2)
+```
+
+---
+
+## Auto-diagnosis labels
+
+| Label | Trigger |
+|---|---|
+| 🔥 `loop hotspot` | `calls ≥ 1 000` |
+| 🌲 `dependency bottleneck` | `≥ 3 direct children` in the execution graph |
+| 🐢 `slow execution` | `≥ 30 %` of total wall time, low calls |
+| ✅ `nominal` | below all thresholds |
+
+---
+
+## ASCII Flamegraph
+
+```python
+from metrun import render_ascii, print_ascii
+
+print_ascii(bottlenecks, title="My App Flamegraph")
+```
+
+```
+🔥 My App Flamegraph
+────────────────────────────────────────────────────────
+  slow_query    ████████████████████████████████████████  78.2%  score=12.9
+  handler       █████████████████████████████████████████ 100.0%  score=9.4
+  serialize     ██░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░   5.1%  score=2.1
+────────────────────────────────────────────────────────
+```
+
+---
+
+## SVG Flamegraph (via `flameprof`)
+
+```python
+from metrun.cprofile_bridge import CProfileBridge
+from metrun import render_svg
+
+bridge = CProfileBridge()
+with bridge.profile_block():
+    my_function()
+
+render_svg(bridge.get_stats(), "flame.svg")
+# Open flame.svg in a browser for the interactive flamegraph
+```
+
+---
+
+## cProfile Bridge
+
+Integrate with stdlib `cProfile` or any existing `.prof` dump:
+
+```python
+from metrun.cprofile_bridge import CProfileBridge
+from metrun import analyse, print_report
+
+bridge = CProfileBridge()
+
+@bridge.profile_func
+def my_function():
+    ...
+
+my_function()
+
+# Analyse with the Bottleneck Engine
+bottlenecks = analyse(bridge.to_records())
+print_report(bottlenecks)
+
+# Save for snakeviz / flameprof CLI
+bridge.save("profile.prof")
+```
+
+Compatible with these popular tools (no code changes needed):
+
+| Tool | Command |
+|---|---|
+| **snakeviz** — interactive web viewer | `snakeviz profile.prof` |
+| **flameprof** — SVG flamegraph | `flameprof profile.prof > flame.svg` |
+| **py-spy** — sampling profiler | `py-spy record -o flame.svg -- python script.py` |
+| **viztracer** — full trace + HTML flamegraph | see below |
+| **scalene** — line-level CPU+memory | `python -m scalene script.py` |
+
+---
+
+## VizTracer integration
+
+```python
+# pip install viztracer
+from viztracer import VizTracer
+
+with VizTracer(output_file="trace.json"):
+    my_function()
+
+# vizviewer trace.json  →  opens interactive HTML flamegraph
+```
+
+---
+
+## Critical Path
+
+```python
+from metrun import find_critical_path, print_critical_path, get_records
+
+path = find_critical_path(get_records())
+print_critical_path(path)
+```
+
+```
+🧨 Critical Path  (depth=3, hottest leaf: 0.4200s)
+
+  handler  [0.9100s, 1 calls]
+    └─ db_query  [0.6300s, 50 calls]
+      └─ serialize  [0.4200s, 50 calls]   ← 🔥 hottest leaf (0.4200s)
+```
+
+---
+
+## Fix Suggestion Engine
+
+```python
+from metrun import analyse, get_records, suggest, format_suggestions
+
+for b in analyse(get_records()):
+    tips = suggest(b)
+    print(format_suggestions(b.name, tips))
+```
+
+Suggestion catalogue per diagnosis:
+
+| Diagnosis | Suggestions |
+|---|---|
+| 🔥 loop hotspot | `functools.lru_cache`, `numpy` vectorisation, `numba @jit` |
+| 🌲 dependency bottleneck | `concurrent.futures`, `asyncio.gather`, batching |
+| 🐢 slow execution | `cProfile + snakeviz`, algorithmic review, `joblib.Memory` |
+| Score ≥ 8 (any) | `scalene`, `viztracer` |
+
+---
+
+## CLI
+
+```bash
+# Profile a script — bottleneck report
+metrun profile my_script.py
+
+# Profile + ASCII flamegraph in terminal
+metrun profile my_script.py --ascii-flame
+
+# Profile + save SVG flamegraph
+metrun profile my_script.py --flame flame.svg
+
+# Full enhanced report: bottlenecks + critical path + suggestions
+metrun inspect my_script.py
+
+# Convert existing .prof dump to SVG
+metrun flame profile.prof -o flame.svg
+```
+
+---
+
+## Module overview
+
+```
+metrun/
+├── profiler.py        # ExecutionTracer — decorator + context-manager tracing
+├── bottleneck.py      # BottleneckEngine — score, diagnosis, ranking
+├── report.py          # Human Report Generator
+├── critical_path.py   # Critical path analysis
+├── suggestions.py     # Fix Suggestion Engine
+├── flamegraph.py      # ASCII + SVG (flameprof) flamegraphs
+├── cprofile_bridge.py # cProfile ↔ metrun bridge
+└── cli.py             # Click CLI entry-point
+```
+
+
+## License
+
+Licensed under Apache-2.0.