Skip to content

Storage

Storage

Google Cloud Storage

Source code in breathecode/services/google_cloud/storage.py 
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
class Storage:
    """Google Cloud Storage"""

    client: storage.Client

    def __init__(self) -> None:
        credentials.resolve_credentials()
        self.client = self._get_client()

    @circuit
    def _get_client(self) -> storage.Client:
        """Get Google Cloud Storage client

        Returns:
            storage.Client: Google Cloud Storage client
        """
        return storage.Client()

    def file(self, bucket_name: str, file_name: str) -> File:
        """Get File object

        Args:
            bucket_name (str): Name of bucket in Google Cloud Storage
            file_name (str): Name of blob in Google Cloud Bucket

        Returns:
            File: File object
        """
        bucket = self.client.bucket(bucket_name)
        return File(bucket, file_name)

    def generate_download_signed_url(self, bucket_name: str, file_name: str, expiration_hours: int = 1) -> str:
        """Generate a signed URL for downloading a file

        Args:
            bucket_name (str): Name of bucket in Google Cloud Storage
            file_name (str): Name of blob in Google Cloud Bucket
            expiration_hours (int): Hours until the URL expires (default: 1, max: 24)

        Returns:
            str: Signed URL for downloading the file
        """
        from datetime import timedelta

        expiration_hours = min(expiration_hours, 24)  # Max 24 hours
        cloud_file = self.file(bucket_name, file_name)
        return cloud_file.generate_signed_url(expiration=timedelta(hours=expiration_hours))

file(bucket_name, file_name)

Get File object

Parameters:

Name Type Description Default
bucket_name str

Name of bucket in Google Cloud Storage

 required
file_name str

Name of blob in Google Cloud Bucket

 required

Returns:

Name Type Description
File File

File object
Source code in breathecode/services/google_cloud/storage.py 
30
31
32
33
34
35
36
37
38
39
40
41
def file(self, bucket_name: str, file_name: str) -> File:
    """Get File object

    Args:
        bucket_name (str): Name of bucket in Google Cloud Storage
        file_name (str): Name of blob in Google Cloud Bucket

    Returns:
        File: File object
    """
    bucket = self.client.bucket(bucket_name)
    return File(bucket, file_name)

generate_download_signed_url(bucket_name, file_name, expiration_hours=1)

Generate a signed URL for downloading a file

Parameters:

Name Type Description Default
bucket_name str

Name of bucket in Google Cloud Storage

 required
file_name str

Name of blob in Google Cloud Bucket

 required
expiration_hours int

Hours until the URL expires (default: 1, max: 24)

 1

Returns:

Name Type Description
str str

Signed URL for downloading the file
Source code in breathecode/services/google_cloud/storage.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def generate_download_signed_url(self, bucket_name: str, file_name: str, expiration_hours: int = 1) -> str:
    """Generate a signed URL for downloading a file

    Args:
        bucket_name (str): Name of bucket in Google Cloud Storage
        file_name (str): Name of blob in Google Cloud Bucket
        expiration_hours (int): Hours until the URL expires (default: 1, max: 24)

    Returns:
        str: Signed URL for downloading the file
    """
    from datetime import timedelta

    expiration_hours = min(expiration_hours, 24)  # Max 24 hours
    cloud_file = self.file(bucket_name, file_name)
    return cloud_file.generate_signed_url(expiration=timedelta(hours=expiration_hours))