mirror of
https://github.com/ankitects/anki.git
synced 2025-09-18 22:12:21 -04:00
9dc3cf216a
* PEP8 dbproxy.py * PEP8 errors.py * PEP8 httpclient.py * PEP8 lang.py * PEP8 latex.py * Add decorator to deprectate key words * Make replacement for deprecated attribute optional * Use new helper `_print_replacement_warning()` * PEP8 media.py * PEP8 rsbackend.py * PEP8 sound.py * PEP8 stdmodels.py * PEP8 storage.py * PEP8 sync.py * PEP8 tags.py * PEP8 template.py * PEP8 types.py * Fix DeprecatedNamesMixinForModule The class methods need to be overridden with instance methods, so every module has its own dicts. * Use `# pylint: disable=invalid-name` instead of id * PEP8 utils.py * Only decorate `__getattr__` with `@no_type_check` * Fix mypy issue with snakecase Importing it from `anki._vendor` raises attribute errors. * Format * Remove inheritance of DeprecatedNamesMixin There's almost no shared code now and overriding classmethods with instance methods raises mypy issues. * Fix traceback frames of deprecation warnings * remove fn/TimedLog (dae) Neither Anki nor add-ons appear to have been using it * fix some issues with stringcase use (dae) - the wheel was depending on the PyPI version instead of our vendored version - _vendor:stringcase should not have been listed in the anki py_library. We already include the sources in py_srcs, and need to refer to them directly. By listing _vendor:stringcase as well, we were making a top-level stringcase library available, which would have only worked for distributing because the wheel definition was also incorrect. - mypy errors are what caused me to mistakenly add the above - they were because the type: ignore at the top of stringcase.py was causing mypy to completely ignore the file, so it was not aware of any attributes it contained.
92 lines
2.4 KiB
Python
92 lines
2.4 KiB
Python
# Copyright: Ankitects Pty Ltd and contributors
|
|
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
# pylint: enable=invalid-name
|
|
|
|
"""
|
|
Wrapper for requests that adds a callback for tracking upload/download progress.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import io
|
|
import os
|
|
from typing import Any, Callable
|
|
|
|
import requests
|
|
from requests import Response
|
|
|
|
from anki._legacy import DeprecatedNamesMixin
|
|
|
|
HTTP_BUF_SIZE = 64 * 1024
|
|
|
|
ProgressCallback = Callable[[int, int], None]
|
|
|
|
|
|
class HttpClient(DeprecatedNamesMixin):
|
|
|
|
verify = True
|
|
timeout = 60
|
|
# args are (upload_bytes_in_chunk, download_bytes_in_chunk)
|
|
progress_hook: ProgressCallback | None = None
|
|
|
|
def __init__(self, progress_hook: ProgressCallback | None = None) -> None:
|
|
self.progress_hook = progress_hook
|
|
self.session = requests.Session()
|
|
|
|
def __enter__(self) -> HttpClient:
|
|
return self
|
|
|
|
def __exit__(self, *args: Any) -> None:
|
|
self.close()
|
|
|
|
def close(self) -> None:
|
|
if self.session:
|
|
self.session.close()
|
|
self.session = None
|
|
|
|
def __del__(self) -> None:
|
|
self.close()
|
|
|
|
def post(self, url: str, data: bytes, headers: dict[str, str] | None) -> Response:
|
|
headers["User-Agent"] = self._agent_name()
|
|
return self.session.post(
|
|
url,
|
|
data=data,
|
|
headers=headers,
|
|
stream=True,
|
|
timeout=self.timeout,
|
|
verify=self.verify,
|
|
) # pytype: disable=wrong-arg-types
|
|
|
|
def get(self, url: str, headers: dict[str, str] = None) -> Response:
|
|
if headers is None:
|
|
headers = {}
|
|
headers["User-Agent"] = self._agent_name()
|
|
return self.session.get(
|
|
url, stream=True, headers=headers, timeout=self.timeout, verify=self.verify
|
|
)
|
|
|
|
def stream_content(self, resp: Response) -> bytes:
|
|
resp.raise_for_status()
|
|
|
|
buf = io.BytesIO()
|
|
for chunk in resp.iter_content(chunk_size=HTTP_BUF_SIZE):
|
|
if self.progress_hook:
|
|
self.progress_hook(0, len(chunk))
|
|
buf.write(chunk)
|
|
return buf.getvalue()
|
|
|
|
def _agent_name(self) -> str:
|
|
from anki.buildinfo import version
|
|
|
|
return f"Anki {version}"
|
|
|
|
|
|
# allow user to accept invalid certs in work/school settings
|
|
if os.environ.get("ANKI_NOVERIFYSSL"):
|
|
HttpClient.verify = False
|
|
|
|
import warnings
|
|
|
|
warnings.filterwarnings("ignore")
|