SDK Python pour App Storage

​

Client

from replit.object_storage import Client

client = Client()

​

__init__

def __init__(bucket_id: Optional[str] = None)

• bucket_id (Optional[str]) : L’identifiant du bucket que le client gère. Lorsqu’il est omis, le Client utilise le bucket par défaut associé à l’Application Replit ou au Déploiement.

​

copy

def copy(object_name: str, dest_object_name: str) -> None

• object_name (str) - Le chemin complet de l’objet source.
• dest_object_name (str) - Le chemin complet de la destination de l’objet.

• ObjectNotFoundError - Indique que l’objet source n’existe pas au chemin spécifié.

​

delete

def delete(object_name: str, ignore_not_found: bool = False) -> None

• object_name (str) - Le nom de l’objet à supprimer.
• ignore_not_found (bool) - Lorsqu’il est True, supprime l’erreur si l’objet n’existe pas.

• ObjectNotFoundError - Indique que l’objet n’existe pas.

​

download_as_bytes

def download_as_bytes(object_name: str) -> bytes

• object_name (str) - Le nom de l’objet à télécharger.

• bytes - La représentation en octets bruts du contenu de l’objet.

• ObjectNotFoundError - Indique que l’objet n’existe pas.

​

download_as_text

def download_as_text(object_name: str) -> str

• object_name (str) - Le nom de l’objet source à récupérer.

• str : Le contenu de l’objet sous forme de chaîne encodée en UTF-8.

• ObjectNotFoundError - Indique que l’objet n’existe pas.

​

download_to_filename

def download_to_filename(object_name: str, dest_filename: str) -> None

• object_name (str) - Le nom de l’objet source depuis App Storage à récupérer.
• dest_filename (str) - Le nom de fichier de destination sur le disque local.

• ObjectNotFoundError - Indique que l’objet n’existe pas.

​

exists

def exists(object_name: str) -> bool

• object_name (str) - Le nom de l’objet dont l’existence doit être vérifiée.

• bool : True si l’objet existe, False sinon.

​

list

def list(end_offset: Optional[str] = None,
         match_glob: Optional[str] = None,
         max_results: Optional[int] = None,
         prefix: Optional[str] = None,
         start_offset: Optional[str] = None) -> List[Object]

• end_offset (Optional[str]) - Filtre les résultats aux objets nommés lexicographiquement avant end_offset. Si start_offset est défini, les objets listés ont des noms entre start_offset (inclus) et end_offset (exclus).
• match_glob (Optional[str]) - Utilisez un motif glob pour filtrer les résultats. Par exemple : “foo*bar” correspond à “footbar”, “foo baz bar” et “foobar”.
• max_results (Optional[int]) - Le nombre maximum de résultats à retourner dans la réponse.
• prefix (Optional[str]) - Filtre les résultats aux objets dont les noms ont le préfixe spécifié.
• start_offset (Optional[str]) - Filtre les résultats aux objets dont les noms sont lexicographiquement égaux ou postérieurs à start_offset. Lorsque end_offset est défini, les objets listés ont des noms entre start_offset (inclus) et end_offset (exclus).

• List(Object) : Une liste d’objets correspondant aux paramètres de requête donnés.

​

upload_from_filename

def upload_from_filename(dest_object_name: str, src_filename: str) -> None

• dest_object_name (str) - Le nom du fichier téléversé.
• src_filename (str) - Le fichier source à téléverser.

​

upload_from_bytes

def upload_from_bytes(dest_object_name: str, src_data: bytes) -> None

• dest_object_name (str) - Le nom de l’objet à téléverser.
• src_data (str) - Les données bytes à téléverser.

​

upload_from_text

def upload_from_text(dest_object_name: str, src_data: Union[bytes, str]) -> None

• dest_object_name (str) - Le nom de l’objet à téléverser.
• src_data (str) - Les données textuelles à téléverser.

​

Types d’exceptions

• Lors de l’interaction avec Replit App Storage en utilisant le Client, toute méthode peut retourner l’une des erreurs suivantes :
  • BucketNotFoundError : Indique que le nom de bucket configuré ne correspond à aucun bucket dans App Storage.
  • DefaultBucketError : Indique l’absence de configuration de bucket par défaut.
  • ForbiddenError : Indique des permissions insuffisantes pour accéder au bucket.
  • TooManyRequestsError : Indique que l’opération est limitée en débit en raison de trop nombreuses requêtes.
  • UnauthorizedError : Indique que l’autorisation a restreint l’accès à l’opération.

​

Exemples de méthodes de classe

​

Récupérer un fichier en texte

client.download_as_text("file.json")

​

Récupérer les octets bruts d’un fichier

client.download_as_bytes("file.png")

​

Télécharger un fichier vers le système de fichiers local

client.download_to_filename("file.json", dest_filename)

​

Lister les objets dans le bucket

client.list()

​

Téléverser un fichier depuis du texte

client.upload_from_text("file.json", data)

​

Téléverser un fichier en octets

client.upload_from_bytes("file.png", data)

​

Téléverser des objets depuis le système de fichiers

client.upload_from_filename("file.json", src_filename)

​

Supprimer un objet du bucket

client.delete("file.json")