__contains__ fails for Cookies instance with a duplicate key

[alex-postolache]

Hey there,

I've encountered the following issue: name in cookies will fail with a CookieConflict when a Cookie instance contains multiple cookies with the same name (but different domains/paths). Code to reproduce:

import httpx
cookies = httpx.Cookies()
cookies.set("name", "value")
cookies.set("name", "value2", domain="example.com")
"name" in cookies

I've tracked the issue to the fact that Cookies does not implement __contains__, but it defers to its parent Mapping.__contains__. This in turn will trigger a call to Cookies.get(name) and hit the following code path:

def get(  # type: ignore
    self,
    name: str,
    ...
) -> typing.Optional[str]:
    ...
    value = None
    for cookie in self.jar:
        if cookie.name == name:
            if domain is None or cookie.domain == domain:
                if path is None or cookie.path == path:
                    if value is not None:
                        message = f"Multiple cookies exist with name={name}"
                        raise CookieConflict(message)
                    value = cookie.value
    ...

My hunch is that we should get a True instead since such a cookie exists in the jar.

Do you think it's correct to have a __contains__ defined on Cookie, like the one below?

class Cookie:
    def __contains__(self, name: str) -> bool:
        try:
            return self.get(name) is not None
        except CookieConflict:
            return True

[ketpatil77]

The distinction is existence versus selecting a single value. On HTTPX 0.28.1, the ambiguous-name membership check still raises CookieConflict. You can test existence directly through the public cookie jar without relying on Mapping.contains:

import httpx

cookies = httpx.Cookies()
cookies.set("name", "value")
cookies.set("name", "value2", domain="example.com")

exists = any(cookie.name == "name" for cookie in cookies.jar)
assert exists
assert cookies.get("name", domain="example.com", path="/") == "value2"
assert not any(cookie.name == "missing" for cookie in cookies.jar)

For selecting a value, specify domain and path. That selection is different from deciding which cookies an actual request should send; let CookieJar apply the request-domain/path policy for that.

An existence implementation based on any(...) also handles a cookie whose value is None, whereas get(...) is not None conflates that with absence. Whether to change the Mapping membership behavior globally still needs a maintainer API decision; this is a caller-side workaround, not a claim that a fix has landed.

Validated the original exception and the scoped lookup/existence checks above. Cookies API.

Validation version: HTTPX 0.28.1, Python 3.11.9.