siren-debug 0.1.0__tar.gz

siren_debug-0.1.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: siren-debug
+Version: 0.1.0
+Summary: Minimalist debug tool for Python with automatic cleaner
+Author: Alexandra Bona Abreu
+License: MIT
+Requires-Python: >=2.7
+Description-Content-Type: text/markdown
+
+# Siren
+
+Minimalist debug tool for Python.
+
+Siren is a lightweight alternative to print / pprint, designed to work
+with any Python version, including Python 2.7, and any framework like Django,
+Flask, FastAPI, or pure Python.
+
+The main goal of Siren is simple:
+
+✔ Debug fast  
+✔ Remove debug lines automatically  
+✔ Work everywhere  
+✔ Zero dependencies  
+
+---
+
+## Features
+
+- Works in Python 2.7+
+- Works in Python 3+
+- No external dependencies
+- Uses print or pprint automatically
+- Shows file and line number
+- Can remove all debug calls automatically
+- Safe cleaner using tokenize
+- Works in Django / Flask / scripts / CLI
+
+---
+
+## Installation (local)
+
+Clone the repository:
+
+
+git clone https://github.com/youruser/siren.git
+
+
+Copy the `siren` folder into your project
+or add it to PYTHONPATH.
+
+Example:
+
+
+from siren import siren
+
+
+---
+
+## Usage
+
+
+from siren import siren
+
+x = 10
+data = {"a": 1, "b": [1, 2, 3]}
+
+siren(x)
+siren(data)
+
+
+Output:
+
+
+[SIREN file.py:10] 10
+[SIREN file.py:11] {'a': 1, 'b': [1, 2, 3]}
+
+
+Siren automatically uses pprint for complex objects.
+
+---
+
+## Multiple values
+
+
+siren(x, data, user)
+
+
+---
+
+## Cleaner (remove all siren calls)
+
+This is the main feature.
+
+Remove all lines that call `siren(...)`:
+
+
+python -m siren.clean .
+
+
+or
+
+
+python siren/clean.py .
+
+
+Example:
+
+Before:
+
+
+siren(x)
+print("hello")
+siren(data)
+
+
+After:
+
+
+print("hello")
+
+
+Cleaner is safe and uses Python tokenize.
+
+It will NOT remove comments or strings.
+
+---
+
+## Why Siren?
+
+Using print or pprint for debugging is easy,
+but removing them later is painful.
+
+Siren solves this.
+
+Use:
+
+
+siren(value)
+
+
+And later:
+
+
+clean all
+
+
+Done.
+
+---
+
+## Goals
+
+- Minimal
+- Safe
+- Cross-version
+- No dependencies
+- Easy cleanup
+- Works offline
+
+---
+
+## License
+
+MIT

siren_debug-0.1.0/README.md

@@ -0,0 +1,155 @@
+# Siren
+
+Minimalist debug tool for Python.
+
+Siren is a lightweight alternative to print / pprint, designed to work
+with any Python version, including Python 2.7, and any framework like Django,
+Flask, FastAPI, or pure Python.
+
+The main goal of Siren is simple:
+
+✔ Debug fast  
+✔ Remove debug lines automatically  
+✔ Work everywhere  
+✔ Zero dependencies  
+
+---
+
+## Features
+
+- Works in Python 2.7+
+- Works in Python 3+
+- No external dependencies
+- Uses print or pprint automatically
+- Shows file and line number
+- Can remove all debug calls automatically
+- Safe cleaner using tokenize
+- Works in Django / Flask / scripts / CLI
+
+---
+
+## Installation (local)
+
+Clone the repository:
+
+
+git clone https://github.com/youruser/siren.git
+
+
+Copy the `siren` folder into your project
+or add it to PYTHONPATH.
+
+Example:
+
+
+from siren import siren
+
+
+---
+
+## Usage
+
+
+from siren import siren
+
+x = 10
+data = {"a": 1, "b": [1, 2, 3]}
+
+siren(x)
+siren(data)
+
+
+Output:
+
+
+[SIREN file.py:10] 10
+[SIREN file.py:11] {'a': 1, 'b': [1, 2, 3]}
+
+
+Siren automatically uses pprint for complex objects.
+
+---
+
+## Multiple values
+
+
+siren(x, data, user)
+
+
+---
+
+## Cleaner (remove all siren calls)
+
+This is the main feature.
+
+Remove all lines that call `siren(...)`:
+
+
+python -m siren.clean .
+
+
+or
+
+
+python siren/clean.py .
+
+
+Example:
+
+Before:
+
+
+siren(x)
+print("hello")
+siren(data)
+
+
+After:
+
+
+print("hello")
+
+
+Cleaner is safe and uses Python tokenize.
+
+It will NOT remove comments or strings.
+
+---
+
+## Why Siren?
+
+Using print or pprint for debugging is easy,
+but removing them later is painful.
+
+Siren solves this.
+
+Use:
+
+
+siren(value)
+
+
+And later:
+
+
+clean all
+
+
+Done.
+
+---
+
+## Goals
+
+- Minimal
+- Safe
+- Cross-version
+- No dependencies
+- Easy cleanup
+- Works offline
+
+---
+
+## License
+
+MIT

siren_debug-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "siren-debug"
+version = "0.1.0"
+description = "Minimalist debug tool for Python with automatic cleaner"
+readme = "README.md"
+authors = [
+    { name = "Alexandra Bona Abreu" }
+]
+license = { text = "MIT" }
+requires-python = ">=2.7"
+
+dependencies = []
+
+[tool.setuptools.packages.find]
+where = ["."]

siren_debug-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

siren_debug-0.1.0/siren/__init__.py

@@ -0,0 +1,3 @@
+from .core import siren
+
+__all__ = ["siren"]

siren_debug-0.1.0/siren/clean.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+import os
+import sys
+import tokenize
+
+TOKEN_NAME = "siren"
+
+
+def line_calls_siren(line):
+    try:
+        tokens = list(tokenize.generate_tokens(lambda L=[line]: L.pop(0)))
+    except Exception:
+        return False
+
+    for i, tok in enumerate(tokens):
+        if tok.type == tokenize.NAME and tok.string == TOKEN_NAME:
+            # verificar se próximo token é "("
+            if i + 1 < len(tokens):
+                next_tok = tokens[i + 1]
+                if next_tok.string == "(":
+                    return True
+    return False
+
+
+def clean_file(path):
+    try:
+        with open(path, "r", encoding="utf-8") as f:
+            lines = f.readlines()
+    except TypeError:
+        with open(path, "r") as f:
+            lines = f.readlines()
+
+    new_lines = []
+    removed = 0
+
+    for line in lines:
+        if line_calls_siren(line):
+            removed += 1
+            continue
+        new_lines.append(line)
+
+    if removed:
+        try:
+            with open(path, "w", encoding="utf-8") as f:
+                f.writelines(new_lines)
+        except TypeError:
+            with open(path, "w") as f:
+                f.writelines(new_lines)
+
+    return removed
+
+
+def clean_directory(root):
+    total_removed = 0
+
+    for base, _, files in os.walk(root):
+        # ignorar venv automaticamente
+        if "venv" in base:
+            continue
+
+        for name in files:
+            if name.endswith(".py"):
+                path = os.path.join(base, name)
+                total_removed += clean_file(path)
+
+    return total_removed
+
+
+def main():
+    target = sys.argv[1] if len(sys.argv) > 1 else "."
+    removed = clean_directory(target)
+    print("SIREN CLEAN: {} linhas removidas".format(removed))
+
+
+if __name__ == "__main__":
+    main()

siren_debug-0.1.0/siren/core.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+import pprint
+import inspect
+
+
+def _is_simple(value):
+    return isinstance(value, (int, float, str, bool, type(None)))
+
+
+def siren(*values):
+    frame = inspect.currentframe().f_back
+    lineno = frame.f_lineno
+    filename = frame.f_code.co_filename
+
+    prefix = "[SIREN {}:{}]".format(filename, lineno)
+
+    for v in values:
+        print(prefix, end=" ")
+
+        if _is_simple(v):
+            print(v)
+        else:
+            pprint.pprint(v)
+
+    if len(values) == 1:
+        return values[0]
+
+    return values

siren_debug-0.1.0/siren_debug.egg-info/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: siren-debug
+Version: 0.1.0
+Summary: Minimalist debug tool for Python with automatic cleaner
+Author: Alexandra Bona Abreu
+License: MIT
+Requires-Python: >=2.7
+Description-Content-Type: text/markdown
+
+# Siren
+
+Minimalist debug tool for Python.
+
+Siren is a lightweight alternative to print / pprint, designed to work
+with any Python version, including Python 2.7, and any framework like Django,
+Flask, FastAPI, or pure Python.
+
+The main goal of Siren is simple:
+
+✔ Debug fast  
+✔ Remove debug lines automatically  
+✔ Work everywhere  
+✔ Zero dependencies  
+
+---
+
+## Features
+
+- Works in Python 2.7+
+- Works in Python 3+
+- No external dependencies
+- Uses print or pprint automatically
+- Shows file and line number
+- Can remove all debug calls automatically
+- Safe cleaner using tokenize
+- Works in Django / Flask / scripts / CLI
+
+---
+
+## Installation (local)
+
+Clone the repository:
+
+
+git clone https://github.com/youruser/siren.git
+
+
+Copy the `siren` folder into your project
+or add it to PYTHONPATH.
+
+Example:
+
+
+from siren import siren
+
+
+---
+
+## Usage
+
+
+from siren import siren
+
+x = 10
+data = {"a": 1, "b": [1, 2, 3]}
+
+siren(x)
+siren(data)
+
+
+Output:
+
+
+[SIREN file.py:10] 10
+[SIREN file.py:11] {'a': 1, 'b': [1, 2, 3]}
+
+
+Siren automatically uses pprint for complex objects.
+
+---
+
+## Multiple values
+
+
+siren(x, data, user)
+
+
+---
+
+## Cleaner (remove all siren calls)
+
+This is the main feature.
+
+Remove all lines that call `siren(...)`:
+
+
+python -m siren.clean .
+
+
+or
+
+
+python siren/clean.py .
+
+
+Example:
+
+Before:
+
+
+siren(x)
+print("hello")
+siren(data)
+
+
+After:
+
+
+print("hello")
+
+
+Cleaner is safe and uses Python tokenize.
+
+It will NOT remove comments or strings.
+
+---
+
+## Why Siren?
+
+Using print or pprint for debugging is easy,
+but removing them later is painful.
+
+Siren solves this.
+
+Use:
+
+
+siren(value)
+
+
+And later:
+
+
+clean all
+
+
+Done.
+
+---
+
+## Goals
+
+- Minimal
+- Safe
+- Cross-version
+- No dependencies
+- Easy cleanup
+- Works offline
+
+---
+
+## License
+
+MIT