Unexpected keyword argument "reject_bytes" for "dumps"

[aspacca]

What did you do?

• added this function in my source:

def json_dumper(json_object: Any) -> str:
    return ujson.dumps(json_object, ensure_ascii=False, reject_bytes=False)

• run mypy

What did you expect to happen?

mypy to not complain about the new function

What actually happened?

mypy returned the following error:
Unexpected keyword argument "reject_bytes" for "dumps"

What versions are you using?

• OS: 21.6.0 Darwin Kernel Version 21.6.0: Sat Jun 18 17:07:25 PDT 2022; root:xnu-8020.140.41~1/RELEASE_X86_64 x86_64
• Python: Python 3.9.13
• UltraJSON: 5.4.0

Please include code that reproduces the issue.

The best reproductions are self-contained scripts with minimal dependencies.

def json_dumper(json_object: Any) -> str:
    return ujson.dumps(json_object, ensure_ascii=False, reject_bytes=False)

[bwoodsend]

We don't provide stubs so wherever mypy gathers its information about which arguments each function takes, it's not here.

[bwoodsend]

Digging around, it's here you want to change. I suggest you make a pull request to typeshed.

[aspacca]

@bwoodsend thanks for investigating into it even if it was not a problem of the codebase :)

I will look into opening a PR to typeshed

[JustAnotherArchivist]

I looked a bit into what it would take to ship stubs ourselves so we don't need to remember to send a PR to typeshed upon a release with API changes. To say it's a bit of a mess is probably an understatement. PEP 561 specifies how stubs should be shipped by packages, but it assumes (requires?) an actual Python package structure and isn't easily applied to a single-module extension. There's an open issue about this, too: python/typing#1061. The hack suggested there of having _ujson with a from _ujson import * Python package would probably be least likely to break, but I'm not sure we want to go down that route. The single-file approach suggested there sounds better, but given that it's not even specified to work, it's likely there are edge cases where it breaks. So it's probably best to just stay with typeshed at least until an acceptable solution exists.