new version 2.5.0

Author: Andy Landy

.github/workflows/dev-test.yml

@@ -7,12 +7,15 @@ on:
     branches:
       - '*'
 jobs:
-  unit-tests:
+  tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: [3.8, 3.9]
+        # 3.13 not available yet somehow
+        # 3.7 has issues with multiline expressions
+        # 3.6- not found for ubuntu-latest
+        python-version: [3.8, 3.9, '3.10', 3.11, 3.12]
     steps:
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v1
@@ -22,7 +25,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install flake8 pytest-cov ipython
+          pip install flake8 pytest-cov ipython notebook==6.2.0
 
       - name: Checkout code
         uses: actions/checkout@v2
@@ -33,9 +36,24 @@ jobs:
 
       - name: Test with pytest
         run: |
-          python -m pytest -vv --cov=./traceback_with_variables --cov-report=xml
+          python -m pytest -vv --cov=traceback_with_variables --cov-report=json
 
-      - name: Upload Codecov
-        uses: codecov/codecov-action@v1
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
         with:
-          file: ./coverage.xml
+          name: coverage-${{ matrix.os }}-${{ matrix.python-version }}
+          path: coverage.json
+
+  coverage:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Download all coverage reports
+        uses: actions/download-artifact@v4
+        with:
+          path: coverage-reports
+
+      - name: Check coverage
+        run: python3 check_coverage_reports.py --inp-dir coverage-reports --max-allowed-num-uncovered-lines 0

.github/workflows/master-test.yml

@@ -0,0 +1,59 @@
+name: Dev-Tests
+on:
+  pull_request:
+    branches:
+      - 'master'
+  push:
+    branches:
+      - 'master'
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        # 3.13 not available yet somehow
+        # 3.7 has issues with multiline expressions
+        # 3.6- not found for ubuntu-latest
+        python-version: [3.8, 3.9, '3.10', 3.11, 3.12]
+    steps:
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest-cov ipython notebook==6.2.0
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Lint with flake8
+        run: |
+          flake8 traceback_with_variables --count --show-source --statistics --max-line-length=127
+
+      - name: Test with pytest
+        run: |
+          python -m pytest -vv --cov=traceback_with_variables --cov-report=json
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.os }}-${{ matrix.python-version }}
+          path: coverage.json
+
+  coverage:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Download all coverage reports
+        uses: actions/download-artifact@v4
+        with:
+          path: coverage-reports
+
+      - name: Check coverage
+        run: python3 check_coverage_reports.py --inp-dir coverage-reports --max-allowed-num-uncovered-lines 0

.github/workflows/test.yml

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.5.0
+- Add short names for frequently used things like `a` and `fmt`
+- Fixed some bugs
+
+## 2.0.4
+- ...
+
 ## 2.0.3
 - Fixed tests in Windows/Mac
 - Removed `sys` from globals in the "main" mode
@@ -11,18 +18,15 @@
 - Some renames
 - Add `Format` and pack all style arguments inside it
 - Add `before` and `after` instead of `num_context_lines`
-- Add `README.tmpl`
-- Add `print_tb()` to use out of try/except
 - Add `skip-files-except` and `brief-files-except`
 - Add warning on sensitive data
 - Add colab badge
-- Make a single `customized` example
+- Add a single `customized` example
 - Add `custom_var_printers`
 - Add past exceptions discovery
 - Add current tb printing
 - Rm outer try block in `core`
 - Add `format_*` functions to `core`
 - Rename `*_tb` functions to `*_exc`
 - Add `*_cur_tb*` methods
-- Add contributing md
 

.lgtm.yml

@@ -5,12 +5,12 @@
 
 <p align="center">
 <a href="https://github.com/andy-landy/traceback_with_variables/actions"><img alt="Actions Status" src="https://github.com/andy-landy/traceback_with_variables/workflows/Tests/badge.svg"></a>
-<a href="https://codecov.io/gh/andy-landy/traceback_with_variables"><img alt="Codecov" src="https://codecov.io/gh/andy-landy/traceback_with_variables/branch/master/graph/badge.svg"></a>
-<a href="https://lgtm.com/projects/g/andy-landy/traceback_with_variables/context:python"><img alt="Language grade: Python" src="https://img.shields.io/lgtm/grade/python/g/andy-landy/traceback_with_variables.svg"/></a>
+<a href="https://github.com/andy-landy/traceback_with_variables/blob/master/.github/workflows/dev-test.yml#L59"><img title="code tests coverage is 100%" alt="code tests coverage is 100%" src="https://img.shields.io/badge/coverage-100%25-brightgreen.svg"></a>
 <a href="https://github.com/andy-landy/traceback_with_variables/tree/master/LICENSE"><img alt="License: MIT" src="https://img.shields.io/github/license/andy-landy/traceback_with_variables?color=informational"></a>
+<a href="https://pepy.tech/project/traceback-with-variables"><img alt="Downloads" src="https://static.pepy.tech/badge/traceback-with-variables"></a>
 <a href="https://pypi.org/project/traceback-with-variables"><img alt="PyPI" src="https://img.shields.io/pypi/v/traceback-with-variables"></a>
 <a href="https://anaconda.org/conda-forge/traceback-with-variables"><img src="https://img.shields.io/conda/vn/conda-forge/traceback-with-variables"></a>
-<a href="https://pypi.org/project/traceback-with-variables"><img alt="PyPI" src="https://img.shields.io/badge/python-3.5+-blue.svg"></a>
+<a href="https://pypi.org/project/traceback-with-variables"><img alt="PyPI" src="https://img.shields.io/badge/python-3.6+-blue.svg"></a>
 <a href="https://superuser.com/questions/413073/windows-console-with-ansi-colors-handling"><img title="windows, mac, linux etc." alt="Platform" src="https://img.shields.io/badge/platform-all-blue.svg"></a>
 <a href="https://github.com/andy-landy/traceback_with_variables/tree/master/traceback_with_variables/override.py#L9"><img title="type hints everywhere" alt="Annotations coverage" src="https://img.shields.io/badge/type--hints-100%25-blueviolet.svg"></a>
 <a href="https://github.com/andy-landy/traceback_with_variables/tree/master/traceback_with_variables/override.py#L8"><img title="no obscure objects, only transparent functions and data classes" alt="No-OOP" src="https://img.shields.io/badge/no OOP-100%25-blueviolet.svg"></a>
@@ -40,17 +40,17 @@ _Contents:_ **[Installation](#installation)** | **[🚀 Quick Start](#-quick-sta
 
 ---
 
-> :warning: **I'm open to update this module to meet new use cases and to make using it easier and fun**: so any proposal or advice or warning is very welcome and will be taken into account of course. When I started it I wanted to make a tool meeting all standard use cases. I think in this particular domain this is rather achievable, so I'll try. Note `next_version` branch also. Have fun!
+> :warning: **This module is actively updated and has a substantial list of features to add this week**: so any proposal or advice or warning is very welcome and will be taken into account of course. When I started it I wanted to make a tool meeting all standard use cases. I think in this particular domain this is rather achievable, so I'll try. Note `next_version` branch also. Have fun!
 
 ---
 
 ### Installation
 
 ```
-pip install traceback-with-variables==2.0.4
+pip install traceback-with-variables==2.1.0
 ```
 ```
-conda install -c conda-forge traceback-with-variables=2.0.4
+conda install -c conda-forge traceback-with-variables=2.1.0
 ```
 
 ### 🚀 Quick Start
@@ -106,8 +106,8 @@ Using a logger [<a href="https://github.com/andy-landy/traceback_with_variables/
 
 <a href="https://github.com/andy-landy/traceback_with_variables/tree/master/examples/format_customized.py">Customize</a> any of the previous examples:
 ```python
-    default_format.max_value_str_len = 10000
-    default_format.skip_files_except = 'my_project'
+    fmt.max_value_str_len = 10000
+    fmt.skip_files_except = 'my_project'
 ```
 
 
@@ -245,8 +245,7 @@ Using a logger [<a href="https://github.com/andy-landy/traceback_with_variables/
 * — Should I use it after debugging is over, i.e. *in production*?
 
     Yes, of course! That way it might save you even more time (watch out for sensitive data
-    like passwords and tokens in you logs). Note: you can deploy more serious frameworks,
-    e.g. `Sentry` :)
+    like passwords and tokens in you logs, use skip_files_except to hide code from libs AND custom_var_printers to hide own locals). Note: you can deploy more serious frameworks, e.g. `Sentry`
 
 <br/>
 
@@ -282,6 +281,8 @@ Using a logger [<a href="https://github.com/andy-landy/traceback_with_variables/
 
 #### All functions have `fmt=` argument, a `Format` object with fields:
 * `max_value_str_len` max length of each variable string, -1 to disable, default=1000
+* `objects_details` depth of details of objects inspection
+* `ellipsis_rel_pos` when truncating long strings where to put the "...", from 0.0 to 1.0, default=0.7
 * `max_exc_str_len` max length of exception, should variable print fail, -1 to disable, default=10000
 * `before` number of code lines before the raising line, default=0
 * `after` number of code lines after the raising line, default=0

CHANGELOG.md

@@ -5,12 +5,12 @@
 
 <p align="center">
 <a href="{{ repo_url }}/actions"><img alt="Actions Status" src="{{ repo_url }}/workflows/Tests/badge.svg"></a>
-<a href="https://codecov.io/gh/{{ user_repo_name }}"><img alt="Codecov" src="https://codecov.io/gh/{{ user_repo_name }}/branch/master/graph/badge.svg"></a>
-<a href="https://lgtm.com/projects/g/{{ user_repo_name }}/context:python"><img alt="Language grade: Python" src="https://img.shields.io/lgtm/grade/python/g/{{ user_repo_name }}.svg"/></a>
+<a href="{{ repo_url }}/blob/master/.github/workflows/dev-test.yml#L59"><img title="code tests coverage is 100%" alt="code tests coverage is 100%" src="https://img.shields.io/badge/coverage-100%25-brightgreen.svg"></a>
 <a href="{{ code_url }}/LICENSE"><img alt="License: MIT" src="https://img.shields.io/github/license/{{ user_repo_name }}?color=informational"></a>
+<a href="https://pepy.tech/project/traceback-with-variables"><img alt="Downloads" src="https://static.pepy.tech/badge/traceback-with-variables"></a>
 <a href="{{ pypi_url }}"><img alt="PyPI" src="https://img.shields.io/pypi/v/{{ package_name }}"></a>
 <a href="https://anaconda.org/conda-forge/{{ package_name }}"><img src="https://img.shields.io/conda/vn/conda-forge/{{ package_name }}"></a>
-<a href="{{ pypi_url }}"><img alt="PyPI" src="https://img.shields.io/badge/python-3.5+-blue.svg"></a>
+<a href="{{ pypi_url }}"><img alt="PyPI" src="https://img.shields.io/badge/python-3.6+-blue.svg"></a>
 <a href="https://superuser.com/questions/413073/windows-console-with-ansi-colors-handling"><img title="windows, mac, linux etc." alt="Platform" src="https://img.shields.io/badge/platform-all-blue.svg"></a>
 <a href="{{ lib_code_url }}/override.py#L9"><img title="type hints everywhere" alt="Annotations coverage" src="https://img.shields.io/badge/type--hints-100%25-blueviolet.svg"></a>
 <a href="{{ lib_code_url }}/override.py#L8"><img title="no obscure objects, only transparent functions and data classes" alt="No-OOP" src="https://img.shields.io/badge/no OOP-100%25-blueviolet.svg"></a>
@@ -106,8 +106,8 @@ Using a logger [<a href="{{ examples_code_url }}/log_for_function.py">with a dec
 
 <a href="{{ examples_code_url }}/format_customized.py">Customize</a> any of the previous examples:
 ```python
-    default_format.max_value_str_len = 10000
-    default_format.skip_files_except = 'my_project'
+    fmt.max_value_str_len = 10000
+    fmt.skip_files_except = 'my_project'
 ```
 
 
@@ -245,8 +245,7 @@ Using a logger [<a href="{{ examples_code_url }}/log_for_function.py">with a dec
 * — Should I use it after debugging is over, i.e. *in production*?
 
     Yes, of course! That way it might save you even more time (watch out for sensitive data
-    like passwords and tokens in you logs). Note: you can deploy more serious frameworks,
-    e.g. `Sentry` :)
+    like passwords and tokens in you logs, use skip_files_except to hide code from libs AND custom_var_printers to hide own locals). Note: you can deploy more serious frameworks, e.g. `Sentry`
 
 <br/>
 
@@ -282,6 +281,8 @@ Using a logger [<a href="{{ examples_code_url }}/log_for_function.py">with a dec
 
 #### All functions have `fmt=` argument, a `Format` object with fields:
 * `max_value_str_len` max length of each variable string, -1 to disable, default=1000
+* `objects_details` depth of details of objects inspection
+* `ellipsis_rel_pos` when truncating long strings where to put the "...", from 0.0 to 1.0, default=0.7
 * `max_exc_str_len` max length of exception, should variable print fail, -1 to disable, default=10000
 * `before` number of code lines before the raising line, default=0
 * `after` number of code lines after the raising line, default=0

README.md

@@ -0,0 +1,51 @@
+import argparse
+import json
+import sys
+from collections import defaultdict
+from pathlib import Path
+from typing import List
+
+
+def check_coverage_reports(inp_dir: Path, max_allowed_num_uncovered_lines: int) -> None:
+    file_to_line_to_was_hit: Dict[str, Dict[int, bool]] = defaultdict(dict)
+
+    for report_path in inp_dir.rglob('*.json'):
+        with report_path.open('r') as inp:
+            for file_, data in json.load(inp)['files'].items():
+                line_to_was_hit = file_to_line_to_was_hit[file_.replace('\\', '/')]
+                for line in data['executed_lines']:
+                    line_to_was_hit[line] = True
+                for line in data['missing_lines']:
+                    line_to_was_hit.setdefault(line, False)
+        
+    num_uncovered_lines = 0
+    for file_, line_to_was_hit in file_to_line_to_was_hit.items():
+        for line, was_hit in line_to_was_hit.items():
+            if not was_hit:
+                sys.stderr.write(f'miss at {file_}:{line}\n')
+                num_uncovered_lines += 1
+
+    if num_uncovered_lines > max_allowed_num_uncovered_lines:
+        raise ValueError('check failed')
+
+
+def parse_args():
+    p = argparse.ArgumentParser()
+    p.add_argument('--inp-dir', required=True, type=Path)
+    p.add_argument('--max-allowed-num-uncovered-lines', required=True, type=int)
+
+    return p.parse_args()
+
+
+def main():
+    args = parse_args()
+
+    check_coverage_reports(
+        inp_dir=args.inp_dir,
+        max_allowed_num_uncovered_lines=args.max_allowed_num_uncovered_lines
+    )
+
+
+if __name__ == '__main__':
+    main()
+

README.tmpl

@@ -1,9 +1,9 @@
-from traceback_with_variables import Format, ColorSchemes, is_ipython_global, default_format as defaults
+from traceback_with_variables import Format, ColorSchemes, is_ipython_global, fmt
 
 
 # approach 1
 
-defaults.max_value_str_len = 10000
+fmt.max_value_str_len = 10000
 
 
 # approach 2
@@ -12,6 +12,8 @@
     before=3,
     after=1,
     max_value_str_len=10000,
+    objects_details=0,
+    ellipsis_rel_pos=0.7
     max_exc_str_len=1000,
     ellipsis_='...',
     color_scheme=ColorSchemes.synthwave,

check_coverage_reports.py

@@ -1,7 +1,9 @@
-from traceback_with_variables import activate_by_import  # , defaut_format
+from traceback_with_variables import a  # , fmt
+# or
+from traceback_with_variables import activate_by_import  # , fmt
 
 
-# default_format.max_value_str_len = 10000
+# fmt.max_value_str_len = 10000
 
 def main():
     n = 0