python-storage/google/cloud/storage/__init__.pyi at d7eea6e78104ce9f385d5d08ce278b761c7f7ef5 · googleapis/python-storage · GitHub

1
2
3
4
5
6
7
8
9
10
11
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# Stubs for google.cloud.storage package
# Generated minimal PEP 561 stub to improve Pylance/Pyright experience.
from __future__ import annotations

from typing import Any, Optional, MutableMapping, Sequence, Tuple

__all__ = ["__version__", "Batch", "Blob", "Bucket", "Client"]

__version__: str

class Batch:
    def __init__(self, client: "Client", raise_exception: bool = True) -> None: ...

    def finish(self, raise_exception: bool = True) -> Sequence[Tuple[Any, Any]]: ...


class Blob:
    STORAGE_CLASSES: Sequence[str]

    def __init__(
        self,
        name: str,
        bucket: "Bucket",
        chunk_size: Optional[int] = None,
        encryption_key: Optional[bytes] = None,
        kms_key_name: Optional[str] = None,
        generation: Optional[int] = None,
    ) -> None: ...

    name: str
    bucket: "Bucket"
    generation: Optional[int]

    @property
    def public_url(self) -> str: ...

    @property
    def client(self) -> "Client": ...

    def from_uri(self, uri: str) -> "Blob": ...

    def download_as_bytes(self, timeout: Optional[float] = ...) -> bytes: ...

    def upload_from_file(self, file_obj: Any, timeout: Optional[float] = ...) -> None: ...


class Bucket:
    STORAGE_CLASSES: Sequence[str]

    def __init__(
        self,
        client: "Client",
        name: str,
        user_project: Optional[str] = None,
        generation: Optional[int] = None,
    ) -> None: ...

    name: str
    client: "Client"
    user_project: Optional[str]

    def blob(self, blob_name: str, chunk_size: Optional[int] = None) -> Blob: ...

    def get_blob(self, blob_name: str, timeout: Optional[float] = ...) -> Optional[Blob]: ...

    def create(self, timeout: Optional[float] = ...) -> None: ...

    @classmethod
    def from_string(cls, uri: str, client: Optional["Client"] = ...) -> "Bucket": ...


class Client:
    SCOPE: Sequence[str]

    def __init__(
        self,
        project: Optional[str] = ...,
        credentials: Optional[Any] = ...,
        _http: Optional[Any] = ...,
        client_info: Optional[Any] = ...,
        client_options: Optional[Any] = ...,
        use_auth_w_custom_endpoint: bool = True,
        extra_headers: Optional[MutableMapping[str, str]] = ..., *, api_key: Optional[str] = ...,
    ) -> None: ...

    project: Optional[str]

    @classmethod
    def create_anonymous_client(cls) -> "Client": ...

    @property
    def universe_domain(self) -> str: ...

    @property
    def api_endpoint(self) -> str: ...

    @property
    def current_batch(self) -> Optional[Batch]: ...

    def bucket(self, bucket_name: str, user_project: Optional[str] = None, generation: Optional[int] = None) -> Bucket: ...

    def batch(self, raise_exception: bool = True) -> Batch: ...

    def get_service_account_email(self, project: Optional[str] = None, timeout: Optional[float] = ..., retry: Optional[Any] = ...) -> str: ...