Skip to content

Commit 6ec84a2

Browse files
committed
docs: describe API interface groups
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2f79caeb-d789-4eb6-898b-4bddd9d3292a
1 parent 427edd5 commit 6ec84a2

1 file changed

Lines changed: 24 additions & 24 deletions

File tree

‎docs/README.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1518,30 +1518,30 @@ in the UI.
15181518
The interfaces below organize the flat API for type composition. They do not
15191519
represent nested runtime objects.
15201520

1521-
| Interface | Members grouped by the interface |
1522-
| --- | --- |
1523-
| `PythonEnvironmentsApi` | Environment discovery and resolution |
1524-
| `PythonProjectEnvironmentApi` | Selected environment get/set |
1525-
| `PythonEnvironmentManagementApi` | Environment creation/removal |
1526-
| `PythonEnvironmentItemApi` | Environment item creation |
1527-
| `PythonEnvironmentManagerRegistrationApi` | Environment manager registration |
1528-
| `PythonEnvironmentManagerApi` | Combined environment API |
1529-
| `PythonPackageGetterApi` | Package retrieval and version lookup |
1530-
| `PythonPackageManagementApi` | Package installation/removal |
1531-
| `PythonPackageItemApi` | Package item creation |
1532-
| `PythonPackageManagerRegistrationApi` | Package manager registration |
1533-
| `PythonPackageManagerApi` | Combined package API |
1534-
| `PythonProjectGetterApi` | Project lookup |
1535-
| `PythonProjectModifyApi` | Project collection modification |
1536-
| `PythonProjectCreationApi` | Project creator registration |
1537-
| `PythonProjectApi` | Combined project API |
1538-
| `PythonTerminalCreateApi` | Terminal creation |
1539-
| `PythonTerminalRunApi` | Terminal execution |
1540-
| `PythonTaskRunApi` | Task execution |
1541-
| `PythonBackgroundRunApi` | Background execution |
1542-
| `PythonExecutionApi` | Combined execution API |
1543-
| `PythonEnvironmentVariablesApi` | Environment variable lookup/events |
1544-
| `PythonEnvironmentApi` | Complete flat public API |
1521+
| Interface | Members grouped by the interface | Description |
1522+
| --- | --- | --- |
1523+
| `PythonEnvironmentsApi` | Environment discovery and resolution | Lists and refreshes discovered environments, resolves environment URIs, and reports discovery changes. |
1524+
| `PythonProjectEnvironmentApi` | Selected environment get/set | Reads, updates, and observes the selected environment for URI or global scopes. |
1525+
| `PythonEnvironmentManagementApi` | Environment creation/removal | Creates and removes environments through their associated environment managers. |
1526+
| `PythonEnvironmentItemApi` | Environment item creation | Converts provider-supplied environment information into an identified `PythonEnvironment`. |
1527+
| `PythonEnvironmentManagerRegistrationApi` | Environment manager registration | Registers an `EnvironmentManager` implementation with the extension. |
1528+
| `PythonEnvironmentManagerApi` | Combined environment API | Combines environment registration, item creation, lifecycle, discovery, and selection interfaces. |
1529+
| `PythonPackageGetterApi` | Package retrieval and version lookup | Retrieves and refreshes packages, looks up available versions, and reports package changes. |
1530+
| `PythonPackageManagementApi` | Package installation/removal | Installs, upgrades, or uninstalls packages in an environment. |
1531+
| `PythonPackageItemApi` | Package item creation | Converts provider-supplied package information into an identified `Package`. |
1532+
| `PythonPackageManagerRegistrationApi` | Package manager registration | Registers a `PackageManager` implementation with the extension. |
1533+
| `PythonPackageManagerApi` | Combined package API | Combines package registration, retrieval, management, and item creation interfaces. |
1534+
| `PythonProjectGetterApi` | Project lookup | Returns all known projects or the project associated with a URI. |
1535+
| `PythonProjectModifyApi` | Project collection modification | Adds, removes, and observes projects in the tracked project collection. |
1536+
| `PythonProjectCreationApi` | Project creator registration | Registers a `PythonProjectCreator` implementation. |
1537+
| `PythonProjectApi` | Combined project API | Combines project lookup, modification, events, and creator registration interfaces. |
1538+
| `PythonTerminalCreateApi` | Terminal creation | Creates a terminal configured for a Python environment. |
1539+
| `PythonTerminalRunApi` | Terminal execution | Runs Python in shared or dedicated terminals. |
1540+
| `PythonTaskRunApi` | Task execution | Runs Python as a VS Code task. |
1541+
| `PythonBackgroundRunApi` | Background execution | Starts Python as a background process with stream and exit access. |
1542+
| `PythonExecutionApi` | Combined execution API | Combines terminal creation, terminal execution, task execution, and background execution. |
1543+
| `PythonEnvironmentVariablesApi` | Environment variable lookup/events | Resolves effective environment variables and reports source changes. |
1544+
| `PythonEnvironmentApi` | Complete flat public API | Combines all environment, package, project, execution, and environment-variable APIs exposed at runtime. |
15451545

15461546
## Compatibility guidance
15471547

0 commit comments

Comments
 (0)