Stay organized with collections
Save and categorize content based on your preferences.
Source code for google.appengine.api.blobstore.blob_storage
#!/usr/bin/env python
#
# Copyright 2007 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Definition of BlobStorage base class."""
[docs]class BlobStorage(object):
"""Base class for defining how blobs are stored.
This base class merely defines an interface that all stub blob-storage
mechanisms must implement.
"""
[docs] def StoreBlob(self, blob_key, blob_stream):
"""Store blob stream.
Implement this method to persist blob data.
Args:
blob_key: Blob key of blob to store.
blob_stream: Stream or stream-like object that will generate blob content.
"""
raise NotImplementedError('Storage class must override StoreBlob method.')
[docs] def OpenBlob(self, blob_key):
"""Open blob for streaming.
Args:
blob_key: Blob-key of existing blob to open for reading.
Returns:
Open file stream for reading blob. Caller is responsible for closing file.
"""
raise NotImplementedError('Storage class must override OpenBlob method.')
[docs] def DeleteBlob(self, blob_key):
"""Delete blob data from storage.
Args:
blob_key: Blob-key of existing blob to delete.
"""
raise NotImplementedError('Storage class must override DeleteBlob method.')
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-16 UTC."],[[["This code defines the `BlobStorage` base class, which serves as an interface for implementing various blob-storage mechanisms."],["The `StoreBlob` method is designed to persist blob data, requiring a blob key and a stream-like object containing the blob's content."],["The `OpenBlob` method facilitates the reading of an existing blob by providing an open file stream, which the caller is responsible for closing."],["The `DeleteBlob` method is used to remove blob data from storage, based on the provided blob key."],["All three methods, `StoreBlob`, `OpenBlob`, and `DeleteBlob`, must be overridden by any storage class that inherits from the `BlobStorage` base class."]]],[]]