Skip to content

create_baseline_stubs.py: Fix path separator on windows and ignore root /out #8653

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
merged 4 commits into from
Sep 2, 2022
Merged

create_baseline_stubs.py: Fix path separator on windows and ignore root /out #8653

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2cdb3ae
Fixed path separator on windows
Avasam Aug 31, 2022
7f844a6
Fix create_baseline_stubs leaving an out/ folder behind
Avasam Aug 31, 2022
0a78941
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 31, 2022
de3bb63
Only ensure forward slashes in add_pyright_exclusion
Avasam Sep 1, 2022
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
30 changes: 6 additions & 24 deletions scripts/create_baseline_stubs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
import argparse
import os
import re
import shutil
import subprocess
import sys

Expand Down Expand Up @@ -46,24 +45,9 @@ def get_installed_package_info(project: str) -> tuple[str, str] | None:
return search_pip_freeze_output(project, r.stdout)


def run_stubgen(package: str) -> None:
print(f"Running stubgen: stubgen -p {package}")
subprocess.run(["stubgen", "-p", package], check=True)


def copy_stubs(src_base_dir: str, package: str, stub_dir: str) -> None:
"""Copy generated stubs to the target directory under stub_dir/."""
print(f"Copying stubs to {stub_dir}")
if not os.path.isdir(stub_dir):
os.mkdir(stub_dir)
src_dir = os.path.join(src_base_dir, package)
if os.path.isdir(src_dir):
shutil.copytree(src_dir, os.path.join(stub_dir, package))
else:
src_file = os.path.join("out", f"{package}.pyi")
if not os.path.isfile(src_file):
sys.exit("Error: Cannot find generated stubs")
shutil.copy(src_file, stub_dir)
def run_stubgen(package: str, output: str) -> None:
print(f"Running stubgen: stubgen -o {output} -p {package}")
subprocess.run(["stubgen", "-o", output, "-p", package], check=True)


def run_black(stub_dir: str) -> None:
Expand Down Expand Up @@ -106,7 +90,8 @@ def add_pyright_exclusion(stub_dir: str) -> None:
assert i < len(lines), f"Error parsing {PYRIGHT_CONFIG}"
while not lines[i].strip().startswith("]"):
i += 1
line_to_add = f' "{stub_dir}",'
# Must use forward slash in the .json file
line_to_add = f' "{stub_dir}",'.replace("\\", "/")
initial = i - 1
while lines[i].lower() > line_to_add.lower():
i -= 1
Expand Down Expand Up @@ -171,10 +156,7 @@ def main() -> None:
if os.path.exists(stub_dir):
sys.exit(f"Error: {stub_dir} already exists (delete it first)")

run_stubgen(package)

# Stubs were generated under out/. Copy them to stubs/.
copy_stubs("out", package, stub_dir)
run_stubgen(package, stub_dir)

run_isort(stub_dir)
run_black(stub_dir)
Expand Down