Recognise COMMITTED status (#88)

This is an interim release

Fix py3.9 deprecated method open_binary()

AB#9188

Author: eccles

archivist_samples/c2pa/c2pa.py

@@ -2,7 +2,11 @@
 # pylint:disable=missing-module-docstring      # docstrings
 # pylint:disable=missing-class-docstring      # docstrings
 
-from importlib import resources
+try:
+    # Python < 3.9
+    import importlib_resources as res
+except ImportError:
+    import importlib.resources as res
 
 import logging
 
@@ -23,7 +27,9 @@
 
 
 def upload_attachment(arch, attachment_description: AttachmentDescription):
-    with resources.open_binary(c2pa_files, attachment_description.filename) as fd:
+    with res.files(c2pa_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         blob = arch.attachments.upload(fd)
         attachment = {
             # sample-specific attr to relay attachment name
@@ -38,7 +44,9 @@ def upload_attachment(arch, attachment_description: AttachmentDescription):
 
 
 def attachment_create(arch, attachment_description: AttachmentDescription):
-    with resources.open_binary(c2pa_files, attachment_description.filename) as fd:
+    with res.files(c2pa_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         attachment = arch.attachments.upload(fd)
         result = {
             "arc_attribute_type": "arc_attachment",

archivist_samples/document/document.py

@@ -2,7 +2,11 @@
 # pylint:disable=missing-module-docstring      # docstrings
 # pylint:disable=missing-class-docstring      # docstrings
 
-from importlib import resources
+try:
+    # Python < 3.9
+    import importlib_resources as res
+except ImportError:
+    import importlib.resources as res
 
 import logging
 
@@ -23,7 +27,9 @@
 
 
 def upload_attachment(arch, attachment_description: AttachmentDescription):
-    with resources.open_binary(document_files, attachment_description.filename) as fd:
+    with res.files(document_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         blob = arch.attachments.upload(fd)
         attachment = {
             # sample-specific attr to relay attachment name
@@ -38,7 +44,9 @@ def upload_attachment(arch, attachment_description: AttachmentDescription):
 
 
 def attachment_create(arch, attachment_description: AttachmentDescription):
-    with resources.open_binary(document_files, attachment_description.filename) as fd:
+    with res.files(document_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         attachment = arch.attachments.upload(fd)
         result = {
             "arc_attribute_type": "arc_attachment",

archivist_samples/door_entry/run.py

@@ -3,7 +3,11 @@
 # pylint:  disable=missing-docstring
 
 
-from importlib import resources
+try:
+    # Python < 3.9
+    import importlib_resources as res
+except ImportError:
+    import importlib.resources as res
 
 from copy import copy
 import logging
@@ -30,7 +34,9 @@
 
 
 def attachment_create(doors, attachment_description: AttachmentDescription):
-    with resources.open_binary(images_assets, attachment_description.filename) as fd:
+    with res.files(images_assets).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         attachment = doors.attachments.upload(fd)
         result = {
             "arc_attribute_type": "arc_attachment",
@@ -478,7 +484,7 @@ def open_door(doors, doorid, cards, cardid):
     # time but if the use case demands it is perfectly possible to
     # attach the same attachment ID to multiple assets/events rather
     # than duplicating them
-    with resources.open_binary(images_events, "dooropen.png") as fd:
+    with res.files(images_events).joinpath("dooropen.png").open("rb") as fd:
         image = doors.attachments.upload(fd)
 
     # Issue RecordEvidence logs on each.

archivist_samples/sample_scripts/c2pa/c2pa_verify.py

@@ -25,9 +25,10 @@
 import sample
 
 try:
-    import importlib.resources as pkg_resources
+    # Python < 3.9
+    import importlib_resources as res
 except ImportError:
-    import importlib_resources as pkg_resources
+    import importlib.resources as res
 
 
 # DataTrails Connection Parameters -- Honest Abe
@@ -72,7 +73,7 @@ def evil_arch():
 
 # Uploads attachments to DataTrails
 def upload_attachment(arch, path, name):
-    with pkg_resources.open_binary(sample, path) as fd:
+    with res.files(sample).joinpath(path).open("rb") as fd:
         blob = arch.attachments.upload(fd)
         attachment = {
             "arc_display_name": name,

archivist_samples/sbom_document/software_package.py

@@ -4,7 +4,11 @@
 # pylint:disable=unused-import      # To prevent cyclical import errors forward referencing is used
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
 
-from importlib import resources
+try:
+    # Python < 3.9
+    import importlib_resources as res
+except ImportError:
+    import importlib.resources as res
 
 import logging
 from sys import exit as sys_exit
@@ -22,7 +26,9 @@
 
 def attachment_create(arch, attachment_description: AttachmentDescription):
     LOGGER.info("sbom attachment creator: %s", attachment_description.filename)
-    with resources.open_binary(sbom_files, attachment_description.filename) as fd:
+    with res.files(sbom_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         attachment = arch.attachments.upload(fd)
         result = {
             "arc_attribute_type": "arc_attachment",

archivist_samples/software_bill_of_materials/software_package.py

@@ -4,7 +4,11 @@
 # pylint:disable=unused-import      # To prevent cyclical import errors forward referencing is used
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
 
-from importlib import resources
+try:
+    # Python < 3.9
+    import importlib_resources as res
+except ImportError:
+    import importlib.resources as res
 
 import logging
 from sys import exit as sys_exit
@@ -22,7 +26,9 @@
 
 def attachment_create(sboms, attachment_description: AttachmentDescription):
     LOGGER.info("sbom attachment creator: %s", attachment_description.filename)
-    with resources.open_binary(sbom_files, attachment_description.filename) as fd:
+    with res.files(sbom_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         attachment = sboms.attachments.upload(fd)
         result = {
             "arc_attribute_type": "arc_attachment",

archivist_samples/synsation/util.py

@@ -3,7 +3,11 @@
 
 # pylint:  disable=missing-docstring
 
-from importlib import resources
+try:
+    # Python < 3.9
+    import importlib_resources as res
+except ImportError:
+    import importlib.resources as res
 
 from yaml import full_load
 
@@ -16,14 +20,14 @@
 
 
 def asset_attachment_upload_from_file(arch, name, mtype):
-    with resources.open_binary(images_assets, name) as fd:
+    with res.files(images_assets).joinpath(name).open("rb") as fd:
         attachment = arch.attachments.upload(fd, mtype=mtype)
 
     return attachment
 
 
 def attachment_upload_from_file(arch, name, mtype):
-    with resources.open_binary(images, name) as fd:
+    with res.files(images).joinpath(name).open("rb") as fd:
         attachment = arch.attachments.upload(fd, mtype=mtype)
 
     return attachment
@@ -34,7 +38,7 @@ def locations_create_from_yaml_file(arch, name):
 
     assumes there is only one document in the file.
     """
-    with resources.open_binary(locations, name) as fd:
+    with res.files(locations).joinpath(name).open("rb") as fd:
         data = full_load(fd)
         attrs = data["attributes"]
         del data["attributes"]
@@ -46,7 +50,7 @@ def locations_from_yaml_file(name):
 
     assumes there is only one document in the file.
     """
-    with resources.open_binary(locations, name) as fd:
+    with res.files(locations).joinpath(name).open("rb") as fd:
         data = full_load(fd)
         attrs = data["attributes"]
         del data["attributes"]

archivist_samples/wipp/wipp.py

@@ -2,7 +2,11 @@
 # pylint:disable=missing-module-docstring      # docstrings
 # pylint:disable=missing-class-docstring      # docstrings
 
-from importlib import resources
+try:
+    # Python < 3.9
+    import importlib_resources as res
+except ImportError:
+    import importlib.resources as res
 
 import logging
 
@@ -22,7 +26,9 @@
 
 
 def upload_attachment(arch, attachment_description: AttachmentDescription):
-    with resources.open_binary(wipp_files, attachment_description.filename) as fd:
+    with res.files(wipp_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         blob = arch.attachments.upload(fd)
         attachment = {
             # sample-specific attr to relay attachment name
@@ -37,7 +43,9 @@ def upload_attachment(arch, attachment_description: AttachmentDescription):
 
 
 def attachment_create(arch, attachment_description: AttachmentDescription):
-    with resources.open_binary(wipp_files, attachment_description.filename) as fd:
+    with res.files(wipp_files).joinpath(attachment_description.filename).open(
+        "rb"
+    ) as fd:
         attachment = arch.attachments.upload(fd)
         result = {
             "arc_attribute_type": "arc_attachment",

requirements.txt

@@ -1,4 +1,4 @@
 cryptography~=41.0.2
-# TODO change to datatrails when released
-datatrails-archivist==0.27.1
+importlib-resources==3.0.0; python_version < '3.9'
+datatrails-archivist==0.29.0a1
 pyyaml~=6.0.1