You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/reference/python-api/core.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,9 +140,9 @@ The full generated reference follows.
140
140
141
141
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
142
142
143
-
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.2.0/)
143
+
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.4.0/)
144
144
145
-
_API reference generated from cldk 1.2.0._
145
+
_API reference generated from cldk 1.4.0._
146
146
147
147
Core CLDK module.
148
148
@@ -155,8 +155,8 @@ parsers, and sanitization utilities.
155
155
> **The CLDK supports the following languages**
156
156
> -**Java**: Full static analysis via CodeAnalyzer backend, including symbol
157
157
> tables, call graphs, and code metrics.
158
-
> -**Python**: Static analysis via codeanalyzer-python backend with optional
159
-
> CodeQL-augmented callgraph resolution.
158
+
> -**Python**: Static analysis via codeanalyzer-python backend (Jedi plus
159
+
> PyCG call-graph construction).
160
160
> -**C**: Basic analysis via libclang for parsing and extracting code structure.
161
161
162
162
Typical usage involves instantiating `CLDK` with a target language, then
@@ -221,7 +221,7 @@ Create a Java analysis facade.
221
221
222
222
| Name | Type | Description |
223
223
| ---- | ---- | ----------- |
224
-
|`project_path`|`str \| Path \| None`| Path to the Java project directory. |
224
+
|`project_path`|`str \| Path \| None`| Path to the Java project directory. Optional only when ``backend`` is a `Neo4jConnectionConfig` (the graph is read out of band over Bolt). When provided, the path is validated, it must exist and be a directory, regardless of backend. |
|`analysis_level`|`str`| Analysis depth (see `AnalysisLevel`). |
227
227
|`target_files`|`List[str] \| None`| Restrict analysis to these files. |
@@ -244,7 +244,7 @@ Create a Python analysis facade.
244
244
245
245
| Name | Type | Description |
246
246
| ---- | ---- | ----------- |
247
-
|`project_path`|`str \| Path \| None`| Path to the Python project directory. Optional only when ``backend`` is a `Neo4jConnectionConfig` (the graph is populated out of band). |
247
+
|`project_path`|`str \| Path \| None`| Path to the Python project directory. Optional only when ``backend`` is a `Neo4jConnectionConfig` (the graph is populated out of band over Bolt). When provided, the path is validated, it must exist and be a directory, regardless of backend. |
248
248
|`analysis_level`|`str`| Analysis depth (see `AnalysisLevel`). |
249
249
|`target_files`|`List[str] \| None`| Restrict analysis to these files. |
250
250
|`eager`|`bool`| Force regeneration of cached analysis. |
@@ -262,11 +262,11 @@ Create a TypeScript analysis facade.
262
262
263
263
| Name | Type | Description |
264
264
| ---- | ---- | ----------- |
265
-
|`project_path`|`str \| Path \| None`| Path to the TypeScript project directory. Optional only when ``backend`` is a `Neo4jConnectionConfig` (the graph is populated out of band). |
265
+
|`project_path`|`str \| Path \| None`| Path to the TypeScript project directory. Optional only when ``backend`` is a `Neo4jConnectionConfig` (the graph is populated out of band over Bolt). When provided, the path is validated, it must exist and be a directory, regardless of backend. |
266
266
|`analysis_level`|`str`| Analysis depth (see `AnalysisLevel`). |
267
267
|`target_files`|`List[str] \| None`| Restrict analysis to these files. |
268
268
|`eager`|`bool`| Force regeneration of cached analysis. |
269
-
|`backend`|`TSBackend \| None`| Backend configuration. Defaults to `CodeAnalyzerConfig`; pass a `Neo4jConnectionConfig` to use the read-only Neo4j backend. |
269
+
|`backend`|`TSBackend \| None`| Backend configuration. Defaults to `CodeAnalyzerConfig`; pass a `TSCodeAnalyzerConfig` to set TypeScript-only knobs such as ``tsc_only`` (passes ``--tsc-only``), or a `Neo4jConnectionConfig` to use the read-only Neo4j backend. |
270
270
271
271
#### `CLDK.c`
272
272
@@ -279,7 +279,7 @@ Create a C analysis facade for the given project directory.
Copy file name to clipboardExpand all lines: src/content/docs/reference/python-api/java.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -106,9 +106,9 @@ follows.
106
106
107
107
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
108
108
109
-
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.2.0/)
109
+
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.4.0/)
Copy file name to clipboardExpand all lines: src/content/docs/reference/python-api/python.md
+122-9Lines changed: 122 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,9 +123,9 @@ follows.
123
123
124
124
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
125
125
126
-
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.2.0/)
126
+
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.4.0/)
127
127
128
-
_API reference generated from cldk 1.2.0._
128
+
_API reference generated from cldk 1.4.0._
129
129
130
130
## Analysis
131
131
@@ -140,8 +140,7 @@ The analysis is powered by the ``codeanalyzer-python`` backend, which uses a
140
140
combination of:
141
141
- **Jedi**: For semantic code understanding, symbol resolution, and basic
142
142
call graph construction.
143
-
- **CodeQL** (optional): For enhanced call graph resolution and more
144
-
accurate inter-procedural analysis.
143
+
- **PyCG**: For call-graph construction.
145
144
- **Tree-sitter**: For fast syntactic parsing and AST operations.
146
145
147
146
> **Key capabilities include**
@@ -416,16 +415,15 @@ from one callable to another.
416
415
417
416
> **The call graph is built using**
418
417
> - Jedi for semantic call resolution
419
-
> -CodeQL (if enabled) for enhanced inter-procedural analysis
418
+
> -PyCG for inter-procedural call-graph construction
420
419
421
420
**Returns:**
422
421
423
422
-`nx.DiGraph`: A ``networkx.DiGraph`` where: - Nodes represent callables (functions/methods) with attributes containing callable metadata - Edges represent call relationships, directed from caller to callee - Edge attributes may include call site information
424
423
425
424
> **Note**
426
-
> The completeness of the call graph depends on the analysis
427
-
> configuration. With ``use_codeql=True``, more call relationships
428
-
> are typically discovered at the cost of longer analysis time.
425
+
> The completeness of the call graph depends on the analysis backend
426
+
> (Jedi plus PyCG in codeanalyzer-python 0.3.0).
429
427
430
428
> **See Also**
431
429
> `get_callers`: For finding callers of a specific method.
@@ -559,6 +557,94 @@ dictionary structure by class name and then method name.
559
557
> `get_methods_in_class`: For methods of a specific class.
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
55
55
56
-
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.2.0/)
56
+
[](https://github.com/codellm-devkit/python-sdk)[](https://pypi.org/project/cldk/1.4.0/)
57
57
58
-
_API reference generated from cldk 1.2.0._
58
+
_API reference generated from cldk 1.4.0._
59
59
60
60
## Analysis
61
61
@@ -134,6 +134,16 @@ The phantom (external) call targets, imported/required library members the call
134
134
points at (e.g. ``node:fs.readFileSync``, ``js-yaml.load``). Useful for source→sink
0 commit comments