Skip to content

Commit 22b4a65

Browse files
rahlkgithub-actions[bot]
authored andcommitted
docs(api): sync Python API reference to python-sdk 1.4.3
1 parent 9d4d156 commit 22b4a65

4 files changed

Lines changed: 32 additions & 22 deletions

File tree

src/content/docs/reference/python-api/core.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,9 @@ The full generated reference follows.
140140

141141
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
142142

143-
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.0](https://img.shields.io/badge/cldk-1.4.0-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.0/)
143+
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.3](https://img.shields.io/badge/cldk-1.4.3-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.3/)
144144

145-
_API reference generated from cldk 1.4.0._
145+
_API reference generated from cldk 1.4.3._
146146

147147
Core CLDK module.
148148

src/content/docs/reference/python-api/java.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ follows.
106106

107107
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
108108

109-
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.0](https://img.shields.io/badge/cldk-1.4.0-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.0/)
109+
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.3](https://img.shields.io/badge/cldk-1.4.3-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.3/)
110110

111-
_API reference generated from cldk 1.4.0._
111+
_API reference generated from cldk 1.4.3._
112112

113113
## Analysis
114114

@@ -647,7 +647,7 @@ any inclusion substring AND does not contain any exclusion substring.
647647
##### `JavaAnalysis.get_class`
648648

649649
```python
650-
get_class(qualified_class_name: str) -> JType
650+
get_class(qualified_class_name: str) -> JType | None
651651
```
652652

653653
Return a specific class by its qualified name.
@@ -663,9 +663,9 @@ methods, fields, annotations, modifiers, and inheritance information.
663663

664664
**Returns:**
665665

666-
- `JType`: class:`~cldk.models.java.JType` object containing all analyzed
667-
- `JType`: information about the class. Returns ``None`` if the class is not
668-
- `JType`: found in the analyzed project.
666+
- `JType \| None`: class:`~cldk.models.java.JType` object containing all analyzed
667+
- `JType \| None`: information about the class. Returns ``None`` if the class is not
668+
- `JType \| None`: found in the analyzed project.
669669

670670
> **See Also**
671671
> `get_classes`: For all classes in the project.
@@ -674,7 +674,7 @@ methods, fields, annotations, modifiers, and inheritance information.
674674
##### `JavaAnalysis.get_method`
675675

676676
```python
677-
get_method(qualified_class_name: str, qualified_method_name: str) -> JCallable
677+
get_method(qualified_class_name: str, qualified_method_name: str) -> JCallable | None
678678
```
679679

680680
Return a specific method by class and method signature.
@@ -691,9 +691,9 @@ signature, parameters, return type, annotations, body, and metrics.
691691

692692
**Returns:**
693693

694-
- `JCallable`: class:`~cldk.models.java.JCallable` object containing all
695-
- `JCallable`: analyzed information about the method. Returns ``None`` if the
696-
- `JCallable`: method is not found.
694+
- `JCallable \| None`: class:`~cldk.models.java.JCallable` object containing all
695+
- `JCallable \| None`: analyzed information about the method. Returns ``None`` if the
696+
- `JCallable \| None`: method is not found.
697697

698698
> **See Also**
699699
> `get_methods_in_class`: For all methods of a class.
@@ -729,7 +729,7 @@ signature.
729729
##### `JavaAnalysis.get_java_file`
730730

731731
```python
732-
get_java_file(qualified_class_name: str) -> str
732+
get_java_file(qualified_class_name: str) -> str | None
733733
```
734734

735735
Return the file path containing a class with the given name.
@@ -746,8 +746,8 @@ to source files.
746746

747747
**Returns:**
748748

749-
- `str`: The file path (as a string) containing the class definition.
750-
- `str`: Returns ``None`` if no class with the given name is found.
749+
- `str \| None`: The file path (as a string) containing the class definition.
750+
- `str \| None`: Returns ``None`` if no class with the given name is found.
751751

752752
> **See Also**
753753
> `get_class`: To get the full class object by name.

src/content/docs/reference/python-api/python.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,9 @@ follows.
123123

124124
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
125125

126-
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.0](https://img.shields.io/badge/cldk-1.4.0-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.0/)
126+
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.3](https://img.shields.io/badge/cldk-1.4.3-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.3/)
127127

128-
_API reference generated from cldk 1.4.0._
128+
_API reference generated from cldk 1.4.3._
129129

130130
## Analysis
131131

@@ -679,23 +679,28 @@ methods (like ``__init__``, ``__str__``, etc.).
679679
get_method(qualified_class_name: str, qualified_method_name: str) -> PyCallable | None
680680
```
681681

682-
Return a specific method by class and method name.
682+
Return a specific method or module-level function by scope and name.
683683

684684
Retrieves detailed information about a single method, including
685685
its signature, parameters, return type, decorators, and body.
686686

687+
``qualified_class_name`` is looked up the same way as
688+
`get_all_methods_in_application`'s outer keys: a class signature resolves to that
689+
class's methods, and a module name (``PyModule.module_name``) resolves to that module's
690+
top-level functions.
691+
687692
**Parameters:**
688693

689694
| Name | Type | Description |
690695
| ---- | ---- | ----------- |
691-
| `qualified_class_name` | `str` | The fully qualified name of the class containing the method (e.g., ``"mypackage.models.User"``). |
696+
| `qualified_class_name` | `str` | The fully qualified name of the class containing the method (e.g., ``"mypackage.models.User"``), or a module name for module-level functions. |
692697
| `qualified_method_name` | `str` | The name of the method to retrieve (e.g., ``"save"`` or ``"__init__"``). |
693698

694699
**Returns:**
695700

696701
- `PyCallable \| None`: class:`~cldk.models.python.PyCallable` object containing
697702
- `PyCallable \| None`: all analyzed information about the method, or ``None`` if
698-
- `PyCallable \| None`: the method is not found.
703+
- `PyCallable \| None`: neither a matching class nor a matching module resolves.
699704

700705
> **See Also**
701706
> `get_methods_in_class`: For all methods of a class.
@@ -1320,6 +1325,8 @@ Represents a Python application.
13201325
| `symbol_table` | `Dict[str, PyModule]` | |
13211326
| `call_graph` | `List[PyCallEdge]` | |
13221327
| `external_symbols` | `Dict[str, PyExternalSymbol]` | |
1328+
| `analyzer` | `Optional[PyAnalyzerInfo]` | |
1329+
| `repository` | `Optional[PyRepositoryInfo]` | |
13231330

13241331
### `PyCallEdge`
13251332

@@ -1437,6 +1444,7 @@ Represents a Python call site (function or method invocation) with contextual me
14371444
| `receiver_expr` | `Optional[str]` | |
14381445
| `receiver_type` | `Optional[str]` | |
14391446
| `argument_types` | `List[str]` | |
1447+
| `arguments` | `List[PyCallArgument]` | |
14401448
| `return_type` | `Optional[str]` | |
14411449
| `callee_signature` | `Optional[str]` | |
14421450
| `is_constructor_call` | `bool` | |
@@ -1482,6 +1490,7 @@ Represents a Python class attribute.
14821490
| ---- | ---- | ----------- |
14831491
| `name` | `str` | |
14841492
| `type` | `Optional[str]` | |
1493+
| `initializer` | `Optional[str]` | |
14851494
| `comments` | `List[PyComment]` | |
14861495
| `start_line` | `int` | |
14871496
| `end_line` | `int` | |
@@ -1520,6 +1529,7 @@ Represents a Python import statement.
15201529
| `module` | `str` | |
15211530
| `name` | `str` | |
15221531
| `alias` | `Optional[str]` | |
1532+
| `resolved_module` | `Optional[str]` | |
15231533
| `start_line` | `int` | |
15241534
| `end_line` | `int` | |
15251535
| `start_column` | `int` | |

src/content/docs/reference/python-api/typescript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ graph = analysis.get_call_graph() # -> networkx.DiGraph
5353

5454
<!-- AUTO-GENERATED by scripts/gen_api_docs.py, do not edit by hand. -->
5555

56-
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.0](https://img.shields.io/badge/cldk-1.4.0-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.0/)
56+
[![Source on GitHub](https://img.shields.io/badge/source-codellm--devkit%2Fpython--sdk-181717?logo=github&logoColor=white)](https://github.com/codellm-devkit/python-sdk) [![cldk 1.4.3](https://img.shields.io/badge/cldk-1.4.3-3776AB?logo=pypi&logoColor=white)](https://pypi.org/project/cldk/1.4.3/)
5757

58-
_API reference generated from cldk 1.4.0._
58+
_API reference generated from cldk 1.4.3._
5959

6060
## Analysis
6161

0 commit comments

Comments
 (0)