Skip to content
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

[red-knot] Typeshed patching: use build.rs instead of workflow #15370

Merged
merged 2 commits into from
Jan 9, 2025
Merged

[red-knot] Typeshed patching: use build.rs instead of workflow #15370

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35f55f4
[red-knot] Typeshed sync: use copy instead of symlink
sharkdp Jan 9, 2025
9749633
Use build.rs script instead of workflow
sharkdp Jan 9, 2025
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
15 changes: 12 additions & 3 deletions .github/workflows/sync_typeshed.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,19 @@ jobs:
cp -r typeshed/stdlib ruff/crates/red_knot_vendored/vendor/typeshed/stdlib
rm -rf ruff/crates/red_knot_vendored/vendor/typeshed/stdlib/@tests
git -C typeshed rev-parse HEAD > ruff/crates/red_knot_vendored/vendor/typeshed/source_commit.txt

# Patch the typeshed stubs to include `knot_extensions`
ln -s ../../../knot_extensions/knot_extensions.pyi ruff/crates/red_knot_vendored/vendor/typeshed/stdlib/
echo "# Patch applied for red_knot:" >> ruff/crates/red_knot_vendored/vendor/typeshed/stdlib/VERSIONS
echo "knot_extensions: 3.0-" >> ruff/crates/red_knot_vendored/vendor/typeshed/stdlib/VERSIONS
source="crates/red_knot_vendored/knot_extensions/knot_extensions.pyi"
target="crates/red_knot_vendored/vendor/typeshed/stdlib/knot_extensions.pyi"
(
echo "# WARNING: This file is generated by the typeshed sync workflow. Do not edit it manually."
echo "# Edit the source file at '$source' instead and then copy it over to this file."
) > "ruff/$target"
cat "ruff/$source" >> "ruff/$target"
(
echo "# Patch applied for red_knot:"
echo "knot_extensions: 3.0-"
) >> ruff/crates/red_knot_vendored/vendor/typeshed/stdlib/VERSIONS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind the approach taken here. An alternative could be to copy the file in the red_knot_vendored's build.rs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohhh, I like this much more. Thanks!

- name: Commit the changes
id: commit
if: ${{ steps.sync.outcome == 'success' }}
Expand Down
1 change: 0 additions & 1 deletion crates/red_knot_vendored/vendor/typeshed/stdlib/knot_extensions.pyi
View file
Open in desktop

This file was deleted.

26 changes: 26 additions & 0 deletions crates/red_knot_vendored/vendor/typeshed/stdlib/knot_extensions.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# WARNING: This file is generated by the typeshed sync workflow. Do not edit it manually.
# Edit the source file at 'crates/red_knot_vendored/knot_extensions/knot_extensions.pyi' instead.
from typing import _SpecialForm, Any, LiteralString

# Special operations
def static_assert(condition: object, msg: LiteralString | None = None) -> None: ...

# Types
Unknown = object()

# Special forms
Not: _SpecialForm
Intersection: _SpecialForm
TypeOf: _SpecialForm

# Predicates on types
#
# Ideally, these would be annotated using `TypeForm`, but that has not been
# standardized yet (https://peps.python.org/pep-0747).
def is_equivalent_to(type_a: Any, type_b: Any) -> bool: ...
def is_subtype_of(type_derived: Any, typ_ebase: Any) -> bool: ...
def is_assignable_to(type_target: Any, type_source: Any) -> bool: ...
def is_disjoint_from(type_a: Any, type_b: Any) -> bool: ...
def is_fully_static(type: Any) -> bool: ...
def is_singleton(type: Any) -> bool: ...
def is_single_valued(type: Any) -> bool: ...
Loading