File size: 7,976 Bytes
b386992 |
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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import fnmatch
import logging
import os
import tarfile
from typing import IO, Union
LOGGER = logging.getLogger("NeMo")
try:
from zarr.storage import BaseStore
HAVE_ZARR = True
except Exception as e:
LOGGER.warning(f"Cannot import zarr, support for zarr-based checkpoints is not available. {type(e).__name__}: {e}")
BaseStore = object
HAVE_ZARR = False
class TarPath:
"""
A class that represents a path inside a TAR archive and behaves like pathlib.Path.
Expected use is to create a TarPath for the root of the archive first, and then derive
paths to other files or directories inside the archive like so:
with TarPath('/path/to/archive.tar') as archive:
myfile = archive / 'filename.txt'
if myfile.exists():
data = myfile.read()
...
Only read and enumeration operations are supported.
"""
def __init__(self, tar: Union[str, tarfile.TarFile, 'TarPath'], *parts):
self._needs_to_close = False
self._relpath = ''
if isinstance(tar, TarPath):
self._tar = tar._tar
self._relpath = os.path.join(tar._relpath, *parts)
elif isinstance(tar, tarfile.TarFile):
self._tar = tar
if parts:
self._relpath = os.path.join(*parts)
elif isinstance(tar, str):
self._needs_to_close = True
self._tar = tarfile.open(tar, 'r')
if parts:
self._relpath = os.path.join(*parts)
else:
raise ValueError(f"Unexpected argument type for TarPath: {type(tar).__name__}")
def __del__(self):
if self._needs_to_close:
self._tar.close()
def __truediv__(self, key) -> 'TarPath':
return TarPath(self._tar, os.path.join(self._relpath, key))
def __str__(self) -> str:
return os.path.join(self._tar.name, self._relpath)
@property
def tarobject(self):
"""
Returns the wrapped tar object.
"""
return self._tar
@property
def relpath(self):
"""
Returns the relative path of the path.
"""
return self._relpath
@property
def name(self):
"""
Returns the name of the path.
"""
return os.path.split(self._relpath)[1]
@property
def suffix(self):
"""
Returns the suffix of the path.
"""
name = self.name
i = name.rfind('.')
if 0 < i < len(name) - 1:
return name[i:]
else:
return ''
def __enter__(self):
self._tar.__enter__()
return self
def __exit__(self, *args):
return self._tar.__exit__(*args)
def exists(self):
"""
Checks if the path exists.
"""
try:
self._tar.getmember(self._relpath)
return True
except KeyError:
try:
self._tar.getmember(os.path.join('.', self._relpath))
return True
except KeyError:
return False
def is_file(self):
"""
Checks if the path is a file.
"""
try:
self._tar.getmember(self._relpath).isreg()
return True
except KeyError:
try:
self._tar.getmember(os.path.join('.', self._relpath)).isreg()
return True
except KeyError:
return False
def is_dir(self):
"""
Checks if the path is a directory.
"""
try:
self._tar.getmember(self._relpath).isdir()
return True
except KeyError:
try:
self._tar.getmember(os.path.join('.', self._relpath)).isdir()
return True
except KeyError:
return False
def open(self, mode: str) -> IO[bytes]:
"""
Opens a file in the archive.
"""
if mode != 'r' and mode != 'rb':
raise NotImplementedError()
file = None
try:
# Try the relative path as-is first
file = self._tar.extractfile(self._relpath)
except KeyError:
try:
# Try the relative path with "./" prefix
file = self._tar.extractfile(os.path.join('.', self._relpath))
except KeyError:
raise FileNotFoundError()
if file is None:
raise FileNotFoundError()
return file
def glob(self, pattern):
"""
Returns an iterator over the files in the directory, matching the pattern.
"""
for member in self._tar.getmembers():
# Remove the "./" prefix, if any
name = member.name[2:] if member.name.startswith('./') else member.name
# If we're in a subdirectory, make sure the file is too, and remove that subdir component
if self._relpath:
if not name.startswith(self._relpath + '/'):
continue
name = name[len(self._relpath) + 1 :]
# See if the name matches the pattern
if fnmatch.fnmatch(name, pattern):
yield TarPath(self._tar, os.path.join(self._relpath, name))
def rglob(self, pattern):
"""
Returns an iterator over the files in the directory, including subdirectories.
"""
for member in self._tar.getmembers():
# Remove the "./" prefix, if any
name = member.name[2:] if member.name.startswith('./') else member.name
# If we're in a subdirectory, make sure the file is too, and remove that subdir component
if self._relpath:
if not name.startswith(self._relpath + '/'):
continue
name = name[len(self._relpath) + 1 :]
# See if any tail of the path matches the pattern, return full path if that's true
parts = name.split('/')
for i in range(len(parts)):
subname = '/'.join(parts[i:])
if fnmatch.fnmatch(subname, pattern):
yield TarPath(self._tar, os.path.join(self._relpath, name))
break
def iterdir(self):
"""
Returns an iterator over the files in the directory.
"""
return self.glob('*')
class ZarrPathStore(BaseStore):
"""
An implementation of read-only Store for zarr library
that works with pathlib.Path or TarPath objects.
"""
def __init__(self, tarpath: TarPath):
assert HAVE_ZARR, "Package zarr>=2.18.2,<3.0.0 is required to use ZarrPathStore"
self._path = tarpath
self._writable = False
self._erasable = False
def __getitem__(self, key):
with (self._path / key).open('rb') as file:
return file.read()
def __contains__(self, key):
return (self._path / key).is_file()
def __iter__(self):
return self.keys()
def __len__(self):
return sum(1 for _ in self.keys())
def __setitem__(self, key, value):
raise NotImplementedError()
def __delitem__(self, key):
raise NotImplementedError()
def keys(self):
"""
Returns an iterator over the keys in the store.
"""
return self._path.iterdir()
|