Type hints need to include `requests_mock.ANY`

[lmmarsano]

According to request matching documentation,

requests-mock/requests_mock/mocker.pyi

Line 33 in 850671f

method: str,

should be

method: Union[str, typing.Literal[requests_mock.adapter.ANY]]

etc.

[OldSneerJaw]

Unfortunately typing.Literal[requests_mock.adapter.ANY] is an invalid type; Literal only supports None, bool, bytes, int, str, or an enum value. As long as requests_mock.adapter.ANY is a plain object, the best option is either method: typing.Any or method: typing.Union[str, typing.Any]. The latter is arguably more descriptive for the end user of the library, but technically offers no stricter type guarantees than the former.

Relatedly, type hints for MockerCore's register_uri and request methods are missing url parameters. This is a problem for those using the pytest requests_mock test fixture (which has a type of requests_mock.mocker.Mocker) and that wish to match a request with ANY for the method.

I plan to publish a pull request with these changes shortly.

[lmmarsano]

Unfortunately typing.Literal[requests_mock.adapter.ANY] is an invalid type; Literal only supports None, bool, bytes, int, str, or an enum value.

Good point.
Maybe that's a good argument for the next version making requests_mock.adapter.ANY an enum.
@jamielennox, would that be okay?

[jamielennox]

I'm not very familiar with the requirements for types, but in theory it's fine. I just wanted ANY to be a sentinel value rather than just an alias for a string. In practice it really doesn't matter and everyone using it now must be referencing the object so will automatically be updated.

[jamielennox]

@pcorpet @palfrey - you get to be my typing experts now.

[palfrey]

I'm not very familiar with the requirements for types, but in theory it's fine. I just wanted ANY to be a sentinel value rather than just an alias for a string. In practice it really doesn't matter and everyone using it now must be referencing the object so will automatically be updated.

The enum method would work. https://www.revsys.com/tidbits/sentinel-values-python/ also notes you could have ANY as a class for sentinel values, and then you could do method: Union[str, ANY]

[jamielennox]

I think we can say closed by #173

Using a class for a sentinel is a good idea, but not immediately important if we have the typing fixed.

[jamielennox]

released as 1.9.3 - thanks for the help, and sorry it took a little while.