Skip to content

FilePath

Source code in docs_src/capo_codeguru_security/types/file_path.py 
11
12
13
14
15
16
17
18
19
20
21
class FilePath(TypedDict, closed=True):
    name: NotRequired["str"]
    """<p>The name of the file.</p>"""
    path: NotRequired["str"]
    """<p>The path to the resource with the security vulnerability.</p>"""
    start_line: NotRequired["int"]
    """<p>The first line number of the code snippet where the security vulnerability appears in your code.</p>"""
    end_line: NotRequired["int"]
    """<p>The last line number of the code snippet where the security vulnerability appears in your code.</p>"""
    code_snippet: NotRequired["capo_codeguru_security.types.code_snippet.CodeSnippet"]
    """<p>A list of <code>CodeLine</code> objects that describe where the security vulnerability appears in your code.</p>"""

code_snippet instance-attribute 

code_snippet: NotRequired[CodeSnippet]

A list of CodeLine objects that describe where the security vulnerability appears in your code.

end_line instance-attribute 

end_line: NotRequired[int]

The last line number of the code snippet where the security vulnerability appears in your code.

name instance-attribute 

name: NotRequired[str]

The name of the file.

path instance-attribute 

path: NotRequired[str]

The path to the resource with the security vulnerability.

start_line instance-attribute 

start_line: NotRequired[int]

The first line number of the code snippet where the security vulnerability appears in your code.