File: cli_utils.pyi

package info (click to toggle)
python-line-profiler 5.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,256 kB
  • sloc: python: 8,119; sh: 810; ansic: 297; makefile: 14
file content (58 lines) | stat: -rw-r--r-- 1,307 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
"""
Shared utilities between the :command:`python -m line_profiler` and
:command:`kernprof` CLI tools.
"""
import argparse
import pathlib
from typing import Protocol, Sequence, Tuple, TypeVar, Union

from line_profiler.toml_config import ConfigSource


A_co = TypeVar('A_co', bound='ActionLike', covariant=True)


class ActionLike(Protocol):
    def __call__(self, parser: 'ParserLike',
                 namespace: argparse.Namespace,
                 values: Sequence,
                 option_string: Union[str, None] = None) -> None:
        ...

    def format_usage(self) -> str:
        ...


class ParserLike(Protocol[A_co]):
    def add_argument(self, arg: str, /, *args: str, **kwargs) -> A_co:
        ...

    @property
    def prefix_chars(self) -> str:
        ...


def add_argument(parser_like: ParserLike[A_co], arg: str, /, *args: str,
                 hide_complementary_options: bool = True, **kwargs) -> A_co:
    ...


def get_cli_config(subtable: str, /, *args, **kwargs) -> ConfigSource:
    ...


def get_python_executable() -> str:
    ...


def positive_float(value: str) -> float:
    ...


def boolean(value: str, *,
            fallback: Union[bool, None] = None, invert: bool = False) -> bool:
    ...


def short_string_path(path: Union[str, pathlib.PurePath]) -> str:
    ...