Functions

            
                

                def text(issues: Iterable[Issue])
                 ‑> str
            
            
    
    
        
            open_in_new
        
    

        

Render issues as text.

Examples

Basic usage examples

>>> rule = Pattern(
...     id="bad-password-letmein",
...     message="Bad Password 'letmein'",
...     pattern="letmein",
...     severity="high",
... )
>>> issue = Issue(
...     rule=rule,
...     path="/path/to/code.py",
...     line="10",
...     secret="letmein",
...     context={
...         "9":  "username = 'admin'",
...         "10": "password = 'letmein'",
...         "11": "response = authorize(username, password)",
...     },
... )
>>> s = text([issue])

            
                

                def json(issues: Iterable[Issue])
                 ‑> str
            
            
    
    
        
            open_in_new
        
    

        

Render issues as JSON.

Examples

Basic usage examples

>>> rule = Pattern(
...     id="bad-password-letmein",
...     message="Bad Password 'letmein'",
...     pattern="letmein",
...     severity="high",
... )
>>> issue = Issue(
...     rule=rule,
...     path="/path/to/code.py",
...     line="10",
...     secret="letmein",
...     context={
...         "9":  "username = 'admin'",
...         "10": "password = 'letmein'",
...         "11": "response = authorize(username, password)",
...     },
... )
>>> s = json([issue])

            
                

                def html(issues: Iterable[Issue])
                 ‑> str
            
            
    
    
        
            open_in_new
        
    

        

Render issues as HTML.

Examples

Basic usage examples

>>> rule = Pattern(
...     id="bad-password-letmein",
...     message="Bad Password 'letmein'",
...     pattern="letmein",
...     severity="high",
... )
>>> issue = Issue(
...     rule=rule,
...     path="/path/to/code.py",
...     line="10",
...     secret="letmein",
...     context={
...         "9":  "username = 'admin'",
...         "10": "password = 'letmein'",
...         "11": "response = authorize(username, password)",
...     },
... )
>>> s = html([issue])