Skip to content

Add stubs for dockerfile-parse #9305

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
AlexWaygood merged 7 commits into from
Nov 30, 2022
Merged

Add stubs for dockerfile-parse #9305

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fad94a1
Add stubs for dockerfile-parse
pyhedgehog Nov 30, 2022
9066bd0
make stubtest and pyright happy: use typing_extensions.Literal instea…
pyhedgehog Nov 30, 2022
ae0e66b
add types-six to requirements + use typing_extensions.TypedDict inste…
pyhedgehog Nov 30, 2022
4fbbb71
requires = ["types-six"] to dockerfile-parse/METADATA.toml
pyhedgehog Nov 30, 2022
1f3cf13
Implemented a lot of suggestions of @AlexWaygood.
pyhedgehog Nov 30, 2022
c925c34
Add stubs/dockerfile-parse/@tests/stubtest_allowlist.txt
pyhedgehog Nov 30, 2022
134b5b0
Fix a few minor style issues
AlexWaygood Nov 30, 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
Prev Previous commit
Fix a few minor style issues
  • Loading branch information
@AlexWaygood
AlexWaygood committed Nov 30, 2022
commit 134b5b08095e0500407ceabbafa633775c28b322
19 changes: 10 additions & 9 deletions stubs/dockerfile-parse/dockerfile_parse/parser.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import typing as t
from collections.abc import Mapping, Sequence
from typing import IO, ClassVar
from typing_extensions import TypedDict

from .util import Context

class KeyValues(dict[str, str]):
parser_attr: t.ClassVar[str | None]
parser_attr: ClassVar[str | None]
parser: DockerfileParser
def __init__(self, key_values: t.Mapping[str, str], parser: DockerfileParser) -> None: ...
def __init__(self, key_values: Mapping[str, str], parser: DockerfileParser) -> None: ...
def __delitem__(self, key: str) -> None: ...
def __setitem__(self, key: str, value: str) -> None: ...
def __eq__(self, other: object) -> bool: ...
Expand All @@ -24,7 +25,7 @@ class _InstructionDict(TypedDict):
value: str

class DockerfileParser:
fileobj: t.IO[str]
fileobj: IO[str]
dockerfile_path: str
cache_content: bool
cached_content: str
Expand All @@ -37,7 +38,7 @@ class DockerfileParser:
cache_content: bool = ...,
env_replace: bool = ...,
parent_env: dict[str, str] | None = ...,
fileobj: t.IO[str] | None = ...,
fileobj: IO[str] | None = ...,
build_args: dict[str, str] | None = ...,
) -> None: ...
lines: list[str]
Expand All @@ -46,14 +47,14 @@ class DockerfileParser:
def structure(self) -> list[_InstructionDict]: ...
@property
def json(self) -> str: ...
parent_images: t.Sequence[str]
parent_images: Sequence[str]
@property
def is_multistage(self) -> bool: ...
baseimage: str
cmd: str
labels: t.Mapping[str, str]
envs: t.Mapping[str, str]
args: t.Mapping[str, str]
labels: Mapping[str, str]
envs: Mapping[str, str]
args: Mapping[str, str]
def add_lines(
self, *lines: str, all_stages: bool | None = ..., at_start: bool | None = ..., skip_scratch: bool | None = ...
) -> None: ...
Expand Down
48 changes: 24 additions & 24 deletions stubs/dockerfile-parse/dockerfile_parse/util.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import typing as t
from collections.abc import Generator
from collections.abc import Generator, Mapping, MutableMapping
from io import StringIO
from typing import ClassVar
from typing_extensions import Literal, TypeAlias

def b2u(string: bytes | str) -> str: ...
Expand All @@ -10,38 +10,38 @@ _Quotes: TypeAlias = Literal["'", '"']
_ContextType: TypeAlias = Literal["ARG", "ENV", "LABEL"]

class WordSplitter:
SQUOTE: t.ClassVar[_Quotes]
DQUOTE: t.ClassVar[_Quotes]
SQUOTE: ClassVar[_Quotes]
DQUOTE: ClassVar[_Quotes]
stream: StringIO
args: t.Mapping[str, str] | None
envs: t.Mapping[str, str] | None
args: Mapping[str, str] | None
envs: Mapping[str, str] | None
quotes: _Quotes | None
escaped: bool
def __init__(self, s: str, args: t.Mapping[str, str] | None = ..., envs: t.Mapping[str, str] | None = ...) -> None: ...
def __init__(self, s: str, args: Mapping[str, str] | None = ..., envs: Mapping[str, str] | None = ...) -> None: ...
def dequote(self) -> str: ...
def split(self, maxsplit: int | None = ..., dequote: bool = ...) -> Generator[str | None, None, None]: ...

def extract_key_values(env_replace: bool, args: t.Mapping[str, str], envs: t.Mapping[str, str], instruction_value: str): ...
def extract_key_values(env_replace: bool, args: Mapping[str, str], envs: Mapping[str, str], instruction_value: str): ...
def get_key_val_dictionary(
instruction_value, env_replace: bool = ..., args: t.Mapping[str, str] | None = ..., envs: t.Mapping[str, str] | None = ...
instruction_value, env_replace: bool = ..., args: Mapping[str, str] | None = ..., envs: Mapping[str, str] | None = ...
): ...

class Context:
args: t.MutableMapping[str, str]
envs: t.MutableMapping[str, str]
labels: t.MutableMapping[str, str]
line_args: t.Mapping[str, str]
line_envs: t.Mapping[str, str]
line_labels: t.Mapping[str, str]
args: MutableMapping[str, str]
envs: MutableMapping[str, str]
labels: MutableMapping[str, str]
line_args: Mapping[str, str]
line_envs: Mapping[str, str]
line_labels: Mapping[str, str]
def __init__(
self,
args: t.MutableMapping[str, str] | None = ...,
envs: t.MutableMapping[str, str] | None = ...,
labels: t.MutableMapping[str, str] | None = ...,
line_args: t.Mapping[str, str] | None = ...,
line_envs: t.Mapping[str, str] | None = ...,
line_labels: t.Mapping[str, str] | None = ...,
args: MutableMapping[str, str] | None = ...,
envs: MutableMapping[str, str] | None = ...,
labels: MutableMapping[str, str] | None = ...,
line_args: Mapping[str, str] | None = ...,
line_envs: Mapping[str, str] | None = ...,
line_labels: Mapping[str, str] | None = ...,
) -> None: ...
def set_line_value(self, context_type: _ContextType, value: t.Mapping[str, str]) -> None: ...
def get_line_value(self, context_type: _ContextType) -> t.Mapping[str, str]: ...
def get_values(self, context_type: _ContextType) -> t.Mapping[str, str]: ...
def set_line_value(self, context_type: _ContextType, value: Mapping[str, str]) -> None: ...
def get_line_value(self, context_type: _ContextType) -> Mapping[str, str]: ...
def get_values(self, context_type: _ContextType) -> Mapping[str, str]: ...