Skip to content

media

django_spire.contrib.sync.file.media

__all__ = ['S3Store', 'Store'] module-attribute

Store

Bases: Protocol

download

Source code in django_spire/contrib/sync/file/media/base.py 
10
def download(self, key: str, target_path: Path) -> None: ...

list_keys

Source code in django_spire/contrib/sync/file/media/base.py 
11
def list_keys(self, prefix: str) -> set[str]: ...

upload

Source code in django_spire/contrib/sync/file/media/base.py 
12
def upload(self, key: str, source_path: Path, content_type: str | None = None) -> str: ...

S3Store

Bases: Store

Source code in django_spire/contrib/sync/file/media/s3.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def __init__(
    self,
    bucket: str,
    endpoint_url: str,
    region_name: str,
    access_key: str,
    secret_key: str,
    retries: int = 3,
    retry_delay: float = 1.0,
) -> None:
    self._bucket = bucket
    self._retries = retries
    self._retry_delay = retry_delay
    self._client = boto3.client(
        's3',
        endpoint_url=endpoint_url,
        region_name=region_name,
        aws_access_key_id=access_key,
        aws_secret_access_key=secret_key,
        config=Config(signature_version='s3v4'),
    )

download

Source code in django_spire/contrib/sync/file/media/s3.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def download(self, key: str, target_path: Path) -> None:
    target_path.parent.mkdir(parents=True, exist_ok=True)

    retry(
        lambda: self._client.download_file(
            self._bucket,
            key,
            str(target_path),
        ),
        attempts=self._retries,
        delay=self._retry_delay,
        exceptions=(BotoCoreError, OSError),
    )

    logger.info('Downloaded %s -> %s', key, target_path)

list_keys

Source code in django_spire/contrib/sync/file/media/s3.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def list_keys(self, prefix: str) -> set[str]:
    keys = set()
    continuation_token = None

    while True:
        kwargs = {
            'Bucket': self._bucket,
            'Prefix': prefix,
        }

        if continuation_token:
            kwargs['ContinuationToken'] = continuation_token

        response = self._client.list_objects_v2(**kwargs)

        for obj in response.get('Contents', []):
            keys.add(obj['Key'])

        if not response.get('IsTruncated'):
            break

        continuation_token = response['NextContinuationToken']

    return keys

upload

Source code in django_spire/contrib/sync/file/media/s3.py 
 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
def upload(
    self,
    key: str,
    source_path: Path,
    content_type: str | None = None,
) -> str:
    extra_args = {'ACL': 'public-read'}

    if content_type:
        extra_args['ContentType'] = content_type

    retry(
        lambda: self._client.upload_file(
            str(source_path),
            self._bucket,
            key,
            ExtraArgs=extra_args,
        ),
        attempts=self._retries,
        delay=self._retry_delay,
        exceptions=(BotoCoreError, OSError),
    )

    logger.info('Uploaded %s -> %s/%s', source_path, self._bucket, key)

    return key