Merge pull request #17 from octue/feature/add-object-metadata

Add content object metadata and custom time by default

Author: thclark

.devcontainer/devcontainer.json

@@ -15,6 +15,7 @@
     "esbonio.sphinx.confDir": "${workspaceFolder}/docs/source",
     "jupyter.widgetScriptSources": ["jsdelivr.com", "unpkg.com"],
     "prettier.prettierPath": "/usr/local/prettier",
+    "python.defaultInterpreterPath": "/usr/local/bin/python",
     "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
     "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
     "python.formatting.provider": "black",

django_gcp/events/utils.py

@@ -60,6 +60,7 @@ def make_pubsub_message(
     https://stackoverflow.com/questions/73477187/why-do-gcp-pub-sub-messages-have-duplicated-message-id-and-publish-time-values
 
     :param Union[dict, list] data: JSON-serialisable data to form the body of the message
+    :param str subscription: a subscription path which indicates the subscription that caused this message to be delivered, eg 'projects/my-project/subscriptions/my-subscription-name'
     :param Union[dict, None] attributes: Dict of attributes to attach to the message. Contents must be flat, containing only string keys with string values.
     :param Union[str, None] message_id: An optional id for the message.
     :param Union[str, None] ordering_key: A string used to order messages.

django_gcp/storage/gcloud.py

@@ -155,14 +155,24 @@ def _open(self, name, mode="rb"):
         return file_object
 
     def _save(self, name, content):
+
+        # # cleaned_name = clean_name(name)
+        # # name = self._normalize_name(cleaned_name)
+        # # content.name = cleaned_name
+        # # file = GoogleCloudFile(name, "rw", self)
+        # file.blob.upload_from_file(
+        #     content, rewind=True, size=content.size, content_type=file.mime_type, predefined_acl=self.default_acl
+        # )
+        # return cleaned_name
+
         cleaned_name = clean_name(name)
         name = self._normalize_name(cleaned_name)
 
         content.name = cleaned_name
         file_object = GoogleCloudFile(name, "rw", self)
 
         upload_params = {}
-        blob_params = self.get_object_parameters(name)
+        blob_params = self.get_object_parameters(content)
         upload_params["predefined_acl"] = blob_params.pop("acl", self.settings.default_acl)
         upload_params[CONTENT_TYPE] = blob_params.pop(CONTENT_TYPE, file_object.mime_type)
 
@@ -180,12 +190,26 @@ def _save(self, name, content):
         file_object.blob.upload_from_file(content, rewind=True, size=getattr(content, "size", None), **upload_params)
         return cleaned_name
 
-    def get_object_parameters(self, name):
-        """Override this to return a dictionary of overwritable blob-property to value.
+    def get_object_parameters(self, content):
+        """Add object-specific parameters to the uploaded blob.
+
+        Override this to return a dictionary of blob-specific parameters for the upload.
+
+        By default, this uses any object_parameters configured on the store, except:
+
+            - A `custom_time` attribute on the `content` object will override a `custom_time` property in the store settings
+            - Any `metadata` on the `content` object will be merged with any `metadata` in the store settings, with fields
+              from the `content` object taking precedence over the store metadata where duplicate fields exist.
 
-        Returns GS_OBJECT_PARAMETERS by default. See the docs for all possible options.
         """
-        return self.settings.object_parameters.copy()
+        object_parameters = self.settings.object_parameters.copy()
+        store_metadata = getattr(object_parameters, "metadata", dict())
+        store_custom_time = getattr(object_parameters, "custom_time", None)
+        object_metadata = getattr(content, "metadata", dict())
+        object_parameters["custom_time"] = getattr(content, "custom_time", store_custom_time)
+        object_parameters["metadata"] = {**store_metadata, **object_metadata}
+
+        return object_parameters
 
     def delete(self, name):
         name = self._normalize_name(clean_name(name))

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-gcp"
-version = "0.6.0"
+version = "0.7.0"
 description = "Utilities to run Django on Google Cloud Platform"
 authors = ["Tom Clark"]
 license = "MIT"