Files
django-stubs/django-stubs/core/management/base.pyi
Anders Kaseorg 41804f0e8d Fix OutputWrapper.style_func type (#1080)
style_func has a setter that converts None to lambda x: x, so the
getter cannot return None.

https://github.com/django/django/blob/4.0.6/django/core/management/base.py#L141-L150

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2022-07-30 12:58:41 +03:00

101 lines
3.8 KiB
Python

import sys
from argparse import ArgumentParser, HelpFormatter, Namespace
from io import TextIOBase
from typing import Any, Callable, Iterable, List, Optional, Sequence, Set, TextIO, Tuple, Union
from django.apps.config import AppConfig
from django.core.management.color import Style
from django.utils.datastructures import _ListOrTuple
if sys.version_info < (3, 8):
from typing_extensions import Literal
else:
from typing import Literal
class CommandError(Exception):
def __init__(self, *args: Any, returncode: int = ..., **kwargs: Any) -> None: ...
class SystemCheckError(CommandError): ...
class CommandParser(ArgumentParser):
missing_args_message: Optional[str] = ...
called_from_command_line: Optional[bool] = ...
def __init__(
self,
*,
missing_args_message: Optional[str] = ...,
called_from_command_line: Optional[bool] = ...,
**kwargs: Any
) -> None: ...
def error(self, message: str) -> Any: ...
def handle_default_options(options: Namespace) -> None: ...
def no_translations(handle_func: Callable) -> Callable: ...
class DjangoHelpFormatter(HelpFormatter):
show_last: Set[str] = ...
def add_usage(self, usage: Optional[str], actions: Iterable[Any], *args: Any, **kwargs: Any) -> Any: ...
def add_arguments(self, actions: Any) -> Any: ...
class OutputWrapper(TextIOBase):
@property
def style_func(self) -> Callable[[str], str]: ...
@style_func.setter
def style_func(self, style_func: Optional[Callable[[str], str]]) -> None: ...
ending: str = ...
def __init__(self, out: TextIO, ending: str = ...) -> None: ...
def __getattr__(self, name: str) -> Callable: ...
def flush(self) -> None: ...
def isatty(self) -> bool: ...
def write( # type: ignore[override]
self, msg: str = ..., style_func: Optional[Callable[[str], str]] = ..., ending: Optional[str] = ...
) -> None: ...
class BaseCommand:
help: str = ...
output_transaction: bool = ...
requires_migrations_checks: bool = ...
requires_system_checks: Union[_ListOrTuple[str], Literal["__all__"]] = ...
base_stealth_options: Tuple[str, ...] = ...
stealth_options: Tuple[str, ...] = ...
stdout: OutputWrapper = ...
stderr: OutputWrapper = ...
style: Style = ...
def __init__(
self,
stdout: Optional[TextIO] = ...,
stderr: Optional[TextIO] = ...,
no_color: bool = ...,
force_color: bool = ...,
) -> None: ...
def get_version(self) -> str: ...
def create_parser(self, prog_name: str, subcommand: str, **kwargs: Any) -> CommandParser: ...
def add_arguments(self, parser: CommandParser) -> None: ...
def print_help(self, prog_name: str, subcommand: str) -> None: ...
def run_from_argv(self, argv: List[str]) -> None: ...
def execute(self, *args: Any, **options: Any) -> Any: ...
def check(
self,
app_configs: Optional[Sequence[AppConfig]] = ...,
tags: Optional[Sequence[str]] = ...,
display_num_errors: bool = ...,
include_deployment_checks: bool = ...,
fail_level: int = ...,
databases: Optional[Sequence[str]] = ...,
) -> None: ...
def check_migrations(self) -> None: ...
def handle(self, *args: Any, **options: Any) -> Optional[str]: ...
class AppCommand(BaseCommand):
missing_args_message: str = ...
def add_arguments(self, parser: CommandParser) -> None: ...
def handle(self, *app_labels: str, **options: Any) -> Optional[str]: ...
def handle_app_config(self, app_config: Any, **options: Any) -> Optional[str]: ...
class LabelCommand(BaseCommand):
label: str = ...
missing_args_message: Any = ...
def add_arguments(self, parser: CommandParser) -> None: ...
def handle(self, *labels: str, **options: Any) -> Optional[str]: ...
def handle_label(self, label: str, **options: Any) -> Optional[str]: ...