specify environment variable for download headers as a JSON formatted set of values

brentpicasso · brentpicasso · commit 5e14116bf09c · 2024-10-20T16:00:15.000-07:00
diff --git a/doc/source/recipes.rst b/doc/source/recipes.rst
@@ -66,10 +66,16 @@ Specifying the URL
           download_headers property.
 
 For example, when downloading from a private github repository, you can specify the following:
+
+(For the download_headers property in your recipe)
 ```
 [('Authorization', 'token <your personal access token>'), ('Accept', 'application/vnd.github+json')]
 ```
 
+(For the DOWNLOAD_HEADERS_my-package-name environment variable - specify as a JSON formatted set of values)
+```
+    [["Authorization","token <your personal access token>"],["Accept", "application/vnd.github+json"]]
+```
 The actual build process takes place via three core methods::
 
       def prebuild_arch(self, arch):
diff --git a/pythonforandroid/recipe.py b/pythonforandroid/recipe.py
@@ -1,7 +1,7 @@
 from os.path import basename, dirname, exists, isdir, isfile, join, realpath, split
 import glob
-
 import hashlib
+import json
 from re import match
 
 import sh
@@ -64,7 +64,10 @@ class Recipe(metaclass=RecipeMeta):
     for authorization purposes.
 
     Specified as an array of tuples:
-    [("header name", "header value")]
+    [("header1", "foo"), ("header2", "bar")]
+
+    When specifying as an environment variable (DOWNLOAD_HEADER_my-package-name), use a JSON formatted fragement:
+    [["header1","foo"],["header2", "bar"]]
 
     For example, when downloading from a private
     github repository, you can specify the following:
@@ -185,6 +188,13 @@ def versioned_url(self):
     @property
     def download_headers(self):
         key = "DOWNLOAD_HEADERS_" + self.name
+        env_headers = environ.get(key)
+        if env_headers:
+            try:
+                return [tuple(h) for h in json.loads(env_headers)]
+            except Exception as ex:
+                raise ValueError(f'Invalid Download headers for {key} - must be JSON formatted as [["header1","foo"],["header2","bar"]]: {ex}')
+
         return environ.get(key, self._download_headers)
 
     def download_file(self, url, target, cwd=None):
