Feature/add type hints worksheets

[lavigne958]

Add type hints for Worksheet object.

It's complete, but the majority's of it is done. It could be improved with time and when all files have been typed.

It passez the test suite, it passes mypy (some errors are still showing due to missing type annotations on some files).

Later on some of the types here will be improved when I type Spreadsheet object and once merged I will be able to better type the functions in utils.py etc.

[alifeee]

This is a big change! You've done great work with it ❤

I have added a few comments.

I also wonder: JSONAnyType is returned by a lot of the functions like update_title. This seems a bit vague. I am not sure where else it is used, but when we return response (which we do a lot), perhaps we could change the name to HTTPResponseType, or the default import requests response type? In my opinion this would make it more obvious when a method is returning the (raw) HTTP response, rather than a "useful" JSON object.

[lavigne958]

thanks for the review that's a good catch. I added the missing types and updated the wrong types.

[lavigne958]

lso wonder: JSONAnyType is returned by a lot of the functions like update_title. This seems a bit vague. I am not sure where else it is used, but when we return response (which we do a lot), perhaps we could change the name to HTTPResponseType, or the default import requests response type? In my opinion this would make it more obvious when a method is returning the (raw) HTTP response, rather than a "useful" JSON object.

We could but when you look at the file http_client.py you'll see that the response is the actual JSON response we do:

res = self.request.post(....)
return res.json()

so that's the JSON reponse.

We can rename it 'JSONResponse', that is more helpful and type it: MuttableMapping[str. Any]. I use Any for the value because it can be anything, int, str, list of str or int mixed, dict etc.

The responses can vary, when it's a value from a get it should be this: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values#ValueRange
when it's an update it could be something like: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/response

I thought may be we want to be exaustif and create a new type with all possible values inside from the API but that means we need to maintain it ! and we don't look at the response very often we simply return it to the user so no point to me but it's open for discussion 😆

[alifeee]

I thought may be we want to be exaustif and create a new type with all possible values inside from the API but that means we need to maintain it ! and we don't look at the response very often we simply return it to the user so no point to me but it's open for discussion 😆

This sounds like a lot to me, and probably not worth it...! Just having the JSON Any type makes sense, but perhaps with a different name like JSONResponse :)

[lavigne958]

I thought may be we want to be exaustif and create a new type with all possible values inside from the API but that means we need to maintain it ! and we don't look at the response very often we simply return it to the user so no point to me but it's open for discussion laughing

This sounds like a lot to me, and probably not worth it...! Just having the JSON Any type makes sense, but perhaps with a different name like JSONResponse :)

agreed we can rename it JSONResponse.
We can merge this PR, then after it I can start working on better typing between files now that they will be almost all typed.
I'll may be able to add some typed-dict etc too. We'll see 🙃

[lavigne958]

Alright this is a go for merge ! 🥳