Skip to content

[Docs] Fix gen_schema_reference.py on Python 3.10 #3883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
un-def merged 2 commits into from
May 21, 2026
Merged

[Docs] Fix gen_schema_reference.py on Python 3.10 #3883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3891af1
[Docs] Fix `gen_schema_reference.py` on Python 3.10
un-def May 15, 2026
7668445
Merge remote-tracking branch 'origin/master' into pr_docs_py310
un-def May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,18 +153,20 @@ dev = [
"pytest-xdist>=3.6.1",
"pyinstrument>=5.0.0",
"kubernetes-stubs-elephant-fork>=35.0.0.post3",
# docs
"dstack[server]; python_version >= '3.11'",
"dstack-plugin-server; python_version >= '3.11'",
"pillow; python_version >= '3.11'",
"cairosvg; python_version >= '3.11'",
"mkdocs-material>=9.7.0; python_version >= '3.11'",
"mkdocs-material[imaging]; python_version >= '3.11'",
"mkdocs-material-extensions; python_version >= '3.11'",
"mkdocs-redirects; python_version >= '3.11'",
"mkdocs-gen-files; python_version >= '3.11'",
"mkdocstrings[python]; python_version >= '3.11'",
"mkdocs-render-swagger-plugin; python_version >= '3.11'",
{include-group = "docs"},
]
docs = [
"dstack[server]",
"dstack-plugin-server",
"pillow",
"cairosvg",
"mkdocs-material>=9.7.0",
"mkdocs-material[imaging]",
"mkdocs-material-extensions",
"mkdocs-redirects",
"mkdocs-gen-files",
"mkdocstrings[python]",
"mkdocs-render-swagger-plugin",
]

[project.optional-dependencies]
Expand Down
13 changes: 7 additions & 6 deletions scripts/docs/gen_schema_reference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@

def _is_linkable_type(annotation: Any) -> bool:
"""Check if a type annotation contains a BaseModel subclass (excluding Range)."""
if inspect.isclass(annotation):
return issubclass(annotation, BaseModel) and not issubclass(annotation, Range)
origin = get_origin(annotation)
type_ = origin if origin is not None else annotation
if inspect.isclass(type_):
return issubclass(type_, BaseModel) and not issubclass(type_, Range)
if origin is Annotated:
return _is_linkable_type(get_args(annotation)[0])
if origin is Union:
Expand Down Expand Up @@ -239,12 +240,12 @@ def generate_schema_reference(
default_repr = None
elif isinstance(default, (list, tuple, dict)) and len(default) == 0:
default_repr = None
elif isinstance(default, str):
default_repr = default
elif isinstance(default, BaseModel):
default_repr = str(default)
elif isinstance(default, Enum):
default_repr = str(default.value)
elif isinstance(default, BaseModel):
default_repr = str(default)
elif isinstance(default, str):
default_repr = default
else:
default_repr = json.dumps(default)
friendly_type = get_friendly_type(field.annotation)
Expand Down
Loading