Skip to content

Commit ea4e9ac

Browse files
UN-4010 [MISC] mark the generated transport private
The generated package is an implementation detail of the facade: nothing outside `client.py` should import it, and the flat name reads as public API. Rename it to `_sdk_docstudio` and follow the path through the generator script, the drift gate, the lint excludes, the vendored-code attributes and the README. Regenerating into the new path reproduces the tree byte for byte, so the gate still compares generator output against the spec and nothing else. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014f9oEEYspPH4fmPULTnLkJ
1 parent da9db87 commit ea4e9ac

25 files changed

Lines changed: 14 additions & 14 deletions

‎.gitattributes‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
src/unstract/api_deployments/sdk_docstudio/** linguist-generated=true
1+
src/unstract/api_deployments/_sdk_docstudio/** linguist-generated=true

‎.github/workflows/test.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,5 @@ jobs:
6363
# newly created, which is exactly what a spec growing an endpoint does.
6464
- name: Fail if the committed SDK is not what the spec generates
6565
run: |
66-
git add -N -- src/unstract/api_deployments/sdk_docstudio
67-
git diff --exit-code -- src/unstract/api_deployments/sdk_docstudio
66+
git add -N -- src/unstract/api_deployments/_sdk_docstudio
67+
git diff --exit-code -- src/unstract/api_deployments/_sdk_docstudio

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The retry logic uses exponential backoff with full jitter and respects the `Retr
115115

116116
## Internals
117117

118-
`unstract.api_deployments.sdk_docstudio` is generated from the deployment API's
118+
`unstract.api_deployments._sdk_docstudio` is generated from the deployment API's
119119
OpenAPI spec by `tools/gen_sdk.sh` and is an implementation detail of the
120120
transport. `APIDeploymentsClient` is the supported surface — import from it, not
121121
from the generated tree, which is regenerated wholesale whenever the spec moves.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ lint = [
7070
line-length = 88
7171
# Generated and vendored code is overwritten wholesale by its refresh script, so
7272
# a lint finding there can never be fixed in place.
73-
extend-exclude = ["src/unstract/api_deployments/sdk_docstudio", "tests/baseline"]
73+
extend-exclude = ["src/unstract/api_deployments/_sdk_docstudio", "tests/baseline"]
7474

7575
[tool.ruff.lint]
7676
select = ["E", "F", "W", "I"]

src/unstract/api_deployments/sdk_docstudio/__init__.py renamed to src/unstract/api_deployments/_sdk_docstudio/__init__.py

File renamed without changes.

src/unstract/api_deployments/sdk_docstudio/api/__init__.py renamed to src/unstract/api_deployments/_sdk_docstudio/api/__init__.py

File renamed without changes.

src/unstract/api_deployments/sdk_docstudio/api/deployment/__init__.py renamed to src/unstract/api_deployments/_sdk_docstudio/api/deployment/__init__.py

File renamed without changes.

src/unstract/api_deployments/sdk_docstudio/api/deployment/execute.py renamed to src/unstract/api_deployments/_sdk_docstudio/api/deployment/execute.py

File renamed without changes.

src/unstract/api_deployments/sdk_docstudio/api/deployment/status.py renamed to src/unstract/api_deployments/_sdk_docstudio/api/deployment/status.py

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)