Feature Request: Add Typing

[mgorfer]

I would be interested to see correct typing hints when using xESMF.

For my small function, I am getting an error at the return

def regrid_to_lat_lon(
    ds: xr.Dataset,
    target_res_lat: float = 1,
    target_res_lon: float = 1,
) -> xr.Dataset:
    ds_out = xe.util.grid_global(target_res_lat, target_res_lon, cf=True)
    regridder = xe.Regridder(
        ds,
        ds_out,
        "bilinear",
        periodic=True,
    )
    dr_out = regridder(ds, keep_attrs=True)
    return dr_out

Expression of type "NDArray[Any] | Any" cannot be assigned to return type "Dataset"
  Type "NDArray[Any] | Any" cannot be assigned to type "Dataset"
    "NDArray[Any]" is incompatible with "Dataset"Pylance[reportGeneralTypeIssues](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportGeneralTypeIssues)

There are probably not a lot of functions or classes which need typing hints for the average user. I would also be interested to open a Pull Request for this, if the developers want it.

[huard]

@mgorfer,

We'll gladly review and merge a PR for this!

Thanks,

[Siddhesh-Agarwal]

@huard Has this been solved? if not, can I take it?

[mgorfer]

@Siddhesh-Agarwal I did not start this project yet. I would be glad if you could take over.

[Siddhesh-Agarwal]

Hey @huard @mgorfer I think this does the job. Can anyone review the code?