nezu 0.3.0

Elegant debuging module

Nezu

Elegant debugging module

• Python code example

  # file.py
  from nezu import say
  x = 13
  say('x')  # print debuging info
  

• Bash commands to run

  export NEZU_SEEK = 1
  $ py file.py
      @4 l x:int  =>  13
  

How to install?

$ python -m pip install nezu

or

$ python -m poetry add nezu

How to use?

Basic usage

Inspect variable using say function. Pass name of variable you want to inspect as str argument.

• Note

  Output of say function is hidden by default. If you wannna see what nezu has to say you need to configure it first using nezu object. Simplest way is to call it with argument 1.

# file.py
from nezu import nezu, say
nezu(1)

say('egg')          # works on simple variables
say('ham.spam')     # works on attributes
say('spam["spam"]') # works on keys and indexes
say('print')        # works on functions and build-ins

How to interpret output?

@7      b  print:function  =>  Prints the values to a stream, or to sys...
 │      │  │     │             │
 │      │  │     │             └───────── Value of inspected variable
 │      │  │     │
 │      │  │     └─────────────── Type of inspected variable.
 │      │  │
 │      │  └───────────── Name of inspected variable.
 │      │
 │      └──────── Scope of inspected variable.
 │                l:local, g:global, b:build-in, u:undefined
 |
 └────── Line number of inspection.

Configuration

By default nezu is configured by env vars. This can be changed in code.

Env vars config

If you want to use default configuration method, change your env vars in terminal and than run your Python file.

• Bash

  export NEZU_SEEK = 1
  export NEZU_COLOR = 1
  export NEZU_LOCK = 0
  python3 file.py
  

• PowerShell

  $env:NEZU_SEEK = 1
  $env:NEZU_COLOR = $True
  $env:NEZU_LOCK = $True
  py file.py
  

JSON config

If you dont want to use env vars as configuration you can call nezu.json() to read configuration data from json file. It will search for key nezu inside chosen file.

• Params
  • path:str = 'nezu.json - path of configuration file
• Example config file

  "nezu" {
    "seek": 1,
    "color": true,
    "locked": false
  }
  

---

Hardcoded config

If you dont want to use env vars as configuration you can also call object nezu like function to make hardcoded config.

• Params

  • seek:int = 0 - debuging level
  • color:bool = False - output coloring
  • lock:bool = False - lock this config

• Example

  # file.py
  from nezu import nezu, say
  
  nezu(1, True, False)
  ...
  

• Tip

  There is no build in support for yaml, toml or .env in nezu This is so nezu can stay free of dependencies. However you can use hardcoded config to pass data from any config file.

Coloring output

By default nezu output is monochrome. If your terminal of choise support coloring you can change that.

Env vars coloring

• Example Bash command

  export NEZU_COLOR = 1
  python3 file.py
  

• Example PowerShell command

  $env:NEZU_COLOR = $True
  py file.py
  

JSON coloring

• Example config file

  "nezu" {
    "color": true,
  }
  

Hardcoded coloring

• Example

  from nezu import nezu, say
  
  nezu(color = True)
  ...
  

Hiding output

Function say() can be can be hidden into deeper levels of debugging via hide parameter. Execution argument --nezu seeks only for says hidden at level 1. Now if you want to display more, you run your program with --nezu-seek integer argument. In example bellow only says hidden up to level 3 are displayed.

#file.py
from nezu import say

say('egg', hide=1)
say('ham', hide=2)
say('spam', hide=3)
say('bacon', hide=4)
say('lobster', hide=5)

$ python file.py --nezu-seek=3
@4      u  egg
@5      u  ham
@6      u  spam

TO DO

• add class method support?
• add coloring
• add classes parameter (so you can print only group of logs)
• indicate shadowing
• write docstring for say
  • write test for multiline output
• write tests for name parser
• write tests for say
• automate testing with Github actions?
• automate deployment to PyPI with Github actions?
• publish to Conda
• test on different CPython versions
• test on Pypy
• test on Anaconda
• add badges
• format files with blue
• remove obsolete tests
• gitignore .vscode, __pycache, dist
• write proper documentation
  • How to interpret output
  • Configuration
  • Explain arguments
    • Hiding
    • Notes
    • args
  • Note args
  • brag in readme about being on pypy and and conda
• make a helper function, that returns dictionary (so it's easier to assert and doesn't require --nezu)
  • write function
  • write docstring for it
  • write tests for it
  • document it in README
• Write code of conduct
• Write/generate TOC
• Update README about configuration
• Write docstrings to configuration functions