SDK Python do App Storage

​

Client

from replit.object_storage import Client

client = Client()

​

__init__

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

• bucket_id (Optional[str]): O ID do bucket que o cliente gerencia. Quando omitido, o Client usa o bucket padrão associado ao Replit App ou Deployment.

​

copy

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

• object_name (str) - O caminho completo do objeto de origem.
• dest_object_name (str) - O caminho completo do destino do objeto.

• ObjectNotFoundError - Indica que o objeto de origem não existe no caminho especificado.

​

delete

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

• object_name (str) - O nome do objeto a ser excluído.
• ignore_not_found (bool) - Quando True, suprime o erro se o objeto não existir.

• ObjectNotFoundError - Indica que o objeto não existe.

​

download_as_bytes

def download_as_bytes(object_name: str) -> bytes

• object_name (str) - O nome do objeto a ser baixado.

• bytes - A representação bruta em bytes do conteúdo do objeto.

• ObjectNotFoundError - Indica que o objeto não existe.

​

download_as_text

def download_as_text(object_name: str) -> str

• object_name (str) - O nome do objeto de origem a ser recuperado.

• str: O conteúdo do objeto como uma string codificada em UTF-8.

• ObjectNotFoundError - Indica que o objeto não existe.

​

download_to_filename

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

• object_name (str) - O nome do objeto de origem no App Storage a ser recuperado.
• dest_filename (str) - O nome do arquivo de destino no disco local.

• ObjectNotFoundError - Indica que o objeto não existe.

​

exists

def exists(object_name: str) -> bool

• object_name (str) - O nome do objeto a ser verificado.

• bool: True se o objeto existir, False caso contrário.

​

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]) - Filtra os resultados para objetos nomeados lexicograficamente antes de end_offset. Se start_offset estiver definido, os objetos listados têm nomes entre start_offset (inclusivo) e end_offset (exclusivo).
• match_glob (Optional[str]) - Use um padrão glob para filtrar os resultados. Por exemplo: “foo*bar” corresponde a “footbar”, “foo baz bar” e “foobar”.
• max_results (Optional[int]) - O número máximo de resultados a retornar na resposta.
• prefix (Optional[str]) - Filtra os resultados para objetos cujos nomes possuem o prefixo especificado.
• start_offset (Optional[str]) - Filtra os resultados para objetos cujos nomes são lexicograficamente iguais ou posteriores a start_offset. Quando end_offset está definido, os objetos listados têm nomes entre start_offset (inclusivo) e end_offset (exclusivo).

• List(Object): Uma lista de objetos que correspondem aos parâmetros de consulta fornecidos.

​

upload_from_filename

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

• dest_object_name (str) - O nome do arquivo enviado.
• src_filename (str) - O arquivo de origem a ser enviado.

​

upload_from_bytes

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

• dest_object_name (str) - O nome do objeto a ser enviado.
• src_data (str) - Os dados em bytes a serem enviados.

​

upload_from_text

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

• dest_object_name (str) - O nome do objeto a ser enviado.
• src_data (str) - Os dados de texto a serem enviados.

​

Tipos de exceção

• Ao interagir com o Replit App Storage usando o Client, qualquer método pode retornar um dos seguintes erros:
  • BucketNotFoundError: Indica que o nome do bucket configurado não corresponde a nenhum bucket no App Storage.
  • DefaultBucketError: Indica ausência de configuração de bucket padrão.
  • ForbiddenError: Indica permissões insuficientes para acessar o bucket.
  • TooManyRequestsError: Indica que a operação está sendo limitada por excesso de requisições.
  • UnauthorizedError: Indica que a autorização restringiu o acesso à operação.

​

Exemplos de métodos de classe

​

Recuperar um arquivo como texto

client.download_as_text("file.json")

​

Recuperar os bytes brutos de um arquivo

client.download_as_bytes("file.png")

​

Baixar um arquivo para o sistema de arquivos local

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

​

Listar objetos no bucket

client.list()

​

Fazer upload de um arquivo a partir de texto

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

​

Fazer upload de um arquivo como bytes

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

​

Fazer upload de objetos a partir do sistema de arquivos

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

​

Excluir um objeto do bucket

client.delete("file.json")