Python Analysis
This page documents the Python-related APIs in the CLDK library.
Use the table of contents to navigate classes, functions, and submodules exposed under the Python analysis and schema packages.
Analysis#
Python analysis utilities and workflows.
Python analysis utilities.
Provides a high-level API to query modules, classes, functions, and methods from Python projects or single-source inputs using Treesitter.
PythonAnalysis
#
Analysis façade for Python code.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_dir
|
str | Path | None
|
Directory path of the project. |
required |
source_code
|
str | None
|
Source text for single-file analysis. |
required |
Source code in cldk/analysis/python/python_analysis.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
|
get_methods()
#
Return all methods.
Returns:
Type | Description |
---|---|
List[PyMethod]
|
list[PyMethod]: Methods discovered in the source code. |
Examples:
>>> src = 'class C: def f(self): pass def g(self): pass'
>>> pa = PythonAnalysis(project_dir=None, source_code=src)
>>> len(pa.get_methods())
2
Source code in cldk/analysis/python/python_analysis.py
get_functions()
#
Return all functions.
Returns:
Type | Description |
---|---|
List[PyMethod]
|
list[PyMethod]: Functions discovered in the source code. |
Examples:
>>> src = 'def f(): return 1'
>>> pa = PythonAnalysis(project_dir=None, source_code=src)
>>> [m.full_signature for m in pa.get_functions()]
['f()']
Source code in cldk/analysis/python/python_analysis.py
get_modules()
#
Return all modules in the project directory.
Returns:
Type | Description |
---|---|
List[PyModule]
|
list[PyModule]: Modules discovered under project_dir. |
Examples:
Create a temporary project and discover modules:
>>> import os, tempfile
>>> d = tempfile.mkdtemp()
>>> _ = open(os.path.join(d, 'a.py'), 'w').write('print(1)')
>>> _ = open(os.path.join(d, 'b.py'), 'w').write('print(2)')
>>> pa = PythonAnalysis(project_dir=d, source_code=None)
>>> len(pa.get_modules()) >= 2
True
Source code in cldk/analysis/python/python_analysis.py
get_method_details(method_signature)
#
Return details for a given method signature.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
method_signature
|
str
|
Method signature to look up. |
required |
Returns:
Name | Type | Description |
---|---|---|
PyMethod |
PyMethod
|
Method details. |
Examples:
>>> src = 'class C: def add(self, a, b): return a+b'
>>> pa = PythonAnalysis(project_dir=None, source_code=src)
>>> pa.get_method_details('add(self, a, b)').full_signature
'add(self, a, b)'
Source code in cldk/analysis/python/python_analysis.py
is_parsable(source_code)
#
Check if the source code is parsable.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
source_code
|
str
|
Source code to parse. |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if parsable, False otherwise. |
Examples:
>>> PythonAnalysis(None, None).is_parsable('def f(): pass')
True
>>> PythonAnalysis(None, None).is_parsable('def f(): pass if')
False
Source code in cldk/analysis/python/python_analysis.py
get_raw_ast(source_code)
#
Parse and return the raw AST.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
source_code
|
str
|
Source code to parse. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Raw AST representation. |
Examples:
Source code in cldk/analysis/python/python_analysis.py
get_imports()
#
Return all import statements.
Returns:
Type | Description |
---|---|
List[PyImport]
|
list[PyImport]: Imports discovered in the source code. |
Examples:
>>> src = 'import os; from math import sqrt; from x import *'
>>> pa = PythonAnalysis(project_dir=None, source_code=src)
>>> len(pa.get_imports())
3
Source code in cldk/analysis/python/python_analysis.py
get_variables(**kwargs)
#
Return all variables discovered in the source code.
Raises:
Type | Description |
---|---|
NotImplementedError
|
This functionality is not implemented yet. |
Examples:
>>> pa = PythonAnalysis(project_dir=None, source_code='x=1')
>>> pa.get_variables()
Traceback (most recent call last):
NotImplementedError: Support for this functionality has not been implemented yet.
Source code in cldk/analysis/python/python_analysis.py
get_classes()
#
Return all classes.
Returns:
Type | Description |
---|---|
List[PyClass]
|
list[PyClass]: Classes discovered in the source code. |
Examples:
>>> src = 'class A: pass'
>>> pa = PythonAnalysis(project_dir=None, source_code=src)
>>> [c.class_name for c in pa.get_classes()]
['A']
Source code in cldk/analysis/python/python_analysis.py
get_classes_by_criteria(**kwargs)
#
Return classes filtered by inclusion/exclusion criteria.
Raises:
Type | Description |
---|---|
NotImplementedError
|
This functionality is not implemented yet. |
Examples:
>>> pa = PythonAnalysis(project_dir=None, source_code='class A: pass')
>>> pa.get_classes_by_criteria()
Traceback (most recent call last):
NotImplementedError: Support for this functionality has not been implemented yet.
Source code in cldk/analysis/python/python_analysis.py
get_sub_classes(**kwargs)
#
Return all subclasses.
Raises:
Type | Description |
---|---|
NotImplementedError
|
This functionality is not implemented yet. |
Examples:
>>> pa = PythonAnalysis(project_dir=None, source_code='class A: pass')
>>> pa.get_sub_classes()
Traceback (most recent call last):
NotImplementedError: Support for this functionality has not been implemented yet.
Source code in cldk/analysis/python/python_analysis.py
get_nested_classes(**kwargs)
#
Return all nested classes.
Raises:
Type | Description |
---|---|
NotImplementedError
|
This functionality is not implemented yet. |
Examples:
>>> pa = PythonAnalysis(project_dir=None, source_code='class A: class B: pass')
>>> pa.get_nested_classes()
Traceback (most recent call last):
NotImplementedError: Support for this functionality has not been implemented yet.
Source code in cldk/analysis/python/python_analysis.py
get_constructors(**kwargs)
#
Return all constructors.
Raises:
Type | Description |
---|---|
NotImplementedError
|
This functionality is not implemented yet. |
Examples:
>>> pa = PythonAnalysis(project_dir=None, source_code='class A: def __init__(self): pass')
>>> pa.get_constructors()
Traceback (most recent call last):
NotImplementedError: Support for this functionality has not been implemented yet.
Source code in cldk/analysis/python/python_analysis.py
get_methods_in_class(**kwargs)
#
Return all methods within a given class.
Raises:
Type | Description |
---|---|
NotImplementedError
|
This functionality is not implemented yet. |
Examples:
>>> pa = PythonAnalysis(project_dir=None, source_code='class A: def f(self): pass')
>>> pa.get_methods_in_class()
Traceback (most recent call last):
NotImplementedError: Support for this functionality has not been implemented yet.
Source code in cldk/analysis/python/python_analysis.py
get_fields(**kwargs)
#
Return all fields.
Raises:
Type | Description |
---|---|
NotImplementedError
|
This functionality is not implemented yet. |
Examples:
>>> pa = PythonAnalysis(project_dir=None, source_code='class A: x=1')
>>> pa.get_fields()
Traceback (most recent call last):
NotImplementedError: Support for this functionality has not been implemented yet.
Source code in cldk/analysis/python/python_analysis.py
Schema#
Data models used by the Python analyzers.
Models module