cleaning up converter notebooks

Author: braingram

notebooks/Your_second_ASDF_converter/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "myconverters"
+description = "TODO"
+version='0.1.0'
+requires-python = ">=3.9"
+dependencies = [
+    "asdf >=2.8",
+]
+
+[build-system]
+requires = ["setuptools >=61", "setuptools_scm[toml] >=3.4"]
+build-backend = "setuptools.build_meta"
+
+[project.entry-points."asdf.resource_mappings"]
+myschema = "myschemas.integration:get_resource_mappings"
+
+[project.entry-points."asdf.extensions"]
+myconverters = "myconverters.integration:get_extensions"

notebooks/Your_second_ASDF_converter/src/myconverters/__init__.py

@@ -0,0 +1,46 @@
+from asdf.extension import Converter
+from .photo_id import PhotoID
+from .traffic_citation import TrafficCitation
+
+
+class PhotoIDConverter(Converter):
+    tags = ["asdf://stsci.edu/example-project/tags/photo_id-*"]
+    types = ["myconverters.photo_id.PhotoID"]
+    # The above registers the tag that the converter is used for, as well as
+    # associating the class that the converter is used for.
+
+    # This method converts from the Python object to yaml
+    def to_yaml_tree(self, obj, tags, ctx):
+        # The yaml conversion expects a dictionary returned
+        node = {}
+        node['first_name'] = obj.first_name
+        node['last_name'] = obj.last_name
+        node['photo'] = obj.photo
+        return node
+
+    # This method converts from yaml to the Python object
+    def from_yaml_tree(self, node, tag, ctx):
+        return PhotoID(node['last_name'],
+                       node['first_name'],
+                       node['photo'])
+
+
+class TrafficCitationConverter(Converter):
+    tags = ["asdf://stsci.edu/example-project/tags/traffic_citation-1.0.0"]
+    types = ["myconverters.traffic_citation.TrafficCitation"]
+
+    def to_yaml_tree(self, obj, tags, ctx):
+        node = {}
+        node['ociffer'] = obj.ociffer
+        node['violation'] = obj.violation
+        node['date'] = obj.date
+        node['time'] = obj.time
+        node['photo_id'] = obj.photo_id
+        return node
+
+    def from_yaml_tree(self, node, tag, ctx):
+        return TrafficCitation(node['ociffer'],
+                               node['violation'],
+                               node['date'],
+                               node['time'],
+                               node['photo_id'])

notebooks/Your_second_ASDF_converter/src/myconverters/converters.py

@@ -0,0 +1,15 @@
+from asdf.extension import ManifestExtension
+from .converters import (
+    PhotoIDConverter,
+    TrafficCitationConverter,)
+
+MY_CONVERTERS = [
+    PhotoIDConverter(),
+    TrafficCitationConverter(),
+]
+
+MY_EXTENSIONS = [
+    ManifestExtension.from_uri(
+        "asdf://stsci.edu/example-project/manifests/allmyschemas-1.0",
+        converters=MY_CONVERTERS)
+]

notebooks/Your_second_ASDF_converter/src/myconverters/extensions.py

@@ -0,0 +1,3 @@
+def get_extensions():
+    from . import extensions
+    return extensions.MY_EXTENSIONS

notebooks/Your_second_ASDF_converter/src/myconverters/integration.py

@@ -0,0 +1,11 @@
+class PhotoID:
+    "Holds Phot ID information"
+
+    def __init__(self, last_name, first_name, image):
+        "expects a monochromatic numpy array for image"
+        self.last_name = last_name
+        self.first_name = first_name
+        self.photo = image
+
+    def name(self):
+        return self.last_name + ', ' + self.first_name

notebooks/Your_second_ASDF_converter/src/myconverters/photo_id.py

@@ -0,0 +1,12 @@
+from .photo_id import PhotoID
+
+
+class TrafficCitation:
+    "Record of a traffic violation"
+
+    def __init__(self, ociffer, violation, date, time, photo_id):
+        self.ociffer = ociffer
+        self.violation = violation
+        self.date = date
+        self.time = time
+        self.photo_id = photo_id

notebooks/Your_second_ASDF_converter/src/myconverters/traffic_citation.py

@@ -0,0 +1,26 @@
+import sys
+
+from asdf.resource import DirectoryResourceMapping
+
+import importlib.resources as importlib_resources
+
+
+def get_resource_mappings():
+    """
+    Get the resource mapping instances for myschemas
+    and manifests.  This method is registered with the
+    asdf.resource_mappings entry point.
+
+    Returns
+    -------
+    list of collections.abc.Mapping
+    """
+    from . import resources
+    resources_root = importlib_resources.files(resources)
+
+    return [
+        DirectoryResourceMapping(
+            resources_root / "schemas", "asdf://stsci.edu/example-project/schemas/"),
+        DirectoryResourceMapping(
+            resources_root / "manifests", "asdf://stsci.edu/example-project/manifests/"),
+    ]