more cleanup

Author: braingram

notebooks/Your_first_ASDF_converter.ipynb

@@ -0,0 +1,18 @@
+[project]
+name = "mfconverter"
+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.extensions"]
+mfconverter = "mfconverter.extensions:get_extensions"
+
+[tool.setuptools.packages.find]
+where = ["src"]

notebooks/Your_first_ASDF_converter/pyproject.toml

@@ -0,0 +1,24 @@
+from asdf.extension import Converter
+
+class PhotoIDConverter(Converter):
+    tags = ["asdf://stsci.edu/example-project/tags/photo_id-*"]
+    types = ["mfconverter.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):
+        from .photo_id import PhotoID # Deferred import to avoid always importing 
+                                      # when ASDF gets entry points.
+        return PhotoID(node['last_name'],
+                       node['first_name'],
+                       node['photo'])

notebooks/Your_first_ASDF_converter/src/mfconverter/__init__.py

@@ -0,0 +1,11 @@
+from asdf.extension import Extension
+from .converter import PhotoIDConverter
+
+class MFExtension(Extension):
+    extension_uri = "asdf://stsci.edu/example-project/photo_id-1.0.0"
+    tags = ["asdf://stsci.edu/example-project/tags/photo_id-1.0.0"]
+    converters = [PhotoIDConverter()]
+
+# The following will be called by ASDF when looking for ASDF entry points    
+def get_extensions():
+    return [MFExtension()]

notebooks/Your_first_ASDF_converter/src/mfconverter/converter.py

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