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

Jump to bottom

fix some issues with the types #41

Merged
merged 3 commits into from
May 13, 2024
Merged

fix some issues with the types #41

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b6d865f
fix overloads when `return_completed_process` argument is not specifi…
DetachHead May 13, 2024
e38c16d
use `Iterable` instead of `list` for `args` type
DetachHead May 13, 2024
182ec77
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 13, 2024
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
66 changes: 48 additions & 18 deletions nodejs_wheel/executable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,43 @@
import os
import subprocess
import sys
from typing import Any, Literal, overload
from typing import Any, Iterable, Literal, overload

ROOT_DIR = os.path.dirname(__file__)


@overload
def _program(
name: str, args: list[str], return_completed_process: Literal[True], **kwargs: Any
name: str,
args: Iterable[str],
return_completed_process: Literal[True],
**kwargs: Any,
) -> subprocess.CompletedProcess[str | bytes]: ...


@overload
def _program(
name: str, args: list[str], return_completed_process: Literal[False], **kwargs: Any
name: str,
args: Iterable[str],
return_completed_process: Literal[False] = ...,
**kwargs: Any,
) -> subprocess.CompletedProcess[str | bytes]: ...


@overload
def _program(
name: str, args: list[str], return_completed_process: bool = False, **kwargs: Any
name: str,
args: Iterable[str],
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]: ...


def _program(
name: str, args: list[str], return_completed_process: bool = False, **kwargs: Any
name: str,
args: Iterable[str],
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]:
bin_dir = ROOT_DIR if os.name == "nt" else os.path.join(ROOT_DIR, "bin")
complete_process = subprocess.run([os.path.join(bin_dir, name), *args], **kwargs)
Expand All @@ -44,7 +56,7 @@ def call_node(

@overload
def call_node(
*args: str, return_completed_process: Literal[False], **kwargs: Any
*args: str, return_completed_process: Literal[False] = ..., **kwargs: Any
) -> int: ...


Expand All @@ -68,24 +80,30 @@ def call_node(

@overload
def node(
args: list[str] | None, return_completed_process: Literal[True], **kwargs: Any
args: Iterable[str] | None, return_completed_process: Literal[True], **kwargs: Any
) -> subprocess.CompletedProcess[str | bytes]: ...


@overload
def node(
args: list[str] | None, return_completed_process: Literal[False], **kwargs: Any
args: Iterable[str] | None,
return_completed_process: Literal[False] = ...,
**kwargs: Any,
) -> int: ...


@overload
def node(
args: list[str] | None = None, return_completed_process: bool = False, **kwargs: Any
args: Iterable[str] | None = None,
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]: ...


def node(
args: list[str] | None = None, return_completed_process: bool = False, **kwargs: Any
args: Iterable[str] | None = None,
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]:
"""Call the node executable with the given arguments.

Expand All @@ -111,24 +129,30 @@ def node(

@overload
def npm(
args: list[str] | None, return_completed_process: Literal[True], **kwargs: Any
args: Iterable[str] | None, return_completed_process: Literal[True], **kwargs: Any
) -> subprocess.CompletedProcess[str | bytes]: ...


@overload
def npm(
args: list[str] | None, return_completed_process: Literal[False], **kwargs: Any
args: Iterable[str] | None,
return_completed_process: Literal[False] = ...,
**kwargs: Any,
) -> int: ...


@overload
def npm(
args: list[str] | None = None, return_completed_process: bool = False, **kwargs: Any
args: Iterable[str] | None = None,
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]: ...


def npm(
args: list[str] | None = None, return_completed_process: bool = False, **kwargs: Any
args: Iterable[str] | None = None,
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]:
"""Call the npm executable with the given arguments.

Expand Down Expand Up @@ -159,24 +183,30 @@ def npm(

@overload
def npx(
args: list[str] | None, return_completed_process: Literal[True], **kwargs: Any
args: Iterable[str] | None, return_completed_process: Literal[True], **kwargs: Any
) -> subprocess.CompletedProcess[str | bytes]: ...


@overload
def npx(
args: list[str] | None, return_completed_process: Literal[False], **kwargs: Any
args: Iterable[str] | None,
return_completed_process: Literal[False] = ...,
**kwargs: Any,
) -> int: ...


@overload
def npx(
args: list[str] | None = None, return_completed_process: bool = False, **kwargs: Any
args: Iterable[str] | None = None,
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]: ...


def npx(
args: list[str] | None = None, return_completed_process: bool = False, **kwargs: Any
args: Iterable[str] | None = None,
return_completed_process: bool = False,
**kwargs: Any,
) -> int | subprocess.CompletedProcess[str | bytes]:
"""Call the npx executable with the given arguments.

Expand Down