Merge branch 'main' into update-syrupy

DanielRosenwasser · web-flow · commit fd13684b00ae · 2025-11-06T12:12:37.000-08:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -10,3 +10,7 @@ updates:
     directory: "/"
     schedule:
       interval: weekly
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: weekly
diff --git a/.github/workflows/ci.js.yml b/.github/workflows/ci.js.yml
@@ -30,9 +30,9 @@ jobs:
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: "npm"
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -13,11 +13,11 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
     - name: Use Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 18.x
         cache: 'npm'
@@ -29,9 +29,9 @@ jobs:
         npm ci
         npm run build
     - name : Upload artifact
-      uses: actions/upload-pages-artifact@v2
+      uses: actions/upload-pages-artifact@v3
       with:
         name: github-pages
         path: site/_site
     - name: Deploy to GitHub Pages from artifacts
-      uses: actions/deploy-pages@v2 
+      uses: actions/deploy-pages@v4 
diff --git a/python/README.md b/python/README.md
@@ -18,13 +18,10 @@ Types are all you need!
 
 ## Getting Started
 
-> [!NOTE]
-> TypeChat is not currently published. For now, install from our GitHub repository.
-
 Install TypeChat:
 
 ```sh
-pip install "typechat @ git+https://github.com/microsoft/TypeChat#subdirectory=python"
+pip install typechat
 ```
 
 You can also develop TypeChat from source, which needs [Python >=3.11](https://www.python.org/downloads/), [hatch](https://hatch.pypa.io/1.6/install/), and [Node.js >=20](https://nodejs.org/en/download):
diff --git a/python/examples/healthData/translator.py b/python/examples/healthData/translator.py
@@ -41,9 +41,9 @@ def _create_request_prompt(self, intent: str) -> str:
         now = datetime.now()
 
         prompt = F"""
-user: You are a service that translates user requests into JSON objects of type  "{self._type_name}" according to the following TypeScript definitions:
+user: You are a service that translates user requests into JSON objects of type  "{self.type_name}" according to the following TypeScript definitions:
 '''
-{self._schema_str}
+{self.schema_str}
 '''
 
 user:
diff --git a/python/package-lock.json b/python/package-lock.json
diff --git a/python/package.json b/python/package.json
@@ -1,7 +1,7 @@
 {
   "name": "typechat-py",
   "private": true,
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "TypeChat is a library that makes it easy to build natural language interfaces using types.",
   "scripts": {
     "check": "pyright"
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -18,6 +18,7 @@ classifiers = [
   "Programming Language :: Python",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
diff --git a/python/src/typechat/__about__.py b/python/src/typechat/__about__.py
@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: Microsoft Corporation
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.0.2"
+__version__ = "0.0.4"
diff --git a/python/src/typechat/_internal/translator.py b/python/src/typechat/_internal/translator.py
@@ -17,8 +17,8 @@ class TypeChatJsonTranslator(Generic[T]):
     model: TypeChatLanguageModel
     validator: TypeChatValidator[T]
     target_type: type[T]
-    _type_name: str
-    _schema_str: str
+    type_name: str
+    schema_str: str
     _max_repair_attempts = 1
 
     def __init__(
@@ -46,8 +46,8 @@ def __init__(
             error_text = "".join(f"\n- {error}" for error in conversion_result.errors)
             raise ValueError(f"Could not convert Python type to TypeScript schema: \n{error_text}")
 
-        self._type_name = conversion_result.typescript_type_reference
-        self._schema_str = conversion_result.typescript_schema_str
+        self.type_name = conversion_result.typescript_type_reference
+        self.schema_str = conversion_result.typescript_schema_str
 
     async def translate(self, input: str, *, prompt_preamble: str | list[PromptSection] | None = None) -> Result[T]:
         """
@@ -102,9 +102,9 @@ async def translate(self, input: str, *, prompt_preamble: str | list[PromptSecti
 
     def _create_request_prompt(self, intent: str) -> str:
         prompt = f"""
-You are a service that translates user requests into JSON objects of type "{self._type_name}" according to the following TypeScript definitions:
+You are a service that translates user requests into JSON objects of type "{self.type_name}" according to the following TypeScript definitions:
 ```
-{self._schema_str}
+{self.schema_str}
 ```
 The following is a user request:
 '''
diff --git a/python/src/typechat/_internal/ts_conversion/python_type_to_ts_nodes.py b/python/src/typechat/_internal/ts_conversion/python_type_to_ts_nodes.py
@@ -2,6 +2,7 @@
 
 from collections import OrderedDict
 import inspect
+import sys
 import typing
 import typing_extensions
 from dataclasses import MISSING, Field, dataclass
@@ -79,6 +80,15 @@ class Dataclassish(Protocol):
 class TypeOfTypedDict(Protocol):
     __total__: bool
 
+if sys.version_info >= (3, 12) and typing.TypeAliasType is not typing_extensions.TypeAliasType:
+    # Sometimes typing_extensions aliases TypeAliasType,
+    # sometimes it's its own declaration.
+    def is_type_alias_type(py_type: object) -> TypeGuard[TypeAliasType]:
+        return isinstance(py_type, typing.TypeAliasType | typing_extensions.TypeAliasType)
+else:
+    def is_type_alias_type(py_type: object) -> TypeGuard[TypeAliasType]:
+        return isinstance(py_type, typing_extensions.TypeAliasType)
+
 
 def is_generic(py_type: object) -> TypeGuard[GenericAliasish]:
     return hasattr(py_type, "__origin__") and hasattr(py_type, "__args__")
@@ -88,9 +98,8 @@ def is_dataclass(py_type: object) -> TypeGuard[Dataclassish]:
 
 TypeReferenceTarget: TypeAlias = type | TypeAliasType | TypeVar | GenericAliasish
 
-
 def is_python_type_or_alias(origin: object) -> TypeGuard[type | TypeAliasType]:
-    return isinstance(origin, TypeAliasType | type)
+    return isinstance(origin, type) or is_type_alias_type(origin)
 
 
 _KNOWN_GENERIC_SPECIAL_FORMS: frozenset[Any] = frozenset(
@@ -393,7 +402,7 @@ def declare_type(py_type: object):
             reserve_name(py_type)
 
             return InterfaceDeclarationNode(py_type.__name__, None, "", None, [])
-        if isinstance(py_type, TypeAliasType):
+        if is_type_alias_type(py_type):
             type_params = [TypeParameterDeclarationNode(type_param.__name__) for type_param in py_type.__type_params__]
 
             reserve_name(py_type)
diff --git a/python/tests/__py3.12+_snapshots__/test_generic_alias_3/test_generic_alias3.schema.d.ts b/python/tests/__py3.12+_snapshots__/test_generic_alias_3/test_generic_alias3.schema.d.ts
@@ -0,0 +1,13 @@
+// Entry point is: 'FirstOrSecond'
+
+type FirstOrSecond<T> = First<T> | Second<T>
+
+interface Second<T> {
+    kind: "second";
+    second_attr: T;
+}
+
+interface First<T> {
+    kind: "first";
+    first_attr: T;
+}
diff --git a/python/tests/__py3.12+_snapshots__/test_generic_alias_4/test_generic_alias4.schema.d.ts b/python/tests/__py3.12+_snapshots__/test_generic_alias_4/test_generic_alias4.schema.d.ts
diff --git a/python/tests/__py3.12+_snapshots__/test_type_alias_syntax/test_type_alias_union1.schema.d.ts b/python/tests/__py3.12+_snapshots__/test_type_alias_syntax/test_type_alias_union1.schema.d.ts
@@ -0,0 +1,3 @@
+// Entry point is: 'StrOrInt'
+
+type StrOrInt = string | number
diff --git a/python/tests/__snapshots__/test_generic_alias_2/test_generic_alias2.schema.d.ts b/python/tests/__snapshots__/test_generic_alias_2/test_generic_alias2.schema.d.ts
@@ -0,0 +1,17 @@
+// Entry point is: 'Nested'
+
+interface Nested {
+    item: FirstOrSecond<string>;
+}
+
+type FirstOrSecond<T> = First<T> | Second<T>
+
+interface Second<T> {
+    kind: "second";
+    second_attr: T;
+}
+
+interface First<T> {
+    kind: "first";
+    first_attr: T;
+}
diff --git a/python/tests/test_generic_alias_1.py b/python/tests/test_generic_alias_1.py
@@ -5,7 +5,6 @@
 
 T = TypeVar("T", covariant=True)
 
-
 class First(Generic[T], TypedDict):
     kind: Literal["first"]
     first_attr: T
diff --git a/python/tests/test_generic_alias_2.py b/python/tests/test_generic_alias_2.py
@@ -22,7 +22,5 @@ class Nested(TypedDict):
     item: FirstOrSecond[str]
 
 
-
-def test_generic_alias1(snapshot: Any):
+def test_generic_alias2(snapshot: Any):
     assert(python_type_to_typescript_schema(Nested) == snapshot(extension_class=TypeScriptSchemaSnapshotExtension))
-    
diff --git a/python/tests/test_generic_alias_3.py b/python/tests/test_generic_alias_3.py
@@ -0,0 +1,20 @@
+from typing import Any
+from .utilities import check_snapshot_for_module_string_if_3_12_plus
+
+module_str = """
+from typing import Literal, TypedDict
+class First[T](TypedDict):
+    kind: Literal["first"]
+    first_attr: T
+
+
+class Second[T](TypedDict):
+    kind: Literal["second"]
+    second_attr: T
+
+
+type FirstOrSecond[T] = First[T] | Second[T]
+"""
+
+def test_generic_alias3(snapshot: Any):
+    check_snapshot_for_module_string_if_3_12_plus(snapshot, input_type_str="FirstOrSecond", module_str=module_str)
diff --git a/python/tests/test_generic_alias_4.py b/python/tests/test_generic_alias_4.py
@@ -0,0 +1,23 @@
+from typing import Any
+from .utilities import check_snapshot_for_module_string_if_3_12_plus
+
+module_str = """
+from typing import Literal, TypedDict
+class First[T](TypedDict):
+    kind: Literal["first"]
+    first_attr: T
+
+
+class Second[T](TypedDict):
+    kind: Literal["second"]
+    second_attr: T
+
+
+type FirstOrSecond[T] = First[T] | Second[T]
+
+class Nested(TypedDict):
+    item: FirstOrSecond[str]
+"""
+
+def test_generic_alias4(snapshot: Any):
+    check_snapshot_for_module_string_if_3_12_plus(snapshot, input_type_str="Nested", module_str=module_str)
diff --git a/python/tests/test_type_alias_syntax.py b/python/tests/test_type_alias_syntax.py
@@ -0,0 +1,7 @@
+from typing import Any
+from .utilities import check_snapshot_for_module_string_if_3_12_plus
+
+module_str = "type StrOrInt = str | int"
+
+def test_type_alias_union1(snapshot: Any):
+    check_snapshot_for_module_string_if_3_12_plus(snapshot, "StrOrInt", module_str)
diff --git a/python/tests/utilities.py b/python/tests/utilities.py
@@ -1,13 +1,14 @@
 from pathlib import Path
 import sys
+import types
 
 from typing_extensions import Any, override
 import pytest
 
 from syrupy.extensions.single_file import SingleFileSnapshotExtension, WriteMode
 from syrupy.location import PyTestLocation
 
-from typechat._internal.ts_conversion import TypeScriptSchemaConversionResult
+from typechat._internal.ts_conversion import TypeScriptSchemaConversionResult, python_type_to_typescript_schema
 
 class TypeScriptSchemaSnapshotExtension(SingleFileSnapshotExtension):
     _write_mode = WriteMode.TEXT
@@ -41,6 +42,19 @@ def dirname(cls, *, test_location: PyTestLocation) -> str:
         )
         return str(result)
 
+class PyVersioned3_12_PlusSnapshotExtension(PyVersionedTypeScriptSchemaSnapshotExtension):
+    py_ver_dir: str = f"__py3.12+_snapshots__"
+
+def check_snapshot_for_module_string_if_3_12_plus(snapshot: Any, input_type_str: str, module_str: str):
+    if sys.version_info < (3, 12):
+        pytest.skip("requires python 3.12 or higher")
+
+    module = types.ModuleType("test_module")
+    exec(module_str, module.__dict__)
+    type_obj = eval(input_type_str, globals(), module.__dict__)
+
+    assert(python_type_to_typescript_schema(type_obj) == snapshot(extension_class=PyVersioned3_12_PlusSnapshotExtension))
+
 @pytest.fixture
 def snapshot_schema(snapshot: Any):
     return snapshot.with_defaults(extension_class=TypeScriptSchemaSnapshotExtension)
diff --git a/site/src/blog/announcing-typechat-0-1-0.md b/site/src/blog/announcing-typechat-0-1-0.md
@@ -200,8 +200,8 @@ You can [see specifics of this change on GitHub](https://github.com/microsoft/Ty
 
 Other changes to be aware of are:
 
-* `TypeChatJsonProgram` and related functions, such as `createModuleTextFromProgram`, `evaluateJsonProgram`, and `createProgramTranslator` all live in `typechat/ts` ([see PR](https://github.com/microsoft/TypeChat/pull/147)).
-* The `processRequests` function for creating a REPL-like prompt now lives in `typechat/interactive` ([see PR](https://github.com/microsoft/TypeChat/pull/221)).
+* `TypeChatJsonProgram` and related functions, such as `createModuleTextFromProgram`, `evaluateJsonProgram`, and `createProgramTranslator` all live in `typechat/ts` ([see the pull request for these `TypeChatJsonProgram` changes](https://github.com/microsoft/TypeChat/pull/147)).
+* The `processRequests` function for creating a REPL-like prompt now lives in `typechat/interactive` ([see the pull request for these `processRequests` changes](https://github.com/microsoft/TypeChat/pull/221)).
 
 ## What's Next?
 
diff --git a/site/src/css/styles.css b/site/src/css/styles.css
@@ -79,6 +79,11 @@
     background-color: #f5f8fa;
 }
 
+.typechat-prose-content pre:focus {
+    outline: 3px solid #0078d4;
+    outline-offset: 2px;
+}
+
 .typechat-prose-content code {
     font-family: var(--typechat-monospace);
     color: var(--typechat-inline-code-color);

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "typechat-py",`
`3`	`3`	`"private": true,`
`4`		`- "version": "0.0.1",`
	`4`	`+ "version": "0.0.4",`
`5`	`5`	`"description": "TypeChat is a library that makes it easy to build natural language interfaces using types.",`
`6`	`6`	`"scripts": {`
`7`	`7`	`"check": "pyright"`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ classifiers = [`
`18`	`18`	`"Programming Language :: Python",`
`19`	`19`	`"Programming Language :: Python :: 3.11",`
`20`	`20`	`"Programming Language :: Python :: 3.12",`
	`21`	`+ "Programming Language :: Python :: 3.13",`
`21`	`22`	`"Programming Language :: Python :: Implementation :: CPython",`
`22`	`23`	`"Programming Language :: Python :: Implementation :: PyPy",`
`23`	`24`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`# SPDX-FileCopyrightText: Microsoft Corporation`
`2`	`2`	`#`
`3`	`3`	`# SPDX-License-Identifier: MIT`
`4`		`-__version__ = "0.0.2"`
	`4`	`+__version__ = "0.0.4"`