Fix kwargs propagation in interfaces module

[vinisalazar]

Hi,

This is something I caught while running the ds = e.to_xarray(decode_times=False) line in 02-extras.ipynb.

Summary of changes

• Fix kwargs propagation for urlopen and third-party libraries
• Improve docstrings
• Add typing.Dict for type annotation

[vinisalazar]

Thanks for the code review, please have a look at 7c49ef6 too, I was having this problem before and I think this may be a good fix?

[ocefpaf]

@vinisalazar and @abkfenris I rebased this one and, hopefully, I did not screw it up! Do you mind taking a second look so we can merge this one?

[abkfenris]

Hmm, I think the doc test failures we're seeing are the difference in call signatures between the various to_X() functions and methods.

erddapy/erddapy/erddapy.py

Lines 334 to 347 in f11ad16

	def to_pandas(self, **kw):
	"""Save a data request to a pandas.DataFrame.
	Accepts any `pandas.read_csv` keyword arguments.
	This method uses the .csvp [1] response as the default for simplicity,
	please check ERDDAP's documentation for the other csv options available.
	[1] Download a ISO-8859-1 .csv file with line 1: name (units). Times are ISO 8601 strings.
	"""
	response = kw.pop("response", "csvp")
	url = self.get_download_url(response=response, **kw)
	return to_pandas(url, **kw)

vs

https://github.com/vinisalazar/erddapy/blob/0ee3c962996dc911d1a0a39c85bc6318ca4b5eef/erddapy/erddapy.py#L334-L353

What is more worrying is that they aren't being caught by other tests. While the new method matches up better to the underlying functions it breaks things for folks currently using erddapy.ERDDAP. Either we need to accept a breaking change, or do some smart shuffling of **kwargs around between methods and functions.

[vinisalazar]

Thanks @abkfenris for pointing that out.

I found one use case in gliderpy which would surely break.

Could this be a possible fix? It preserves the old ERDDAP.to_pandas method while supporting the new interfaces.to_pandas kwargs propagation:

    def to_pandas(
        self,
        **kw
    ):
        """Save a data request to a pandas.DataFrame.

        Accepts any `pandas.read_csv` keyword arguments, passed as a dictionary to pandas_kwargs.

        This method uses the .csvp [1] response as the default for simplicity,
        please check ERDDAP's documentation for the other csv options available.

        [1] Download a ISO-8859-1 .csv file with line 1: name (units). Times are ISO 8601 strings.

        """
        response = kw.pop("response", "csvp")
        url = self.get_download_url(response=response, **kw)
        return to_pandas(url, pandas_kwargs=dict(**kw))

Edit: added by 73128a7 and 4ce66d9.

[vinisalazar]

I believe this should pass after #295 is merged

edit: I rebased this branch after #295 was merged.

[vinisalazar]

@ocefpaf we are getting a ReadTimeout error when building the docs... any clue on why this is happening/what could be done?

[ocefpaf]

I'll try to fix the docs later today. Let's get this one in! Sorry for the delay Vini!