This repository was archived by the owner on Aug 30, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Aug 30, 2026. It is now read-only.
Incorrect type hints in collection() #289
Description
Environment details
- OS type and version: MacOS
- Python version: Python 3.7.7
google-cloud-firestoreversion: 2.0.2
At some point recently the type hints for for Client().collection() methods were changed, and they do not reflect examples or the docs. I'm getting type hint warnings.
Should the type hint be changed to simply str ? All the comments and docs show these:
client.collection('top')
client.collection('mydocs/doc/subcol')
client.collection('mydocs', 'doc', 'subcol')None of these are Tuple[str]. The argument *collection_path will produce a tuple when called, but it is called with strings.
Activity
tseaver commentedon Feb 2, 2021
Per the implementation, the
collection_pathargument can be either a single, slash-delimited path string, or aTuple[str]. See the_path_helperfunction, which also has an incorrect typespec for its argument.tseaver commentedon Feb 2, 2021
A correction: the leading asterisk (
*collection_path) means that the value received by the function will always be a tuple, and we require that the elements of the tuple be strings. The caller may pass a single string, e.g.client.collection("mydocs/doc/subcol"), which will be split on the slashes, exactly as if the caller had passedclient.collection("mydocs", "doc", "subcol"). That example is from the docstring ofClient.collection.tseaver commentedon Feb 2, 2021
OK, looking at PEP 484, it appears that
*argsshould be typed as the type of one element.fix: use correct type hint for '*path' args.
fix: use correct type hint for '*path' args
fix: use correct type hint for '*path' args (#300)