test_http_headers.py 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. """
  2. Tests for the pandas custom headers in http(s) requests
  3. """
  4. from functools import partial
  5. import gzip
  6. from io import BytesIO
  7. import pytest
  8. from pandas._config import using_string_dtype
  9. import pandas.util._test_decorators as td
  10. import pandas as pd
  11. import pandas._testing as tm
  12. pytestmark = [
  13. pytest.mark.single_cpu,
  14. pytest.mark.network,
  15. pytest.mark.filterwarnings(
  16. "ignore:Passing a BlockManager to DataFrame:DeprecationWarning"
  17. ),
  18. ]
  19. def gzip_bytes(response_bytes):
  20. with BytesIO() as bio:
  21. with gzip.GzipFile(fileobj=bio, mode="w") as zipper:
  22. zipper.write(response_bytes)
  23. return bio.getvalue()
  24. def csv_responder(df):
  25. return df.to_csv(index=False).encode("utf-8")
  26. def gz_csv_responder(df):
  27. return gzip_bytes(csv_responder(df))
  28. def json_responder(df):
  29. return df.to_json().encode("utf-8")
  30. def gz_json_responder(df):
  31. return gzip_bytes(json_responder(df))
  32. def html_responder(df):
  33. return df.to_html(index=False).encode("utf-8")
  34. def parquetpyarrow_reponder(df):
  35. return df.to_parquet(index=False, engine="pyarrow")
  36. def parquetfastparquet_responder(df):
  37. # the fastparquet engine doesn't like to write to a buffer
  38. # it can do it via the open_with function being set appropriately
  39. # however it automatically calls the close method and wipes the buffer
  40. # so just overwrite that attribute on this instance to not do that
  41. # protected by an importorskip in the respective test
  42. import fsspec
  43. df.to_parquet(
  44. "memory://fastparquet_user_agent.parquet",
  45. index=False,
  46. engine="fastparquet",
  47. compression=None,
  48. )
  49. with fsspec.open("memory://fastparquet_user_agent.parquet", "rb") as f:
  50. return f.read()
  51. def pickle_respnder(df):
  52. with BytesIO() as bio:
  53. df.to_pickle(bio)
  54. return bio.getvalue()
  55. def stata_responder(df):
  56. with BytesIO() as bio:
  57. df.to_stata(bio, write_index=False)
  58. return bio.getvalue()
  59. @pytest.mark.parametrize(
  60. "responder, read_method",
  61. [
  62. (csv_responder, pd.read_csv),
  63. (json_responder, pd.read_json),
  64. (
  65. html_responder,
  66. lambda *args, **kwargs: pd.read_html(*args, **kwargs)[0],
  67. ),
  68. pytest.param(
  69. parquetpyarrow_reponder,
  70. partial(pd.read_parquet, engine="pyarrow"),
  71. marks=td.skip_if_no("pyarrow"),
  72. ),
  73. pytest.param(
  74. parquetfastparquet_responder,
  75. partial(pd.read_parquet, engine="fastparquet"),
  76. # TODO(ArrayManager) fastparquet
  77. marks=[
  78. td.skip_if_no("fastparquet"),
  79. td.skip_if_no("fsspec"),
  80. td.skip_array_manager_not_yet_implemented,
  81. pytest.mark.xfail(using_string_dtype(), reason="TODO(infer_string"),
  82. ],
  83. ),
  84. (pickle_respnder, pd.read_pickle),
  85. (stata_responder, pd.read_stata),
  86. (gz_csv_responder, pd.read_csv),
  87. (gz_json_responder, pd.read_json),
  88. ],
  89. )
  90. @pytest.mark.parametrize(
  91. "storage_options",
  92. [
  93. None,
  94. {"User-Agent": "foo"},
  95. {"User-Agent": "foo", "Auth": "bar"},
  96. ],
  97. )
  98. def test_request_headers(responder, read_method, httpserver, storage_options):
  99. expected = pd.DataFrame({"a": ["b"]})
  100. default_headers = ["Accept-Encoding", "Host", "Connection", "User-Agent"]
  101. if "gz" in responder.__name__:
  102. extra = {"Content-Encoding": "gzip"}
  103. if storage_options is None:
  104. storage_options = extra
  105. else:
  106. storage_options |= extra
  107. else:
  108. extra = None
  109. expected_headers = set(default_headers).union(
  110. storage_options.keys() if storage_options else []
  111. )
  112. httpserver.serve_content(content=responder(expected), headers=extra)
  113. result = read_method(httpserver.url, storage_options=storage_options)
  114. tm.assert_frame_equal(result, expected)
  115. request_headers = dict(httpserver.requests[0].headers)
  116. for header in expected_headers:
  117. exp = request_headers.pop(header)
  118. if storage_options and header in storage_options:
  119. assert exp == storage_options[header]
  120. # No extra headers added
  121. assert not request_headers
  122. @pytest.mark.parametrize(
  123. "engine",
  124. [
  125. "pyarrow",
  126. "fastparquet",
  127. ],
  128. )
  129. def test_to_parquet_to_disk_with_storage_options(engine):
  130. headers = {
  131. "User-Agent": "custom",
  132. "Auth": "other_custom",
  133. }
  134. pytest.importorskip(engine)
  135. true_df = pd.DataFrame({"column_name": ["column_value"]})
  136. msg = (
  137. "storage_options passed with file object or non-fsspec file path|"
  138. "storage_options passed with buffer, or non-supported URL"
  139. )
  140. with pytest.raises(ValueError, match=msg):
  141. true_df.to_parquet("/tmp/junk.parquet", storage_options=headers, engine=engine)