Spaces:
Runtime error
Runtime error
File size: 8,180 Bytes
63deadc |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
from __future__ import annotations
import os
import shutil
import tarfile
import tempfile
from io import BytesIO
from pathlib import Path
import pytest
import fsspec
from fsspec.core import OpenFile
from fsspec.implementations.cached import WholeFileCacheFileSystem
from fsspec.implementations.tar import TarFileSystem
from fsspec.implementations.tests.test_archive import archive_data, temptar
def test_info():
with temptar(archive_data) as t:
fs = fsspec.filesystem("tar", fo=t)
# Iterate over all directories.
# Probe specific fields of Tar archives.
for d in fs._all_dirnames(archive_data.keys()):
lhs = fs.info(d)
del lhs["chksum"]
expected = {
"name": f"{d}",
"size": 0,
"type": "directory",
"devmajor": 0,
"devminor": 0,
"gname": "",
"linkname": "",
"uid": 0,
"gid": 0,
"mode": 420,
"mtime": 0,
"uname": "",
}
assert lhs == expected
# Iterate over all files.
for f in archive_data:
lhs = fs.info(f)
# Probe some specific fields of Tar archives.
assert "mode" in lhs
assert "uid" in lhs
assert "gid" in lhs
assert "mtime" in lhs
assert "chksum" in lhs
@pytest.mark.parametrize(
"recipe",
[
{"mode": "w", "suffix": ".tar", "magic": b"a\x00\x00\x00\x00"},
{"mode": "w:gz", "suffix": ".tar.gz", "magic": b"\x1f\x8b\x08\x08"},
{"mode": "w:bz2", "suffix": ".tar.bz2", "magic": b"BZh91AY"},
{"mode": "w:xz", "suffix": ".tar.xz", "magic": b"\xfd7zXZ\x00\x00"},
],
ids=["tar", "tar-gz", "tar-bz2", "tar-xz"],
)
def test_compressions(recipe):
"""
Run tests on all available tar file compression variants.
"""
with temptar(archive_data, mode=recipe["mode"], suffix=recipe["suffix"]) as t:
fs = fsspec.filesystem("tar", fo=t)
# Verify that the tar archive has the correct compression.
with open(t, "rb") as raw:
assert raw.read()[:10].startswith(recipe["magic"])
# Verify content of a sample file.
assert fs.cat("b") == b"hello"
@pytest.mark.parametrize(
"recipe",
[
{"mode": "w", "suffix": ".tar", "magic": b"a\x00\x00\x00\x00"},
{"mode": "w:gz", "suffix": ".tar.gz", "magic": b"\x1f\x8b\x08\x08"},
{"mode": "w:bz2", "suffix": ".tar.bz2", "magic": b"BZh91AY"},
{"mode": "w:xz", "suffix": ".tar.xz", "magic": b"\xfd7zXZ\x00\x00"},
],
ids=["tar", "tar-gz", "tar-bz2", "tar-xz"],
)
def test_filesystem_direct(recipe, tmpdir):
"""
Run tests through a real fsspec filesystem implementation.
Here: `LocalFileSystem`.
"""
filename = os.path.join(tmpdir, f'temp{recipe["suffix"]}')
fs = fsspec.filesystem("file")
f = OpenFile(fs, filename, mode="wb")
with temptar(archive_data, mode=recipe["mode"], suffix=recipe["suffix"]) as tf:
with f as fo:
fo.write(open(tf, "rb").read())
# Verify that the tar archive has the correct compression.
with open(filename, "rb") as raw:
assert raw.read()[:10].startswith(recipe["magic"])
# Verify content of a sample file.
with fs.open(filename) as resource:
tarfs = fsspec.filesystem("tar", fo=resource)
assert tarfs.cat("b") == b"hello"
@pytest.mark.parametrize(
"recipe",
[
{"mode": "w", "suffix": ".tar", "magic": b"a\x00\x00\x00\x00"},
{"mode": "w:gz", "suffix": ".tar.gz", "magic": b"\x1f\x8b\x08\x08"},
{"mode": "w:bz2", "suffix": ".tar.bz2", "magic": b"BZh91AY"},
{"mode": "w:xz", "suffix": ".tar.xz", "magic": b"\xfd7zXZ\x00\x00"},
],
ids=["tar", "tar-gz", "tar-bz2", "tar-xz"],
)
def test_filesystem_cached(recipe, tmpdir):
"""
Run tests through a real, cached, fsspec filesystem implementation.
Here: `TarFileSystem` over `WholeFileCacheFileSystem` over `LocalFileSystem`.
"""
filename = os.path.join(tmpdir, f'temp{recipe["suffix"]}')
# Create a filesystem from test fixture.
fs = fsspec.filesystem("file")
f = OpenFile(fs, filename, mode="wb")
with temptar(archive_data, mode=recipe["mode"], suffix=recipe["suffix"]) as tf:
with f as fo:
fo.write(open(tf, "rb").read())
# Verify that the tar archive has the correct compression.
with open(filename, "rb") as raw:
assert raw.read()[:10].startswith(recipe["magic"])
# Access cached filesystem.
cachedir = tempfile.mkdtemp()
filesystem = WholeFileCacheFileSystem(fs=fs, cache_storage=cachedir)
# Verify the cache is empty beforehand.
assert os.listdir(cachedir) == []
# Verify content of a sample file.
with filesystem.open(filename) as resource:
tarfs = fsspec.filesystem("tar", fo=resource)
assert tarfs.cat("b") == b"hello"
# Verify the cache is populated afterwards.
assert len(os.listdir(cachedir)) == 2
# Verify that the cache is empty after clearing it.
filesystem.clear_cache()
assert os.listdir(cachedir) == []
filesystem.clear_cache()
shutil.rmtree(cachedir)
@pytest.mark.parametrize(
"recipe",
[
{"mode": "w", "suffix": ".tar", "magic": b"a\x00\x00\x00\x00"},
{"mode": "w:gz", "suffix": ".tar.gz", "magic": b"\x1f\x8b\x08\x08"},
{"mode": "w:bz2", "suffix": ".tar.bz2", "magic": b"BZh91AY"},
{"mode": "w:xz", "suffix": ".tar.xz", "magic": b"\xfd7zXZ\x00\x00"},
],
ids=["tar", "tar-gz", "tar-bz2", "tar-xz"],
)
def test_url_to_fs_direct(recipe, tmpdir):
with temptar(archive_data, mode=recipe["mode"], suffix=recipe["suffix"]) as tf:
url = f"tar://inner::file://{tf}"
fs, url = fsspec.core.url_to_fs(url=url)
assert fs.cat("b") == b"hello"
@pytest.mark.parametrize(
"recipe",
[
{"mode": "w", "suffix": ".tar"},
{"mode": "w:gz", "suffix": ".tar.gz"},
{"mode": "w:bz2", "suffix": ".tar.bz2"},
{"mode": "w:xz", "suffix": ".tar.xz"},
],
ids=["tar", "tar-gz", "tar-bz2", "tar-xz"],
)
def test_url_to_fs_cached(recipe, tmpdir):
with temptar(archive_data, mode=recipe["mode"], suffix=recipe["suffix"]) as tf:
url = f"tar://inner::simplecache::file://{tf}"
# requires same_names in order to be able to guess compression from
# filename
fs, url = fsspec.core.url_to_fs(url=url, simplecache={"same_names": True})
assert fs.cat("b") == b"hello"
@pytest.mark.parametrize(
"compression", ["", "gz", "bz2", "xz"], ids=["tar", "tar-gz", "tar-bz2", "tar-xz"]
)
def test_ls_with_folders(compression: str, tmp_path: Path):
"""
Create a tar file that doesn't include the intermediate folder structure,
but make sure that the reading filesystem is still able to resolve the
intermediate folders, like the ZipFileSystem.
"""
tar_data: dict[str, bytes] = {
"a.pdf": b"Hello A!",
"b/c.pdf": b"Hello C!",
"d/e/f.pdf": b"Hello F!",
"d/g.pdf": b"Hello G!",
}
if compression:
temp_archive_file = tmp_path / f"test_tar_file.tar.{compression}"
else:
temp_archive_file = tmp_path / "test_tar_file.tar"
with open(temp_archive_file, "wb") as fd:
# We need to manually write the tarfile here, because temptar
# creates intermediate directories which is not how tars are always created
with tarfile.open(fileobj=fd, mode=f"w:{compression}") as tf:
for tar_file_path, data in tar_data.items():
content = data
info = tarfile.TarInfo(name=tar_file_path)
info.size = len(content)
tf.addfile(info, BytesIO(content))
with open(temp_archive_file, "rb") as fd:
fs = TarFileSystem(fd)
assert fs.find("/", withdirs=True) == [
"a.pdf",
"b",
"b/c.pdf",
"d",
"d/e",
"d/e/f.pdf",
"d/g.pdf",
]
|