# -*- coding: utf-8 -*-
"""
Google Cloud Storage pythonic interface
"""
import asyncio
import fsspec
import io
import json
import logging
import os
import posixpath
import re
import warnings
import weakref
from fsspec.asyn import sync_wrapper, sync, AsyncFileSystem
from fsspec.utils import stringify_path, setup_logging
from fsspec.callbacks import NoOpCallback
from fsspec.implementations.http import get_client
from .retry import retry_request, validate_response
from .checkers import get_consistency_checker
from .credentials import GoogleCredentials
from . import __version__ as version
from urllib.parse import quote as quote_urllib
from urllib.parse import parse_qs, urlsplit
logger = logging.getLogger("gcsfs")
if "GCSFS_DEBUG" in os.environ:
setup_logging(logger=logger, level=os.environ["GCSFS_DEBUG"])
# client created 2018-01-16
ACLs = {
"authenticatedread",
"bucketownerfullcontrol",
"bucketownerread",
"private",
"projectprivate",
"publicread",
}
bACLs = {
"authenticatedRead",
"private",
"projectPrivate",
"publicRead",
"publicReadWrite",
}
DEFAULT_PROJECT = os.environ.get("GCSFS_DEFAULT_PROJECT", "")
GCS_MIN_BLOCK_SIZE = 2**18
GCS_MAX_BLOCK_SIZE = 2**28
DEFAULT_BLOCK_SIZE = 5 * 2**20
SUPPORTED_FIXED_KEY_METADATA = {
"content_encoding": "contentEncoding",
"cache_control": "cacheControl",
"content_disposition": "contentDisposition",
"content_language": "contentLanguage",
"custom_time": "customTime",
}
def quote(s):
"""
Quote characters to be safe for URL paths.
Also quotes '/'.
Parameters
----------
s: input URL/portion
Returns
-------
corrected URL
"""
# Encode everything, including slashes
return quote_urllib(s, safe="")
def norm_path(path):
"""
Canonicalize path to '{bucket}/{name}' form.
Used by petastorm, do not remove.
"""
bucket, name, _ = GCSFileSystem._split_path(path)
return "/".join((bucket, name))
async def _req_to_text(r):
async with r:
return (await r.read()).decode()
def _location():
"""
Resolves GCS HTTP location as http[s]://host
Enables storage emulation for integration tests.
Returns
-------
valid http location
"""
_emulator_location = os.environ.get("STORAGE_EMULATOR_HOST", None)
return (
_emulator_location if _emulator_location else "https://storage.googleapis.com"
)
def _chunks(lst, n):
"""
Yield evenly-sized chunks from a list.
Implementation based on https://stackoverflow.com/a/312464.
"""
for i in range(0, len(lst), n):
yield lst[i : i + n]
def _coalesce_generation(*args):
"""Helper to coalesce a list of object generations down to one."""
generations = set(args)
if None in generations:
generations.remove(None)
if len(generations) > 1:
raise ValueError(
"Cannot coalesce generations where more than one are defined,"
" {}".format(generations)
)
elif len(generations) == 0:
return None
else:
return generations.pop()
[docs]class GCSFileSystem(AsyncFileSystem):
r"""
Connect to Google Cloud Storage.
The following modes of authentication are supported:
- ``token=None``, GCSFS will attempt to guess your credentials in the
following order: gcloud CLI default, gcsfs cached token, google compute
metadata service, anonymous.
- ``token='google_default'``, your default gcloud credentials will be used,
which are typically established by doing ``gcloud login`` in a terminal.
- ``token=='cache'``, credentials from previously successful gcsfs
authentication will be used (use this after "browser" auth succeeded)
- ``token='anon'``, no authentication is performed, and you can only
access data which is accessible to allUsers (in this case, the project and
access level parameters are meaningless)
- ``token='browser'``, you get an access code with which you can
authenticate via a specially provided URL
- if ``token='cloud'``, we assume we are running within google compute
or google container engine, and query the internal metadata directly for
a token.
- you may supply a token generated by the
[gcloud](https://cloud.google.com/sdk/docs/)
utility; this is either a python dictionary, the name of a file
containing the JSON returned by logging in with the gcloud CLI tool,
or a Credentials object. gcloud typically stores its tokens in locations
such as
``~/.config/gcloud/application_default_credentials.json``,
`` ~/.config/gcloud/credentials``, or
``~\AppData\Roaming\gcloud\credentials``, etc.
Specific methods, (eg. `ls`, `info`, ...) may return object details from GCS.
These detailed listings include the
[object resource](https://cloud.google.com/storage/docs/json_api/v1/objects#resource)
GCS *does not* include "directory" objects but instead generates
directories by splitting
[object names](https://cloud.google.com/storage/docs/key-terms).
This means that, for example,
a directory does not need to exist for an object to be created within it.
Creating an object implicitly creates it's parent directories, and removing
all objects from a directory implicitly deletes the empty directory.
`GCSFileSystem` generates listing entries for these implied directories in
listing apis with the object properties:
- "name" : string
The "{bucket}/{name}" path of the dir, used in calls to
GCSFileSystem or GCSFile.
- "bucket" : string
The name of the bucket containing this object.
- "kind" : 'storage#object'
- "size" : 0
- "storageClass" : 'DIRECTORY'
- type: 'directory' (fsspec compat)
GCSFileSystem maintains a per-implied-directory cache of object listings and
fulfills all object information and listing requests from cache. This implied, for example, that objects
created via other processes *will not* be visible to the GCSFileSystem until the cache
refreshed. Calls to GCSFileSystem.open and calls to GCSFile are not effected by this cache.
In the default case the cache is never expired. This may be controlled via the `cache_timeout`
GCSFileSystem parameter or via explicit calls to `GCSFileSystem.invalidate_cache`.
Parameters
----------
project : string
project_id to work under. Note that this is not the same as, but often
very similar to, the project name.
This is required in order
to list all the buckets you have access to within a project and to
create/delete buckets, or update their access policies.
If ``token='google_default'``, the value is overridden by the default,
if ``token='anon'``, the value is ignored.
access : one of {'read_only', 'read_write', 'full_control'}
Full control implies read/write as well as modifying metadata,
e.g., access control.
token: None, dict or string
(see description of authentication methods, above)
consistency: 'none', 'size', 'md5'
Check method when writing files. Can be overridden in open().
cache_timeout: float, seconds
Cache expiration time in seconds for object metadata cache.
Set cache_timeout <= 0 for no caching, None for no cache expiration.
secure_serialize: bool (deprecated)
requester_pays : bool, or str default False
Whether to use requester-pays requests. This will include your
project ID `project` in requests as the `userPorject`, and you'll be
billed for accessing data from requester-pays buckets. Optionally,
pass a project-id here as a string to use that as the `userProject`.
session_kwargs: dict
passed on to aiohttp.ClientSession; can contain, for example,
proxy settings.
endpoint_url: str
If given, use this URL (format protocol://host:port , *without* any
path part) for communication. If not given, defaults to the value
of environment variable "STORAGE_EMULATOR_HOST"; if that is not set
either, will use the standard Google endpoint.
default_location: str
Default location where buckets are created, like 'US' or 'EUROPE-WEST3'.
You can find a list of all available locations here:
https://cloud.google.com/storage/docs/locations#available-locations
version_aware: bool
Whether to support object versioning. If enabled this will require the
user to have the necessary permissions for dealing with versioned objects.
"""
scopes = {"read_only", "read_write", "full_control"}
retries = 6 # number of retries on http failure
default_block_size = DEFAULT_BLOCK_SIZE
protocol = "gcs", "gs"
async_impl = True
def __init__(
self,
project=DEFAULT_PROJECT,
access="full_control",
token=None,
block_size=None,
consistency="none",
cache_timeout=None,
secure_serialize=True,
check_connection=None,
requests_timeout=None,
requester_pays=False,
asynchronous=False,
session_kwargs=None,
loop=None,
timeout=None,
endpoint_url=None,
default_location=None,
version_aware=False,
**kwargs,
):
super().__init__(
self,
listings_expiry_time=cache_timeout,
asynchronous=asynchronous,
loop=loop,
**kwargs,
)
if access not in self.scopes:
raise ValueError("access must be one of {}", self.scopes)
if project is None:
warnings.warn("GCS project not set - cannot list or create buckets")
if block_size is not None:
self.default_block_size = block_size
self.requester_pays = requester_pays
self.consistency = consistency
self.cache_timeout = cache_timeout or kwargs.pop("listings_expiry_time", None)
self.requests_timeout = requests_timeout
self.timeout = timeout
self._session = None
self._endpoint = endpoint_url
self.session_kwargs = session_kwargs or {}
self.default_location = default_location
self.version_aware = version_aware
if check_connection:
warnings.warn(
"The `check_connection` argument is deprecated and will be removed in a future release.",
DeprecationWarning,
)
self.credentials = GoogleCredentials(project, access, token)
if not self.asynchronous:
self._session = sync(
self.loop, get_client, timeout=self.timeout, **self.session_kwargs
)
weakref.finalize(self, self.close_session, self.loop, self._session)
@property
def _location(self):
return self._endpoint or _location()
@property
def base(self):
return f"{self._location}/storage/v1/"
@property
def project(self):
return self.credentials.project
@staticmethod
def close_session(loop, session):
if loop is not None and session is not None:
if loop.is_running():
try:
sync(loop, session.close, timeout=0.1)
except fsspec.FSTimeoutError:
pass
else:
pass
async def _set_session(self):
if self._session is None:
self._session = await get_client(**self.session_kwargs)
return self._session
@property
def session(self):
if self.asynchronous and self._session is None:
raise RuntimeError("Please await _connect* before anything else")
return self._session
@classmethod
def _strip_protocol(cls, path):
if isinstance(path, list):
return [cls._strip_protocol(p) for p in path]
path = stringify_path(path)
protos = (cls.protocol,) if isinstance(cls.protocol, str) else cls.protocol
for protocol in protos:
if path.startswith(protocol + "://"):
path = path[len(protocol) + 3 :]
elif path.startswith(protocol + "::"):
path = path[len(protocol) + 2 :]
# use of root_marker to make minimum required path, e.g., "/"
return path or cls.root_marker
@classmethod
def _get_kwargs_from_urls(cls, path):
_, _, generation = cls._split_path(path, version_aware=True)
if generation is not None:
return {"version_aware": True}
return {}
def _get_params(self, kwargs):
params = {k: v for k, v in kwargs.items() if v is not None}
# needed for requester pays buckets
if self.requester_pays:
if isinstance(self.requester_pays, str):
user_project = self.requester_pays
else:
user_project = self.project
params["userProject"] = user_project
return params
def _get_headers(self, headers):
out = {}
if headers is not None:
out.update(headers)
if "User-Agent" not in out:
out["User-Agent"] = "python-gcsfs/" + version
self.credentials.apply(out)
return out
def _format_path(self, path, args):
if not path.startswith("http"):
path = self.base + path
if args:
path = path.format(*[quote(p) for p in args])
return path
@retry_request(retries=retries)
async def _request(
self, method, path, *args, headers=None, json=None, data=None, **kwargs
):
await self._set_session()
async with self.session.request(
method=method,
url=self._format_path(path, args),
params=self._get_params(kwargs),
json=json,
headers=self._get_headers(headers),
data=data,
timeout=self.requests_timeout,
) as r:
status = r.status
headers = r.headers
info = r.request_info # for debug only
contents = await r.read()
validate_response(status, contents, path, args)
return status, headers, info, contents
async def _call(
self, method, path, *args, json_out=False, info_out=False, **kwargs
):
logger.debug(f"{method.upper()}: {path}, {args}, {kwargs.get('headers')}")
status, headers, info, contents = await self._request(
method, path, *args, **kwargs
)
if json_out:
return json.loads(contents)
elif info_out:
return info
else:
return headers, contents
call = sync_wrapper(_call)
@property
def buckets(self):
"""Return list of available project buckets."""
return [
b["name"] for b in sync(self.loop, self._list_buckets, timeout=self.timeout)
]
def _process_object(self, bucket, object_metadata):
"""Process object resource into gcsfs object information format.
Process GCS object resource via type casting and attribute updates to
the cache-able gcsfs object information format. Returns an updated copy
of the object resource.
(See https://cloud.google.com/storage/docs/json_api/v1/objects#resource)
"""
result = dict(object_metadata)
result["size"] = int(object_metadata.get("size", 0))
result["name"] = posixpath.join(bucket, object_metadata["name"])
result["type"] = "file"
if "generation" in object_metadata or "metageneration" in object_metadata:
result["generation"] = object_metadata.get("generation")
result["metageneration"] = object_metadata.get("metageneration")
return result
async def _make_bucket_requester_pays(self, path, state=True):
# this is really some form of setACL/chmod
# perhaps should be automatic if gcs.requester_pays
json = {"billing": {"requesterPays": state}}
await self._call("PATCH", f"b/{path}", json=json)
make_bucket_requester_pays = sync_wrapper(_make_bucket_requester_pays)
async def _get_object(self, path):
"""Return object information at the given path."""
bucket, key, generation = self.split_path(path)
# Check if parent dir is in listing cache
listing = self._ls_from_cache(path)
if listing:
name = "/".join((bucket, key))
for file_details in listing:
if (
file_details["type"] == "file"
and file_details["name"] == name
and (not generation or file_details.get("generation") == generation)
):
return file_details
else:
raise FileNotFoundError(path)
if not key:
# Attempt to "get" the bucket root, return error instead of
# listing.
raise FileNotFoundError(path)
res = None
# Work around various permission settings. Prefer an object get (storage.objects.get), but
# fall back to a bucket list + filter to object name (storage.objects.list).
try:
res = await self._call(
"GET", "b/{}/o/{}", bucket, key, json_out=True, generation=generation
)
except OSError as e:
if not str(e).startswith("Forbidden"):
raise
resp = await self._call(
"GET",
"b/{}/o",
bucket,
json_out=True,
prefix=key,
maxResults=1 if not generation else None,
versions="true" if generation else None,
)
for item in resp.get("items", []):
if item["name"] == key and (
not generation or item.get("generation") == generation
):
res = item
break
if res is None:
raise FileNotFoundError(path)
return self._process_object(bucket, res)
async def _list_objects(self, path, prefix="", versions=False):
bucket, key, generation = self.split_path(path)
path = path.rstrip("/")
try:
clisting = self._ls_from_cache(path)
hassubdirs = clisting and any(
c["name"].rstrip("/") == path and c["type"] == "directory"
for c in clisting
)
if clisting and not hassubdirs:
return clisting
except FileNotFoundError:
# not finding a bucket in list of "my" buckets is OK
if key:
raise
items, prefixes = await self._do_list_objects(
path, prefix=prefix, versions=versions
)
pseudodirs = [
{
"bucket": bucket,
"name": bucket + "/" + prefix.strip("/"),
"size": 0,
"storageClass": "DIRECTORY",
"type": "directory",
}
for prefix in prefixes
]
if not (items + pseudodirs):
if key:
return [await self._get_object(path)]
else:
return []
out = pseudodirs + items
# Don't cache prefixed/partial listings
if not prefix:
self.dircache[path] = out
return out
async def _do_list_objects(
self, path, max_results=None, delimiter="/", prefix="", versions=False
):
"""Object listing for the given {bucket}/{prefix}/ path."""
bucket, _path, generation = self.split_path(path)
_path = "" if not _path else _path.rstrip("/") + "/"
prefix = f"{_path}{prefix}" or None
prefixes = []
items = []
page = await self._call(
"GET",
"b/{}/o",
bucket,
delimiter=delimiter,
prefix=prefix,
maxResults=max_results,
json_out=True,
versions="true" if versions or generation else None,
)
prefixes.extend(page.get("prefixes", []))
items.extend(page.get("items", []))
next_page_token = page.get("nextPageToken", None)
while next_page_token is not None:
page = await self._call(
"GET",
"b/{}/o",
bucket,
delimiter=delimiter,
prefix=prefix,
maxResults=max_results,
pageToken=next_page_token,
json_out=True,
versions="true" if generation else None,
)
assert page["kind"] == "storage#objects"
prefixes.extend(page.get("prefixes", []))
items.extend(page.get("items", []))
next_page_token = page.get("nextPageToken", None)
items = [self._process_object(bucket, i) for i in items]
return items, prefixes
async def _list_buckets(self):
"""Return list of all buckets under the current project."""
if "" not in self.dircache:
items = []
page = await self._call("GET", "b", project=self.project, json_out=True)
assert page["kind"] == "storage#buckets"
items.extend(page.get("items", []))
next_page_token = page.get("nextPageToken", None)
while next_page_token is not None:
page = await self._call(
"GET",
"b",
project=self.project,
pageToken=next_page_token,
json_out=True,
)
assert page["kind"] == "storage#buckets"
items.extend(page.get("items", []))
next_page_token = page.get("nextPageToken", None)
buckets = [
{**i, "name": i["name"] + "/", "size": 0, "type": "directory"}
for i in items
]
self.dircache[""] = buckets
return buckets
return self.dircache[""]
[docs] def invalidate_cache(self, path=None):
"""
Invalidate listing cache for given path, it is reloaded on next use.
Parameters
----------
path: string or None
If None, clear all listings cached else listings at or under given
path.
"""
if path is None:
logger.debug("invalidate_cache clearing cache")
self.dircache.clear()
else:
path = self._strip_protocol(path).rstrip("/")
while path:
self.dircache.pop(path, None)
path = self._parent(path)
async def _mkdir(
self,
path,
acl="projectPrivate",
default_acl="bucketOwnerFullControl",
location=None,
create_parents=True,
enable_versioning=False,
**kwargs,
):
"""
New bucket
If path is more than just a bucket, will create bucket if create_parents=True;
otherwise is a noop. If create_parents is False and bucket does not exist,
will produce FileNotFFoundError.
Parameters
----------
path: str
bucket name. If contains '/' (i.e., looks like subdir), will
have no effect because GCS doesn't have real directories.
acl: string, one of bACLs
access for the bucket itself
default_acl: str, one of ACLs
default ACL for objects created in this bucket
location: Optional[str]
Location where buckets are created, like 'US' or 'EUROPE-WEST3'.
If not provided, defaults to `self.default_location`.
You can find a list of all available locations here:
https://cloud.google.com/storage/docs/locations#available-locations
create_parents: bool
If True, creates the bucket in question, if it doesn't already exist
enable_versioning: bool
If True, creates the bucket in question with object versioning
enabled.
"""
bucket, object, generation = self.split_path(path)
if bucket in ["", "/"]:
raise ValueError("Cannot create root bucket")
if "/" in path and create_parents and await self._exists(bucket):
# nothing to do
return
if "/" in path and not create_parents:
if await self._exists(bucket):
return
raise FileNotFoundError(bucket)
json_data = {"name": bucket}
location = location or self.default_location
if location:
json_data["location"] = location
if enable_versioning:
json_data["versioning"] = {"enabled": True}
await self._call(
method="POST",
path="b",
predefinedAcl=acl,
project=self.project,
predefinedDefaultObjectAcl=default_acl,
json=json_data,
json_out=True,
)
self.invalidate_cache(bucket)
mkdir = sync_wrapper(_mkdir)
async def _rmdir(self, bucket):
"""Delete an empty bucket
Parameters
----------
bucket: str
bucket name. If contains '/' (i.e., looks like subdir), will
have no effect because GCS doesn't have real directories.
"""
bucket = bucket.rstrip("/")
if "/" in bucket:
return
await self._call("DELETE", "b/" + bucket, json_out=False)
self.invalidate_cache(bucket)
self.invalidate_cache("")
rmdir = sync_wrapper(_rmdir)
async def _info(self, path, generation=None, **kwargs):
"""File information about this path."""
path = self._strip_protocol(path)
if "/" not in path:
try:
out = await self._call("GET", f"b/{path}", json_out=True)
out.update(size=0, type="directory")
except OSError:
# GET bucket failed, try ls; will have no metadata
exists = await self._ls(path)
if exists:
out = {"name": path, "size": 0, "type": "directory"}
else:
raise FileNotFoundError(path)
return out
# Check directory cache for parent dir
parent_path = self._parent(path)
parent_cache = self._ls_from_cache(parent_path)
bucket, key, path_generation = self.split_path(path)
generation = _coalesce_generation(generation, path_generation)
if parent_cache:
name = "/".join((bucket, key))
for o in parent_cache:
if o["name"].rstrip("/") == name and (
not generation or o.get("generation") == generation
):
return o
if self._ls_from_cache(path):
# this is a directory
return {
"bucket": bucket,
"name": path.rstrip("/"),
"size": 0,
"storageClass": "DIRECTORY",
"type": "directory",
}
# Check exact file path
try:
exact = await self._get_object(path)
# this condition finds a "placeholder" - still need to check if it's a directory
if exact["size"] or not exact["name"].endswith("/"):
return exact
except FileNotFoundError:
pass
kwargs["detail"] = True # Force to true for info
out = await self._ls(path, **kwargs)
out0 = [o for o in out if o["name"].rstrip("/") == path]
if out0:
# exact hit
return out0[0]
elif out:
# other stuff - must be a directory
return {
"bucket": bucket,
"name": path.rstrip("/"),
"size": 0,
"storageClass": "DIRECTORY",
"type": "directory",
}
else:
raise FileNotFoundError(path)
async def _glob(self, path, prefix="", **kwargs):
if not prefix:
# Identify pattern prefixes. Ripped from fsspec.spec.AbstractFileSystem.glob and matches
# the glob.has_magic patterns.
indstar = path.find("*") if path.find("*") >= 0 else len(path)
indques = path.find("?") if path.find("?") >= 0 else len(path)
indbrace = path.find("[") if path.find("[") >= 0 else len(path)
ind = min(indstar, indques, indbrace)
prefix = path[:ind].split("/")[-1]
return await super()._glob(path, prefix=prefix, **kwargs)
async def _ls(self, path, detail=False, prefix="", versions=False, **kwargs):
"""List objects under the given '/{bucket}/{prefix} path."""
path = self._strip_protocol(path).rstrip("/")
if path in ["/", ""]:
out = await self._list_buckets()
else:
out = []
for entry in await self._list_objects(
path, prefix=prefix, versions=versions
):
if versions:
out.append(
{
**entry,
"name": f"{entry['name']}#{entry['generation']}",
}
)
else:
out.append(entry)
if detail:
return out
else:
return sorted([o["name"] for o in out])
[docs] def url(self, path):
"""Get HTTP URL of the given path"""
u = "{}/download/storage/v1/b/{}/o/{}?alt=media{}"
bucket, object, generation = self.split_path(path)
object = quote(object)
return u.format(
self._location,
bucket,
object,
"&generation={}".format(generation) if generation else "",
)
async def _cat_file(self, path, start=None, end=None, **kwargs):
"""Simple one-shot get of file data"""
u2 = self.url(path)
if start or end:
head = {"Range": await self._process_limits(path, start, end)}
else:
head = {}
headers, out = await self._call("GET", u2, headers=head)
return out
async def _getxattr(self, path, attr):
"""Get user-defined metadata attribute"""
meta = (await self._info(path)).get("metadata", {})
return meta[attr]
getxattr = sync_wrapper(_getxattr)
async def _setxattrs(
self,
path,
content_type=None,
content_encoding=None,
fixed_key_metadata=None,
**kwargs,
):
"""Set/delete/add writable metadata attributes
Note: uses PATCH method (update), leaving unedited keys alone.
fake-gcs-server:latest does not seem to support this.
Parameters
---------
content_type: str
If not None, set the content-type to this value
content_encoding: str
This parameter is deprecated, you may use fixed_key_metadata instead.
If not None, set the content-encoding.
See https://cloud.google.com/storage/docs/transcoding
fixed_key_metadata: dict
Google metadata, in key/value pairs, supported keys:
- cache_control
- content_disposition
- content_encoding
- content_language
- custom_time
More info:
https://cloud.google.com/storage/docs/metadata#mutable
kw_args: key-value pairs like field="value" or field=None
value must be string to add or modify, or None to delete
Returns
-------
Entire metadata after update (even if only path is passed)
"""
i_json = {"metadata": kwargs}
if content_type is not None:
i_json["contentType"] = content_type
if content_encoding is not None:
logger.warn(
"setxattrs: content_encoding parameter is now deprecated "
"you may use `fixed_key_metadata` instead"
)
i_json["contentEncoding"] = content_encoding
i_json.update(_convert_fixed_key_metadata(fixed_key_metadata))
bucket, key, generation = self.split_path(path)
o_json = await self._call(
"PATCH",
"b/{}/o/{}",
bucket,
key,
fields="metadata",
json=i_json,
json_out=True,
)
return o_json.get("metadata", {})
setxattrs = sync_wrapper(_setxattrs)
async def _merge(self, path, paths, acl=None):
"""Concatenate objects within a single bucket"""
bucket, key, generation = self.split_path(path)
source = [{"name": self.split_path(p)[1]} for p in paths]
await self._call(
"POST",
"b/{}/o/{}/compose",
bucket,
key,
destinationPredefinedAcl=acl,
headers={"Content-Type": "application/json"},
json={
"sourceObjects": source,
"kind": "storage#composeRequest",
"destination": {"name": key, "bucket": bucket},
},
)
merge = sync_wrapper(_merge)
async def _cp_file(self, path1, path2, acl=None, **kwargs):
"""Duplicate remote file"""
b1, k1, g1 = self.split_path(path1)
b2, k2, g2 = self.split_path(path2)
if g2:
raise ValueError("Cannot write to specific object generation")
out = await self._call(
"POST",
"b/{}/o/{}/rewriteTo/b/{}/o/{}",
b1,
k1,
b2,
k2,
headers={"Content-Type": "application/json"},
destinationPredefinedAcl=acl,
json_out=True,
sourceGeneration=g1,
)
while out["done"] is not True:
out = await self._call(
"POST",
"b/{}/o/{}/rewriteTo/b/{}/o/{}",
b1,
k1,
b2,
k2,
headers={"Content-Type": "application/json"},
rewriteToken=out["rewriteToken"],
destinationPredefinedAcl=acl,
json_out=True,
sourceGeneration=g1,
)
async def _rm_file(self, path, **kwargs):
bucket, key, generation = self.split_path(path)
if key:
await self._call("DELETE", "b/{}/o/{}", bucket, key, generation=generation)
self.invalidate_cache(posixpath.dirname(self._strip_protocol(path)))
else:
await self._rmdir(path)
async def _rm_files(self, paths):
template = (
"\n--===============7330845974216740156==\n"
"Content-Type: application/http\n"
"Content-Transfer-Encoding: binary\n"
"Content-ID: <b29c5de2-0db4-490b-b421-6a51b598bd11+{i}>"
"\n\nDELETE /storage/v1/b/{bucket}/o/{key}{query} HTTP/1.1\n"
"Content-Type: application/json\n"
"accept: application/json\ncontent-length: 0\n"
)
errors = []
# Splitting requests into 100 chunk batches
# See https://cloud.google.com/storage/docs/batch
for chunk in _chunks(paths, 100):
parts = []
for i, p in enumerate(chunk):
bucket, key, generation = self.split_path(p)
query = f"?generation={generation}" if generation else ""
parts.append(
template.format(
i=i + 1,
bucket=quote(bucket),
key=quote(key),
query=query,
)
)
body = "".join(parts)
headers, content = await self._call(
"POST",
f"{self._location}/batch/storage/v1",
headers={
"Content-Type": 'multipart/mixed; boundary="=========='
'=====7330845974216740156=="'
},
data=body + "\n--===============7330845974216740156==--",
)
boundary = headers["Content-Type"].split("=", 1)[1]
parents = [self._parent(p) for p in paths]
[self.invalidate_cache(parent) for parent in parents + list(paths)]
txt = content.decode()
if any(
not ("200 OK" in c or "204 No Content" in c)
for c in txt.split(boundary)[1:-1]
):
pattern = '"message": "([^"]+)"'
out = set(re.findall(pattern, txt))
errors.extend(out)
if errors:
raise OSError(errors)
@property
def on_google(self):
return "torage.googleapis.com" in self._location
async def _rm(self, path, recursive=False, maxdepth=None, batchsize=20):
paths = await self._expand_path(path, recursive=recursive, maxdepth=maxdepth)
files = [p for p in paths if self.split_path(p)[1]]
dirs = [p for p in paths if not self.split_path(p)[1]]
if self.on_google:
# emulators do not support batch
exs = await asyncio.gather(
*(
[
self._rm_files(files[i : i + batchsize])
for i in range(0, len(files), batchsize)
]
),
return_exceptions=True,
)
else:
exs = await asyncio.gather(
*([self._rm_file(f) for f in files]),
return_exceptions=True,
)
exs = [
ex
for ex in exs
if ex is not None
and "No such object" not in str(ex)
and not isinstance(ex, FileNotFoundError)
]
if exs:
raise exs[0]
await asyncio.gather(*[self._rmdir(d) for d in dirs])
rm = sync_wrapper(_rm)
async def _pipe_file(
self,
path,
data,
metadata=None,
consistency=None,
content_type="application/octet-stream",
chunksize=50 * 2**20,
):
# enforce blocksize should be a multiple of 2**18
consistency = consistency or self.consistency
bucket, key, generation = self.split_path(path)
size = len(data)
out = None
if size < 5 * 2**20:
location = await simple_upload(
self, bucket, key, data, metadata, consistency, content_type
)
else:
location = await initiate_upload(self, bucket, key, content_type, metadata)
for offset in range(0, len(data), chunksize):
bit = data[offset : offset + chunksize]
out = await upload_chunk(
self, location, bit, offset, size, content_type
)
checker = get_consistency_checker(consistency)
checker.update(data)
checker.validate_json_response(out)
self.invalidate_cache(self._parent(path))
return location
async def _put_file(
self,
lpath,
rpath,
metadata=None,
consistency=None,
content_type="application/octet-stream",
chunksize=50 * 2**20,
callback=None,
**kwargs,
):
# enforce blocksize should be a multiple of 2**18
if os.path.isdir(lpath):
return
callback = callback or NoOpCallback()
consistency = consistency or self.consistency
checker = get_consistency_checker(consistency)
bucket, key, generation = self.split_path(rpath)
if generation:
raise ValueError("Cannot write to specific object generation")
with open(lpath, "rb") as f0:
size = f0.seek(0, 2)
f0.seek(0)
callback.set_size(size)
if size < 5 * 2**20:
await simple_upload(
self,
bucket,
key,
f0.read(),
consistency=consistency,
metadatain=metadata,
content_type=content_type,
)
callback.absolute_update(size)
else:
location = await initiate_upload(
self, bucket, key, content_type, metadata
)
offset = 0
while True:
bit = f0.read(chunksize)
if not bit:
break
out = await upload_chunk(
self, location, bit, offset, size, content_type
)
offset += len(bit)
callback.absolute_update(offset)
checker.update(bit)
checker.validate_json_response(out)
self.invalidate_cache(self._parent(rpath))
async def _isdir(self, path):
try:
return (await self._info(path))["type"] == "directory"
except IOError:
return False
async def _find(
self, path, withdirs=False, detail=False, prefix="", versions=False, **kwargs
):
path = self._strip_protocol(path)
bucket, key, generation = self.split_path(path)
if prefix:
_path = "" if not key else key.rstrip("/") + "/"
_prefix = f"{_path}{prefix}"
else:
_prefix = key
objects, _ = await self._do_list_objects(
bucket, delimiter="", prefix=_prefix, versions=versions
)
dirs = {}
cache_entries = {}
for obj in objects:
parent = self._parent(obj["name"])
previous = obj
while parent:
dir_key = self.split_path(parent)[1]
if not dir_key or len(parent) < len(path):
break
dirs[parent] = {
"Key": dir_key,
"Size": 0,
"name": parent,
"StorageClass": "DIRECTORY",
"type": "directory",
"size": 0,
}
cache_entries.setdefault(parent, []).append(previous)
previous = dirs[parent]
parent = self._parent(parent)
if not prefix:
self.dircache.update(cache_entries)
if withdirs:
objects = sorted(objects + list(dirs.values()), key=lambda x: x["name"])
if detail:
if versions:
return {f"{o['name']}#{o['generation']}": o for o in objects}
return {o["name"]: o for o in objects}
if versions:
return [f"{o['name']}#{o['generation']}" for o in objects]
return [o["name"] for o in objects]
@retry_request(retries=retries)
async def _get_file_request(
self, rpath, lpath, *args, headers=None, callback=None, **kwargs
):
consistency = kwargs.pop("consistency", self.consistency)
async with self.session.get(
url=rpath,
params=self._get_params(kwargs),
headers=self._get_headers(headers),
timeout=self.requests_timeout,
) as r:
r.raise_for_status()
try:
size = int(r.headers["content-length"])
except (KeyError, ValueError):
size = None
callback.set_size(size)
checker = get_consistency_checker(consistency)
os.makedirs(os.path.dirname(lpath), exist_ok=True)
with open(lpath, "wb") as f2:
while True:
data = await r.content.read(4096 * 32)
if not data:
break
f2.write(data)
checker.update(data)
callback.relative_update(len(data))
validate_response(r.status, data, rpath) # validate http request
checker.validate_http_response(r) # validate file consistency
return r.status, r.headers, r.request_info, data
async def _get_file(self, rpath, lpath, callback=None, **kwargs):
u2 = self.url(rpath)
if os.path.isdir(lpath):
return
callback = callback or NoOpCallback()
await self._get_file_request(u2, lpath, callback=callback, **kwargs)
def _open(
self,
path,
mode="rb",
block_size=None,
cache_options=None,
acl=None,
consistency=None,
metadata=None,
autocommit=True,
fixed_key_metadata=None,
generation=None,
**kwargs,
):
"""
See ``GCSFile``.
consistency: None or str
If None, use default for this instance
"""
if block_size is None:
block_size = self.default_block_size
const = consistency or self.consistency
return GCSFile(
self,
path,
mode,
block_size,
cache_options=cache_options,
consistency=const,
metadata=metadata,
acl=acl,
autocommit=autocommit,
fixed_key_metadata=fixed_key_metadata,
**kwargs,
)
@classmethod
def _split_path(cls, path, version_aware=False):
"""
Normalise GCS path string into bucket and key.
Parameters
----------
path : string
Input path, like `gcs://mybucket/path/to/file`.
Path is of the form: '[gs|gcs://]bucket[/key][?querystring][#fragment]'
GCS allows object generation (object version) to be specified in either
the URL fragment or the `generation` query parameter. When provided,
the fragment will take priority over the `generation` query paramenter.
Returns
-------
(bucket, key, generation) tuple
"""
path = cls._strip_protocol(path).lstrip("/")
if "/" not in path:
return path, "", None
bucket, keypart = path.split("/", 1)
key = keypart
generation = None
if version_aware:
parts = urlsplit(keypart)
try:
if parts.fragment:
generation = parts.fragment
elif parts.query:
parsed = parse_qs(parts.query)
if "generation" in parsed:
generation = parsed["generation"][0]
# Sanity check whether this could be a valid generation ID. If
# it is not, assume that # or ? characters are supposed to be
# part of the object name.
if generation is not None:
int(generation)
key = parts.path
except ValueError:
generation = None
return (
bucket,
key,
generation,
)
def split_path(self, path):
return self._split_path(path, version_aware=self.version_aware)
[docs] def sign(self, path, expiration=100, **kwargs):
"""Create a signed URL representing the given path.
Parameters
----------
path : str
The path on the filesystem
expiration : int
Number of seconds to enable the URL for
Returns
-------
URL : str
The signed URL
"""
from google.cloud import storage
bucket, key = self.split_path(path)
client = storage.Client(
credentials=self.credentials.credentials, project=self.project
)
bucket = client.bucket(bucket)
blob = bucket.blob(key)
return blob.generate_signed_url(expiration=expiration, **kwargs)
GoogleCredentials.load_tokens()
[docs]class GCSFile(fsspec.spec.AbstractBufferedFile):
def __init__(
self,
gcsfs,
path,
mode="rb",
block_size=DEFAULT_BLOCK_SIZE,
autocommit=True,
cache_type="readahead",
cache_options=None,
acl=None,
consistency="md5",
metadata=None,
content_type=None,
timeout=None,
fixed_key_metadata=None,
generation=None,
**kwargs,
):
"""
Open a file.
Parameters
----------
gcsfs: instance of GCSFileSystem
path: str
location in GCS, like 'bucket/path/to/file'
mode: str
Normal file modes. Currently only 'wb' amd 'rb'.
block_size: int
Buffer size for reading or writing
acl: str
ACL to apply, if any, one of ``ACLs``. New files are normally
"bucketownerfullcontrol", but a default can be configured per
bucket.
consistency: str, 'none', 'size', 'md5', 'crc32c'
Check for success in writing, applied at file close.
'size' ensures that the number of bytes reported by GCS matches
the number we wrote; 'md5' does a full checksum. Any value other
than 'size' or 'md5' or 'crc32c' is assumed to mean no checking.
content_type: str
default is `application/octet-stream`. See the list of available
content types at https://www.iana.org/assignments/media-types/media-types.txt
metadata: dict
Custom metadata, in key/value pairs, added at file creation
fixed_key_metadata: dict
Google metadata, in key/value pairs, supported keys:
- cache_control
- content_disposition
- content_encoding
- content_language
- custom_time
More info:
https://cloud.google.com/storage/docs/metadata#mutable
timeout: int
Timeout seconds for the asynchronous callback.
generation: str
Object generation.
"""
bucket, key, path_generation = gcsfs.split_path(path)
if not key:
raise OSError("Attempt to open a bucket")
self.generation = _coalesce_generation(generation, path_generation)
super().__init__(
gcsfs,
path,
mode,
block_size,
autocommit=autocommit,
cache_type=cache_type,
cache_options=cache_options,
**kwargs,
)
self.gcsfs = gcsfs
self.bucket = bucket
self.key = key
self.acl = acl
self.checker = get_consistency_checker(consistency)
if "r" in self.mode:
det = self.details
else:
det = {}
self.content_type = content_type or det.get(
"contentType", "application/octet-stream"
)
self.metadata = metadata or det.get("metadata", {})
self.fixed_key_metadata = _convert_fixed_key_metadata(det, from_google=True)
self.fixed_key_metadata.update(fixed_key_metadata or {})
self.timeout = timeout
if mode == "wb":
if self.blocksize < GCS_MIN_BLOCK_SIZE:
warnings.warn("Setting block size to minimum value, 2**18")
self.blocksize = GCS_MIN_BLOCK_SIZE
self.location = None
@property
def details(self):
if self._details is None:
self._details = self.fs.info(self.path, generation=self.generation)
return self._details
[docs] def info(self):
"""File information about this path"""
return self.details
[docs] def url(self):
"""HTTP link to this file's data"""
return self.fs.url(self.path)
def _upload_chunk(self, final=False):
"""Write one part of a multi-block file upload
Parameters
----------
final: bool
Complete and commit upload
"""
while True:
# shortfall splits blocks bigger than max allowed upload
data = self.buffer.getvalue()
head = {}
l = len(data)
if (l < GCS_MIN_BLOCK_SIZE) and not final:
# either flush() was called, but we don't have enough to
# push, or we split a big upload, and have less left than one
# block. If this is the final part, OK to violate those
# terms.
return False
# Select the biggest possible chunk of data to be uploaded
chunk_length = min(l, GCS_MAX_BLOCK_SIZE)
chunk = data[:chunk_length]
if final and self.autocommit and chunk_length == l:
if l:
# last chunk
head["Content-Range"] = "bytes %i-%i/%i" % (
self.offset,
self.offset + chunk_length - 1,
self.offset + l,
)
else:
# closing when buffer is empty
head["Content-Range"] = "bytes */%i" % self.offset
data = None
else:
head["Content-Range"] = "bytes %i-%i/*" % (
self.offset,
self.offset + chunk_length - 1,
)
head.update(
{"Content-Type": self.content_type, "Content-Length": str(chunk_length)}
)
headers, contents = self.gcsfs.call(
"POST", self.location, headers=head, data=chunk
)
if "Range" in headers:
end = int(headers["Range"].split("-")[1])
shortfall = (self.offset + l - 1) - end
if shortfall > 0:
self.checker.update(data[:-shortfall])
self.buffer = io.BytesIO(data[-shortfall:])
self.buffer.seek(shortfall)
self.offset += l - shortfall
continue
else:
self.checker.update(data)
else:
assert final, "Response looks like upload is over"
if l:
j = json.loads(contents)
self.checker.update(data)
self.checker.validate_json_response(j)
# Clear buffer and update offset when all is received
self.buffer = io.BytesIO()
self.offset += l
break
return True
[docs] def commit(self):
"""If not auto-committing, finalize file"""
self.autocommit = True
self._upload_chunk(final=True)
def _initiate_upload(self):
"""Create multi-upload"""
self.location = sync(
self.gcsfs.loop,
initiate_upload,
self.gcsfs,
self.bucket,
self.key,
self.content_type,
self.metadata,
self.fixed_key_metadata,
timeout=self.timeout,
)
[docs] def discard(self):
"""Cancel in-progress multi-upload
Should only happen during discarding this write-mode file
"""
if self.location is None:
return
uid = re.findall("upload_id=([^&=?]+)", self.location)
self.gcsfs.call(
"DELETE",
f"{self.fs._location}/upload/storage/v1/b/{quote(self.bucket)}/o",
params={"uploadType": "resumable", "upload_id": uid},
json_out=True,
)
def _simple_upload(self):
"""One-shot upload, less than 5MB"""
self.buffer.seek(0)
data = self.buffer.read()
sync(
self.gcsfs.loop,
simple_upload,
self.gcsfs,
self.bucket,
self.key,
data,
self.metadata,
self.consistency,
self.content_type,
self.fixed_key_metadata,
timeout=self.timeout,
)
def _fetch_range(self, start=None, end=None):
"""Get data from GCS
start, end : None or integers
if not both None, fetch only given range
"""
try:
return self.gcsfs.cat_file(self.path, start=start, end=end)
except RuntimeError as e:
if "not satisfiable" in str(e):
return b""
raise
def _convert_fixed_key_metadata(metadata, *, from_google=False):
"""
Convert fixed_key_metadata to/from GCS format.
Google uses camelCase for its parameters, this function transform
exposed fixed_key_metadata (snake_case) to or from GCS(google) format
Parameters
----------
metadata: dict
A key value pair of fixed_key_metadata, key can be either
camel case or snake case.
from_google: bool
True means that the metadata come from google and thus should be converted
to snake_case
"""
out = {}
if metadata is None:
return out
for key, attribute_name in SUPPORTED_FIXED_KEY_METADATA.items():
src = key if not from_google else attribute_name
dst = attribute_name if not from_google else key
if src in metadata:
out[dst] = metadata[src]
return out
async def upload_chunk(fs, location, data, offset, size, content_type):
head = {}
l = len(data)
range = "bytes %i-%i/%i" % (offset, offset + l - 1, size)
head["Content-Range"] = range
head.update({"Content-Type": content_type, "Content-Length": str(l)})
headers, txt = await fs._call("POST", location, headers=head, data=data)
if "Range" in headers:
end = int(headers["Range"].split("-")[1])
shortfall = (offset + l - 1) - end
if shortfall:
return await upload_chunk(
fs, location, data[-shortfall:], end, size, content_type
)
return json.loads(txt) if txt else None
async def initiate_upload(
fs,
bucket,
key,
content_type="application/octet-stream",
metadata=None,
fixed_key_metadata=None,
):
j = {"name": key}
if metadata:
j["metadata"] = metadata
j.update(_convert_fixed_key_metadata(fixed_key_metadata))
headers, _ = await fs._call(
method="POST",
path=f"{fs._location}/upload/storage/v1/b/{quote(bucket)}/o",
uploadType="resumable",
json=j,
headers={"X-Upload-Content-Type": content_type},
)
loc = headers["Location"]
out = loc[0] if isinstance(loc, list) else loc # <- for CVR responses
if len(str(loc)) < 20:
logger.error("Location failed: %s" % headers)
return out
async def simple_upload(
fs,
bucket,
key,
datain,
metadatain=None,
consistency=None,
content_type="application/octet-stream",
fixed_key_metadata=None,
):
checker = get_consistency_checker(consistency)
path = f"{fs._location}/upload/storage/v1/b/{quote(bucket)}/o"
metadata = {"name": key}
if metadatain is not None:
metadata["metadata"] = metadatain
metadata.update(_convert_fixed_key_metadata(fixed_key_metadata))
metadata = json.dumps(metadata)
template = (
"--==0=="
"\nContent-Type: application/json; charset=UTF-8"
"\n\n"
+ metadata
+ "\n--==0=="
+ "\nContent-Type: {0}".format(content_type)
+ "\n\n"
)
data = template.encode() + datain + b"\n--==0==--"
j = await fs._call(
"POST",
path,
uploadType="multipart",
headers={"Content-Type": 'multipart/related; boundary="==0=="'},
data=data,
json_out=True,
)
checker.update(datain)
checker.validate_json_response(j)