Skip to content

Add s3 adapter #1643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion frictionless/schemes/aws/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from .adapter import AwsAdapter as AwsAdapter
from .control import AwsControl as AwsControl
from .loaders import S3Loader as S3Loader
from .plugin import AwsPlugin as AwsPlugin
from .plugin import AwsPlugin as AwsPlugin
54 changes: 54 additions & 0 deletions frictionless/schemes/aws/adapter.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
from __future__ import annotations

import io
import json
from typing import Any, Optional
from urllib.parse import urlparse

from ... import helpers
from ...exception import FrictionlessException
from ...package import Package
from ...platform import platform
from ...system import Adapter
from .control import AwsControl


class AwsAdapter(Adapter):
def __init__(self, source: Any, *, basepath: Optional[str] = None):
self.source = source
self.basepath = basepath

# Read

def read_package(self):
normsource = helpers.join_basepath(self.source, basepath=self.basepath)
parts = urlparse(normsource, allow_fragments=False)
if parts.scheme == "s3":
control = AwsControl()
client = platform.boto3.resource("s3", endpoint_url=control.s3_endpoint_url)
object = client.Object(bucket_name=parts.netloc, key=parts.path[1:])
try:
content = object.get()["Body"].read().decode()
except client.meta.client.exceptions.NoSuchBucket:
note = f'No such bucket: "{parts.netloc}"'
raise FrictionlessException(note)
except client.meta.client.exceptions.NoSuchKey:
note = f'No such key: "{parts.path}"'
raise FrictionlessException(note)
except client.meta.client.exceptions.ClientError as exception:
note = f'AWS error: "{exception}"'
raise FrictionlessException(note)
except Exception as exception:
note = f'Cannot read package: "{exception}"'
raise FrictionlessException(note) from exception
else:
if normsource.endswith(".yaml"):
descriptor = platform.yaml.safe_load(io.StringIO(content))
else:
descriptor = json.loads(content)

basepath = normsource.rsplit("/", 1)[0]
return Package.from_descriptor(descriptor, basepath=basepath)

note = "Cannot read package"
raise FrictionlessException(note)
18 changes: 17 additions & 1 deletion frictionless/schemes/aws/plugin.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
from __future__ import annotations

from typing import TYPE_CHECKING, Optional
from typing import TYPE_CHECKING, Any, Optional
from urllib.parse import urlparse

from ...system import Plugin
from .adapter import AwsAdapter
from .control import AwsControl
from .loaders import S3Loader

if TYPE_CHECKING:
from ...dialect import Control
from ...resource import Resource
from ...system import Loader

Expand All @@ -16,6 +19,19 @@ class AwsPlugin(Plugin):

# Hooks

def create_adapter(
self,
source: Any,
*,
control: Optional[Control] = None,
basepath: Optional[str] = None,
packagify: bool = False,
):
if isinstance(source, str):
parsed = urlparse(source)
if parsed.scheme == "s3":
return AwsAdapter(source=source, basepath=basepath)

def create_loader(self, resource: Resource) -> Optional[Loader]:
if resource.scheme == "s3":
return S3Loader(resource)
Expand Down
51 changes: 51 additions & 0 deletions tests/package/test_s3.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import random
import string

import boto3
import pytest
from moto import mock_s3

from frictionless import Package

# Read


@mock_s3
def test_s3_package(bucket_name):
# Write
client = boto3.resource("s3", region_name="us-east-1")
bucket = client.create_bucket(Bucket=bucket_name, ACL="public-read") # type: ignore
bucket.put_object(
ACL="private",
Body=open("data/package.json", "rb"),
Bucket=bucket_name,
ContentType="text/json",
Key="package.json",
)

# Read
package = Package(f"s3://{bucket_name}/package.json")

assert package.name == "name"
assert package.basepath == f"s3://{bucket_name}"
assert package.to_descriptor() == {
"name": "name",
"resources": [
{
"name": "name",
"type": "table",
"path": "table.csv",
"scheme": "file",
"format": "csv",
"mediatype": "text/csv",
},
],
}


# Fixtures


@pytest.fixture
def bucket_name():
return "bucket_%s" % "".join(random.choice(string.digits) for _ in range(16))
Loading