Add initial type hints

[PrOF-kk]

Closes #118

• Rebased deprecate_py2 onto master before adding type hints, so the diff and/or commit order might be wrong on GitHub until deprecate_py2 is also rebased (I think)
• Added type hints to every public Keep method, except:
  • Any sync=True or similar bools, it's not needed
  • find and findLabel - I don't understand what we're doing with the regexp types ¯\_(ツ)_/¯ , I'd like to add typing to those too but I'd need some help understanding what's going on

This doesn't address the update method shadowing on line 621, or the unused resync arguments

[kiwiz]

Thanks for adding hints and cleaning up all the docstrings.

• I can resolve any conflicts, so no need to worry about that
• Could you elaborate on this? Are bools implicitly typed in some way?
• IIRC, we can just reference re.Pattern now that we don't care about Python 2 (if you're specifically referring to the docstrings
• I'll take a look at resync

Let me know if/once you're done with this PR and I can merge and do any cleanup.

[PrOF-kk]

Sorry for the delay, I must've missed the notification.

• Are bools implicitly typed in some way?

The (IDE/linter/type checker) should be able to already correctly guess the type for that:

I didn't add : bool because the method signature is already pretty messy and didn't want to make it worse

---

• IIRC, we can just reference re.Pattern now that we don't care about Python 2 (if you're specifically referring to the docstrings

Basically I don't understand what we're doing here, is it for Python 2 compat?

gkeepapi/gkeepapi/__init__.py

Lines 23 to 26 in fc21aad

	try:
	Pattern = re._pattern_type # pylint: disable=protected-access
	except AttributeError:
	Pattern = re.Pattern # pylint: disable=no-member

Which leads to not being sure what type to annotate query here and here:

gkeepapi/gkeepapi/__init__.py

Line 933 in fc21aad

def findLabel(self, query, create=False):

gkeepapi/gkeepapi/__init__.py

Lines 811 to 820 in fc21aad

	def find(
	self,
	query=None,
	func=None,
	labels=None,
	colors=None,
	pinned=None,
	archived=None,
	trashed=False,
	): # pylint: disable=too-many-arguments

I think it should be Union[re.Pattern, str] but I'm not sure

[kiwiz]

Got it. That sounds fine then. For re, that block of code is indeed for Py2 support - Union[re.Pattern, str] should do the trick with its removal.

[PrOF-kk]

I just realized typing.Optional exists, so I'll be replacing every Union[X, None] -> Optional[X]

In some places the args are optional but it's not mentioned in the docstrings, so I'll fix that too:

gkeepapi/gkeepapi/__init__.py

Lines 866 to 871 in f0d066f

	def createList(self, title=None, items=None):
	"""Create a new list and populate it. Any changes to the note will be uploaded when :py:meth:`sync` is called.
	Args:
	title (str): The title of the list.
	items (List[(str, bool)]): A list of tuples. Each tuple represents the text and checked status of the listitem.

Question: is there a standardized docstring format we're using here? If not (in the docstrings only, not in the typing hints), since they're comments, we could replace Unions with with X | Y and Optionals with X | None

[kiwiz]

Yup, the repo uses Google-style docstrings (https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). From a quick look at that page, it seems that Sphinx supports/knows about native type hints now. As such, I think we could just remove the typing info from the comments.

If you want to investigate, the docs can be built via the Makefile in docs/

[PrOF-kk]

• Force pushed to use typing.Dict instead of dict for earlier Python version support
• Added regular expression query typing, removed Py2 support
• Removed types in docstrings

[PrOF-kk]

Fixed all my mistakes, Sphinx builds the docs successfully. There's a lot of warnings but none of them are about typing, almost all are WARNING: duplicate object description of X...

Should be ready for review

[kiwiz]

Thanks for your work! I've merged the changes into deprecate_py2. I'll do a review of the library and then merge into main.