Files
typeshed/stdlib/3/tracemalloc.pyi
Shantanu 4daf0df929 tracemalloc: a number of fixes (#4078)
* tracemalloc.Frame: add __init__

* tracemalloc.Snapshot: add __init__

* tracemalloc.Snapshot: fix a staticmethod

* tracemalloc.Statistic: add __init__

* tracemalloc.StatisticDiff: add __init__

* tracemalloc.Trace: add __init__

* tracemalloc.Traceback: add __init__

* tracemalloc: fix version availability, Trace __init__

* tracemalloc.Traceback: add total_nframe property

* tracemalloc.Trace: add properties

* tracemalloc.Traceback.format: add parameter

* tracemalloc.start: make positional-only

* tracemalloc.Filter: fix version availability

* update whitelists

Co-authored-by: hauntsaninja <>
2020-05-25 15:36:35 -07:00

91 lines
3.3 KiB
Python

# Stubs for tracemalloc (Python 3.4+)
import sys
from typing import List, Optional, Sequence, Tuple, Union, overload
def clear_traces() -> None: ...
def get_object_traceback(obj: object) -> Optional[Traceback]: ...
def get_traceback_limit() -> int: ...
def get_traced_memory() -> Tuple[int, int]: ...
def get_tracemalloc_memory() -> int: ...
def is_tracing() -> bool: ...
def start(__nframe: int = ...) -> None: ...
def stop() -> None: ...
def take_snapshot() -> Snapshot: ...
if sys.version_info >= (3, 6):
class DomainFilter:
inclusive: bool
domain: int
def __init__(self, inclusive: bool, domain: int) -> None: ...
class Filter:
if sys.version_info >= (3, 6):
domain: Optional[int]
inclusive: bool
lineno: Optional[int]
filename_pattern: str
all_frames: bool
if sys.version_info >= (3, 6):
def __init__(self, inclusive: bool, filename_pattern: str, lineno: Optional[int] = ..., all_frames: bool = ..., domain: Optional[int] = ...) -> None: ...
else:
def __init__(self, inclusive: bool, filename_pattern: str, lineno: Optional[int] = ..., all_frames: bool = ...) -> None: ...
class Frame:
filename: str
lineno: int
def __init__(self, frame: Tuple[str, int]) -> None: ...
class Snapshot:
def __init__(self, traces: Tuple[Tuple[str, int], ...], traceback_limit: int) -> None: ...
def compare_to(self, old_snapshot: Snapshot, key_type: str, cumulative: bool = ...) -> List[StatisticDiff]: ...
def dump(self, filename: str) -> None: ...
if sys.version_info >= (3, 6):
def filter_traces(self, filters: Sequence[Union[DomainFilter, Filter]]) -> Snapshot: ...
else:
def filter_traces(self, filters: Sequence[Filter]) -> Snapshot: ...
@staticmethod
def load(filename: str) -> Snapshot: ...
def statistics(self, key_type: str, cumulative: bool = ...) -> List[Statistic]: ...
traceback_limit: int
traces: Sequence[Trace]
class Statistic:
count: int
size: int
traceback: Traceback
def __init__(self, traceback: Traceback, size: int, count: int) -> None: ...
class StatisticDiff:
count: int
count_diff: int
size: int
size_diff: int
traceback: Traceback
def __init__(self, traceback: Traceback, size: int, size_diff: int, count: int, count_diff: int) -> None: ...
class Trace:
domain: int
size: int
traceback: Traceback
if sys.version_info >= (3, 9):
def __init__(self, trace: Union[Tuple[int, int, Tuple[Tuple[str, int], ...], Optional[int]], Tuple[int, int, Tuple[Tuple[str, int], ...]]]) -> None: ...
else:
def __init__(self, trace: Tuple[int, int, Tuple[Tuple[str, int], ...]]) -> None: ...
class Traceback(Sequence[Frame]):
if sys.version_info >= (3, 9):
total_nframe: Optional[int]
def __init__(self, frames: Tuple[Tuple[str, int], ...], total_nframe: Optional[int] = ...) -> None: ...
else:
def __init__(self, frames: Tuple[Tuple[str, int], ...]) -> None: ...
if sys.version_info >= (3, 7):
def format(self, limit: Optional[int] = ..., most_recent_first: bool = ...) -> List[str]: ...
else:
def format(self, limit: Optional[int] = ...) -> List[str]: ...
@overload
def __getitem__(self, i: int) -> Frame: ...
@overload
def __getitem__(self, s: slice) -> Sequence[Frame]: ...
def __len__(self) -> int: ...