Merge pull request #41 from octue/fix-empty-dict-error

Fix empty dict error

Author: thclark

.devcontainer/devcontainer.json

@@ -11,6 +11,7 @@
     "vscode": {
       "settings": {
         "austin.mode": "Wall time",
+        "black-formatter.args": ["--line-length", "120"],
         "editor.defaultFormatter": "esbenp.prettier-vscode",
         "editor.formatOnSave": true,
         "esbonio.server.enabled": true,
@@ -29,7 +30,6 @@
         "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
         "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
         "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
-        // Line length to match black settings
         // Disabling specific messages:
         //  - To find the details do: /usr/local/py-utils/bin/pylint --list-msgs
         //  - Disable missing-module-docstring (C0114) because we don't document modules routinely, just their members

.devcontainer/docker-compose.yml

@@ -1,4 +1,4 @@
-version: "3.8"
+version: '3.8'
 
 # Developers:
 #
@@ -11,9 +11,9 @@ services:
       context: ..
       dockerfile: .devcontainer/Dockerfile
       args:
-        VARIANT: "3.9"
-        INSTALL_NODE: "true"
-        NODE_VERSION: "lts/*"
+        VARIANT: '3.9'
+        INSTALL_NODE: 'true'
+        NODE_VERSION: 'lts/*'
 
     environment:
       - DATABASE_URL=postgres://postgres_user:postgres_password@localhost/postgres_db
@@ -55,7 +55,7 @@ services:
       - postgres_data:/var/lib/postgresql
     restart: unless-stopped
     healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      test: ['CMD-SHELL', 'pg_isready -U postgres']
       interval: 10s
       timeout: 5s
       retries: 5

.github/workflows/ci.yml

@@ -7,9 +7,9 @@ on:
   workflow_dispatch:
     inputs:
       debug_enabled:
-        description: "Enable tmate debug"
+        description: 'Enable tmate debug'
         type: boolean
-        default: "false"
+        default: 'false'
 
 jobs:
   check-semantic-version:
@@ -42,7 +42,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python: ["3.9", "3.10"]
+        python: ['3.9', '3.10']
         os: [ubuntu-latest] # [ubuntu-latest, windows-latest, macos-latest] for full coverage but this gets expensive quickly
     runs-on: ${{ matrix.os }}
 

django_gcp/storage/fields.py

@@ -188,15 +188,14 @@ def override_blobfield_value(self):
 
     def pre_save(self, model_instance, add):
         """Return field's value just before saving."""
-        value = getattr(model_instance, self.attname)
+        value = self._clean_blank_value(getattr(model_instance, self.attname))
 
         existing_path = None if add else self._get_existing_path(model_instance)
 
         # An escape hatch allowing you to set the path directly. This is dangerous and should only be done
         # explicitly for the purpose of data migration and manipulation. You should never allow an untrusted
         # client to set paths directly, because knowing the path of a pre-existing object allows you to assume
         # access to it. Tip: You can use django's override_settings context manager to set this temporarily.
-        # Note that you'll have to execute any on_changed
         if getattr(
             settings,
             "GCP_STORAGE_OVERRIDE_BLOBFIELD_VALUE",
@@ -209,6 +208,7 @@ def pre_save(self, model_instance, add):
             )
             new_value = value
         else:
+
             # There are six scenarios to deal with:
             adding_blank = add and value is None
             adding_valid = add and value is not None
@@ -448,6 +448,13 @@ def _check_on_change(self):
             ]
         return []
 
+    @staticmethod
+    def _clean_blank_value(value):
+        """Convert blanks values formulated as empty dicts {} to None"""
+        if value is not None and len(value) == 0:
+            value = None
+        return value
+
     def _get_allow_overwrite(self, add):
         """Return a boolean determining if overwrite should be allowed for this operation"""
         mode_map = {

pyproject.toml

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

tests/test_events_utils.py

@@ -10,9 +10,9 @@
 import json
 from datetime import datetime, timezone
 from unittest.mock import patch
+from zoneinfo import ZoneInfo
 from django.test import TestCase
 from django_gcp.events.utils import decode_pubsub_message, get_event_url, make_pubsub_message
-from zoneinfo import ZoneInfo
 
 
 DEFAULT_SUBSCRIPTION = "projects/my-project/subscriptions/my-subscription"