对抗python类型注解

Question

我有一个非常简单的类，它继承自 requests.Session。目前的代码如下：

import requests
import urllib.parse

from typing import Any, Optional, Union, cast

default_gutendex_baseurl = "https://gutendex.com/"


class Gutendex(requests.Session):
    def __init__(self, baseurl: Optional[str] = None):
        super().__init__()
        self.baseurl = baseurl or default_gutendex_baseurl

    def search(self, keywords: str) -> Any:
        res = self.get("/books", params={"search": keywords})
        res.raise_for_status()
        return res.json()

    def request(
        self, method: str, url: Union[str, bytes], *args, **kwargs
    ) -> requests.Response:
        if self.baseurl and not url.startswith("http"):
            url = urllib.parse.urljoin(self.baseurl, url)

        return super().request(method, url, *args, **kwargs)

我很难让mypy 对request 方法感到满意。

第一个挑战是获取要验证的参数；环境 url: Union[str, bytes] 是匹配类型注释所必需的 types-requests。我刚刚举手获得*args 和 **kwargs 正确，因为唯一的解决方案似乎是 重现单个参数注释，但我很高兴 就这样吧。

处理完函数签名后，mypy 现在开始抱怨 关于致电startswith：

example.py:23：错误：“bytes”的“startswith”的参数 1 具有不兼容的类型“str”；预期“联合[字节，元组[字节，...]]”

我可以通过明确的cast 解决这个问题：

        if not cast(str, url).startswith("http"):
            url = urllib.parse.urljoin(self.baseurl, url)

...但这似乎只是引入了复杂性。

然后它对urllib.parse.urljoin的调用不满意：

example.py:24: 错误：“urljoin”的类型变量“AnyStr”的值不能是“Sequence[object]”
example.py:24：错误：赋值中的类型不兼容（表达式的类型为“Sequence[object]”，变量的类型为“Union[str, bytes]”）

我不太确定这些错误是怎么回事。

我现在通过将显式演员表移到顶部来解决问题 方法：

      def request(
          self, method: str, url: Union[str, bytes], *args, **kwargs
      ) -> requests.Response:
          _url = url.decode() if isinstance(url, bytes) else url

          if not _url.startswith("http"):
              _url = urllib.parse.urljoin(self.baseurl, _url)

          return super().request(method, _url, *args, **kwargs)

但这感觉就像一个 hacky 解决方法。

所以：

• 我认为我的函数签名尽可能正确 它，但是url 上的类型注释是否正确或者它们是 不正确并导致问题？

• urljoin 周围的错误是怎么回事？

---

来自 cmets，这是：

        if self.baseurl and not url.startswith(
            "http" if isinstance(url, str) else b"http"
        ):

失败：

example.py:25：错误：“str”的“startswith”的参数 1 具有不兼容的类型“Union[str, bytes]”；预期“Union[str, Tuple[str, ...]]”
example.py:25：错误：“bytes”的“startswith”的参数 1 具有不兼容的类型“Union[str, bytes]”；预期“联合[字节，元组[字节，...]]”

Answer 1

这解决了整个问题：

import requests
import urllib.parse

from typing import Union, cast

default_gutendex_baseurl = "https://gutendex.com/"


class Gutendex(requests.Session):
    def __init__(self, baseurl: str = None):
        super().__init__()
        self.baseurl = baseurl or default_gutendex_baseurl

    def search(self, keywords: str) -> dict[str, str]:
        res = self.get("/books", params={"search": keywords})
        res.raise_for_status()
        return res.json()

    def request(
        self, method: str, url: Union[str, bytes], *args, **kwargs
    ) -> requests.Response:
        if isinstance(url, str):
            if not url.startswith("http"):
                url = urllib.parse.urljoin(self.baseurl, url)

            return super().request(method, url, *args, **kwargs)
        else:
            raise TypeError('Gutendex does not support bytes type url arguments')

如果你说你接受它，你不能只是不处理bytes。如果bytes 通过，只需引发异常或做一些更好的事情。如果你喜欢危险地生活，甚至只是pass。

这段代码在mypy 中验证得很好。

有点令人失望的是，这样的事情无法验证：

        if not url.startswith("http"):
            url = urllib.parse.urljoin(self.baseurl, url if isinstance(url, str) else url.decode())
        return super().request(method, url, *args, **kwargs)

即使url.startswith 是bytes 时无法获得bytes，反之亦然，但它仍然无法验证。 mypy 无法通过运行时逻辑进行验证，因此您只能执行以下操作：

    def request(
        self, method: str, url: Union[str, bytes], *args, **kwargs
    ) -> requests.Response:
        if isinstance(url, str):
            if not url.startswith("http"):
                url = urllib.parse.urljoin(self.baseurl, url)

            return super().request(method, url, *args, **kwargs)
        else:
            if not url.startswith(b"http"):
                url = urllib.parse.urljoin(self.baseurl, url.decode())

            return super().request(method, url, *args, **kwargs)

两者都支持，但以丑陋的方式重复逻辑。