samredai commented on code in PR #5332: URL: https://github.com/apache/iceberg/pull/5332#discussion_r957511655
########## python/pyiceberg/io/fsspec.py: ########## @@ -0,0 +1,211 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +"""FileIO implementation for reading and writing table files that uses fsspec compatible filesystems""" + +from typing import Dict, Union +from urllib.parse import urlparse + +from fsspec import AbstractFileSystem + +from pyiceberg.io import FileIO, InputFile, OutputFile +from pyiceberg.typedef import Properties + + +def _s3(properties: Properties, **fs_properties) -> AbstractFileSystem: + from s3fs import S3FileSystem + + client_kwargs = { + "endpoint_url": properties.get("s3.endpoint"), + "aws_access_key_id": properties.get("s3.access-key-id"), + "aws_secret_access_key": properties.get("s3.secret-access-key"), + } + + return S3FileSystem(client_kwargs=client_kwargs, **fs_properties) + + +SCHEME_TO_FS = { + "s3": _s3, + "s3a": _s3, + "s3n": _s3, +} + + +class FsspecInputFile(InputFile): + """An input file implementation for the FsspecFileIO + + Args: + location(str): A URI to a file location + _fs(AbstractFileSystem): An fsspec filesystem instance + """ + + def __init__(self, location: str, fs: AbstractFileSystem): + self._fs = fs + super().__init__(location=location) + + def __len__(self) -> int: + """Returns the total length of the file, in bytes""" + object_info = self._fs.info(self.location) + if size := object_info.get("Size"): + return size + elif size := object_info.get("size"): + return size + raise RuntimeError(f"Cannot retrieve object info: {self.location}") + + def exists(self) -> bool: + """Checks whether the location exists""" + return self._fs.lexists(self.location) + + def open(self): + """Create an input stream for reading the contents of the file + + Returns: + OpenFile: An fsspec compliant file-like object + """ + return self._fs.open(self.location, "rb") + + +class FsspecOutputFile(OutputFile): + """An output file implementation for the FsspecFileIO + + Args: + location(str): A URI to a file location + fs: An fsspec filesystem instance + """ + + def __init__(self, location: str, fs): + self._fs = fs + super().__init__(location=location) + + def __len__(self) -> int: + """Returns the total length of the file, in bytes""" + object_info = self._fs.info(self.location) + if size := object_info.get("Size"): + return size + elif size := object_info.get("size"): + return size + raise RuntimeError(f"Cannot retrieve object info: {self.location}") + + def exists(self) -> bool: + """Checks whether the location exists""" + return self._fs.lexists(self.location) + + def create(self, overwrite: bool = False): + """Create an output stream for reading the contents of the file + + Args: + overwrite(bool): Whether to overwrite the file if it already exists + + Returns: + OpenFile: An fsspec compliant file-like object + + Raises: + FileExistsError: If the file already exists at the location and overwrite is set to False + + Note: + If overwrite is set to False, a check is first performed to verify that the file does not exist. + This is not thread-safe and a possibility does exist that the file can be created by a concurrent + process after the existence check yet before the output stream is created. In such a case, the default + behavior will truncate the contents of the existing file when opening the output stream. + """ + if not overwrite and self.exists(): + raise FileExistsError(f"Cannot create file, file already exists: {self.location}") + return self._fs.open(self.location, "wb") + + def to_input_file(self) -> FsspecInputFile: + """Returns a new FsspecInputFile for the location at `self.location`""" + return FsspecInputFile(location=self.location, fs=self._fs) + + +class FsspecFileIO(FileIO): + """A FileIO implementation that uses fsspec""" + + def __init__(self, properties: Properties): + self._scheme_to_fs = {} + self._scheme_to_fs.update(SCHEME_TO_FS) + self._fs_cache: Dict[str, AbstractFileSystem] = {} + super().__init__(properties=properties) + + def new_input(self, location: str) -> FsspecInputFile: + """Get an FsspecInputFile instance to read bytes from the file at the given location + + Args: + location(str): A URI or a path to a local file + + Returns: + FsspecInputFile: An FsspecInputFile instance for the given location + """ + uri = urlparse(location) + + if uri.scheme not in self._scheme_to_fs: + raise ValueError(f"No registered filesystem for scheme: {uri.scheme}") + + if cached_fs := self._fs_cache.get(uri.scheme): Review Comment: Bugbear flagged this with: > B019: Use of functools.lru_cache or functools.cache on methods can lead to memory leaks. The cache may retain instance references, preventing garbage collection. The solution I used was to just initialize a cache in the class init and add the instance method to it. This localizes the cache so that it's destroyed with the instance. ```py self.get_fs: Callable = lru_cache(self._get_fs) ``` Let me know what you think. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
