Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use TypedDict for return type of legacy detect() #469

Merged
merged 3 commits into from
May 18, 2024
Merged

use TypedDict for return type of legacy detect() #469

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89222b7
use TypedDict for return type of legacy detect()
pinterior May 14, 2024
83473fc
use typing.TYPE_CHECKING (from code review)
pinterior May 15, 2024
e48b609
trivial styling fix
pinterior May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions charset_normalizer/legacy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
from typing import Any, Dict, Optional, Union
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Optional
from warnings import warn

from .api import from_bytes
from .constant import CHARDET_CORRESPONDENCE

# TODO: remove this check when dropping Python 3.7 support
if TYPE_CHECKING:
from typing_extensions import TypedDict

class ResultDict(TypedDict):
encoding: Optional[str]
language: str
confidence: Optional[float]


def detect(
byte_str: bytes, should_rename_legacy: bool = False, **kwargs: Any
) -> Dict[str, Optional[Union[str, float]]]:
) -> ResultDict:
"""
chardet legacy method
Detect the encoding of the given byte string. It should be mostly backward-compatible.
Expand Down
Loading