VimPlug/django-stubs
1
0
Fork 0
mirror of https://github.com/davidhalter/django-stubs.git synced 2025-12-07 04:34:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix type annotations for django.utils.safestring (#179)

Browse Source 
* Add/fix types for django.utils.safestring.mark_safe

Django code ref: 964dd4f4f2/django/utils/safestring.py (L71-L84)

* add generic annotations for mark_safe, remove SafeBytes as it is basically deprecated

Co-authored-by: Daniel Hahler <github@thequod.de>
This commit is contained in:
Maxim Kurnikov
2019-09-23 21:16:24 +03:00
parent afcd0d9293
commit 7407b93151
3 changed files with 45 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
django-stubs/utils/html.pyi
View File

@@ -1,9 +1,7 @@
from html.parser import HTMLParser
from typing import Any, Dict, Iterator, List, Optional, Tuple, Union
from typing import Any, Iterator, List, Optional, Tuple, Union
from django.db.models.base import Model
from django.db.models.fields.files import FieldFile
from django.utils.safestring import SafeText, mark_safe as mark_safe
from django.utils.safestring import SafeText
TRAILING_PUNCTUATION_CHARS: str
WRAPPING_PUNCTUATION: Any
@@ -13,15 +11,15 @@ word_split_re: Any
simple_url_re: Any
simple_url_2_re: Any
def escape(text: Optional[Union[Model, FieldFile, int, str]]) -> SafeText: ...
def escapejs(value: str) -> SafeText: ...
def json_script(value: Union[Dict[str, str], str], element_id: str) -> SafeText: ...
def escape(text: Any) -> SafeText: ...
def escapejs(value: Any) -> SafeText: ...
def json_script(value: Any, element_id: str) -> SafeText: ...
def conditional_escape(text: Any) -> str: ...
def format_html(format_string: str, *args: Any, **kwargs: Any) -> SafeText: ...
def format_html_join(
sep: str, format_string: str, args_generator: Union[Iterator[Any], List[Tuple[str]]]
) -> SafeText: ...
def linebreaks(value: str, autoescape: bool = ...) -> str: ...
def linebreaks(value: Any, autoescape: bool = ...) -> str: ...
class MLStripper(HTMLParser):
fed: Any = ...

24
django-stubs/utils/safestring.pyi
View File

@@ -1,14 +1,26 @@
from typing import Any
from typing import TypeVar, overload, Callable, Any
_SD = TypeVar("_SD", bound="SafeData")
class SafeData:
def __html__(self) -> SafeText: ...
class SafeBytes(bytes, SafeData):
def __add__(self, rhs: Any): ...
def __html__(self: _SD) -> _SD: ...
class SafeText(str, SafeData):
@overload
def __add__(self, rhs: SafeText) -> SafeText: ...
@overload
def __add__(self, rhs: str) -> str: ...
@overload
def __iadd__(self, rhs: SafeText) -> SafeText: ...
@overload
def __iadd__(self, rhs: str) -> str: ...
SafeString = SafeText
def mark_safe(s: Any) -> Any: ...
_C = TypeVar("_C", bound=Callable)
@overload
def mark_safe(s: _SD) -> _SD: ...
@overload
def mark_safe(s: _C) -> _C: ...
@overload
def mark_safe(s: Any) -> SafeText: ...