Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

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
Next Next commit
Add public stub files.
  • Loading branch information
qnighy committed Mar 9, 2019
commit d715db3a0aa7e8762db283dfc9826f6a672162a6
5 changes: 5 additions & 0 deletions stubs/dotenv/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
from .main import dotenv_values as dotenv_values, find_dotenv as find_dotenv, get_key as get_key, load_dotenv as load_dotenv, set_key as set_key, unset_key as unset_key
from typing import Any, Optional

def load_ipython_extension(ipython: Any) -> None: ...
def get_cli_string(path: Optional[str]=..., action: Optional[str]=..., key: Optional[str]=..., value: Optional[str]=..., quote: Optional[str]=...) -> str: ...
9 changes: 9 additions & 0 deletions stubs/dotenv/cli.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import click
from typing import Any, List

def cli(ctx: click.Context, file: Any, quote: Any) -> None: ...
def list(ctx: click.Context) -> None: ...
def set(ctx: click.Context, key: Any, value: Any) -> None: ...
def get(ctx: click.Context, key: Any) -> None: ...
def unset(ctx: click.Context, key: Any) -> None: ...
def run(ctx: click.Context, commandline: List[str]) -> None: ...
Empty file added stubs/dotenv/compat.pyi
Empty file.
7 changes: 7 additions & 0 deletions stubs/dotenv/ipython.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from IPython.core.magic import Magics # type: ignore
from typing import Any

class IPythonDotEnv(Magics):
def dotenv(self, line: Any) -> None: ...

def load_ipython_extension(ipython: Any) -> None: ...
43 changes: 43 additions & 0 deletions stubs/dotenv/main.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import os
import sys
from typing import Dict, IO, Iterator, List, NamedTuple, Optional, Text, Tuple, Union

if sys.version_info >= (3, 6):
_PathLike = os.PathLike
else:
_PathLike = Text

if sys.version_info >= (3, 0):
from io import StringIO
_StringIO = StringIO
else:
from StringIO import StringIO
_StringIO = StringIO[Text]

Binding = NamedTuple("Binding", [("key", Optional[Text]),
("value", Optional[Text]),
("original", Text)])

def decode_escapes(string: Text) -> Text: ...
def is_surrounded_by(string: Text, char: Text) -> bool: ...
def parse_binding(string: Text, position: int) -> Tuple[Binding, int]: ...
def parse_stream(stream: IO[Text]) -> Iterator[Binding]: ...

class DotEnv:
dotenv_path: Union[Text, _PathLike, _StringIO] = ...
verbose: bool = ...
def __init__(self, dotenv_path: Union[Text, _PathLike, _StringIO], verbose: bool=...) -> None: ...
def dict(self) -> Dict[Text, Text]: ...
def parse(self) -> Iterator[Tuple[Text, Text]]: ...
def set_as_environment_variables(self, override: bool=...) -> bool: ...
def get(self, key: Text) -> Optional[Text]: ...

def get_key(dotenv_path: Union[Text, _PathLike], key_to_get: Text) -> Optional[Text]: ...
def rewrite(path: _PathLike) -> Iterator[Tuple[IO[Text], IO[Text]]]: ...
def set_key(dotenv_path: _PathLike, key_to_set: Text, value_to_set: Text, quote_mode: Text=...) -> Tuple[Optional[bool], Text, Text]: ...
def unset_key(dotenv_path: _PathLike, key_to_unset: Text, quote_mode: Text=...) -> Tuple[Optional[bool], Text]: ...
def resolve_nested_variables(values: Dict[Text, Text]) -> Dict[Text, Text]: ...
def find_dotenv(filename: Text=..., raise_error_if_not_found: bool=..., usecwd: bool=...) -> Text: ...
def load_dotenv(dotenv_path: Union[Text, _PathLike, None]=..., stream: Optional[_StringIO]=..., verbose: bool=..., override: bool=...) -> bool: ...
def dotenv_values(dotenv_path: Union[Text, _PathLike, None]=..., stream: Optional[_StringIO]=..., verbose: bool=...) -> Dict[Text, Text]: ...
def run_command(command: List[str], env: Dict[str, str]) -> int: ...
Empty file added stubs/dotenv/version.pyi
Empty file.