Merge branch 'master' into feature/add_step_5.1

Author: jonathanrocher

docs/ets_tutorial_slides.pdf

@@ -0,0 +1 @@
+__version__ = "0.0.1"

stage3.0_first_views/pycasa/__init__.py

@@ -0,0 +1,36 @@
+# General imports
+import PIL.Image
+from PIL.ExifTags import TAGS
+import numpy as np
+
+# ETS imports
+from traits.api import cached_property, Dict, File, HasStrictTraits, Property
+
+
+class ImageFile(HasStrictTraits):
+    """ Model to hold an image file.
+    """
+    filepath = File
+
+    metadata = Property(Dict, depends_on="filepath")
+
+    def to_array(self):
+        if not self.filepath:
+            return np.array([])
+
+        with PIL.Image.open(self.filepath) as img:
+            return np.asarray(img)
+
+    @cached_property
+    def _get_metadata(self):
+        if not self.filepath:
+            return {}
+
+        with PIL.Image.open(self.filepath) as img:
+            exif = img._getexif()
+
+        if exif:
+            return {TAGS[k]: v for k, v in exif.items()
+                    if k in TAGS}
+        else:
+            return {}

stage3.0_first_views/pycasa/model/image_file.py

@@ -0,0 +1,34 @@
+import glob
+from os.path import expanduser, split
+
+import pandas as pd
+
+from traits.api import (
+    Directory, HasStrictTraits, Instance, List, observe,
+)
+
+from pycasa.model.image_file import ImageFile
+
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
+
+
+class ImageFolder(HasStrictTraits):
+    """ Model for a folder of images.
+    """
+    directory = Directory(expanduser("~"))
+
+    images = List(Instance(ImageFile))
+
+    @observe("directory")
+    def _get_images(self, event):
+        self.images = [
+            ImageFile(filepath=file)
+            for fmt in SUPPORTED_FORMATS
+            for file in glob.glob(f"{self.directory}/*{fmt}")
+        ]
+
+    def create_metadata_df(self):
+        return pd.DataFrame(
+            [img.metadata for img in self.images],
+            index=[split(img.filepath)[1] for img in self.images]
+        )

stage3.0_first_views/pycasa/model/image_folder.py

@@ -0,0 +1,27 @@
+from os.path import dirname, join, split
+import unittest
+
+from image_folder import ImageFolder
+
+import ets_tutorial
+
+TUTORIAL_DIR = dirname(ets_tutorial.__file__)
+SAMPLE_IMG_DIR = join(TUTORIAL_DIR, "..", "sample_images")
+
+
+class TestImageFolder(unittest.TestCase):
+    def setUp(self):
+        self.filenames = ["IMG-0311_xmas_2020.JPG", "owls.jpg"]
+        self.img_folder = ImageFolder(directory=SAMPLE_IMG_DIR)
+
+    def test_filters_images(self):
+        self.assertEqual(
+            {split(img.filepath)[1] for img in self.img_folder.images},
+            set(self.filenames)
+        )
+
+    def test_create_metadata_df(self):
+        df = self.img_folder.create_metadata_df()
+        self.assertEqual(set(df.index), set(self.filenames))
+        self.assertIn("ExifVersion", df)
+        self.assertIn("ApertureValue", df)

stage3.0_first_views/pycasa/model/test_image_folder.py

@@ -0,0 +1,43 @@
+# General imports
+from matplotlib.figure import Figure
+
+# ETS imports
+from traits.api import Instance, observe
+from traitsui.api import Item, ModelView, View
+
+# Local imports
+from ets_tutorial.util.mpl_figure_editor import MplFigureEditor
+from pycasa.model.image_file import ImageFile
+
+
+class ImageFileView(ModelView):
+    """ ModelView for an image file object.
+    """
+    model = Instance(ImageFile)
+
+    figure = Instance(Figure)
+
+    view = View(
+        Item("model.filepath", style="readonly", show_label=False),
+        Item("figure", editor=MplFigureEditor(), show_label=False)
+    )
+
+    @observe("model.filepath")
+    def build_mpl_figure(self, event):
+        figure = Figure()
+        axes = figure.add_subplot(111)
+        axes.imshow(self.model.to_array())
+        self.figure = figure
+
+
+if __name__ == '__main__':
+    from os.path import dirname, join
+    import ets_tutorial
+
+    TUTORIAL_DIR = dirname(ets_tutorial.__file__)
+    SAMPLE_IMG_DIR = join(TUTORIAL_DIR, "..", "sample_images")
+    SAMPLE_IMG1 = join(SAMPLE_IMG_DIR, "IMG-0311_xmas_2020.JPG")
+
+    image_file = ImageFile(filepath=SAMPLE_IMG1)
+    view = ImageFileView(model=image_file)
+    view.configure_traits()

stage3.0_first_views/pycasa/ui/image_file_view.py

@@ -0,0 +1,45 @@
+from traits.api import cached_property, Instance, Property
+from traitsui.api import Item, ModelView, View
+from traitsui.ui_editors.data_frame_editor import DataFrameEditor
+
+from pycasa.model.image_folder import ImageFolder
+
+DISPLAYED_COLUMNS = [
+    'ApertureValue', 'ExifVersion', 'Model', 'Make', 'LensModel', 'DateTime',
+    'ShutterSpeedValue', 'XResolution', 'YResolution'
+]
+
+
+class ImageFolderView(ModelView):
+    """ ModelView for a folder of images.
+    """
+    model = Instance(ImageFolder)
+
+    metadata_df = Property(depends_on="model.images.items")
+
+    view = View(
+        Item('model.directory', style="readonly", show_label=False),
+        Item(
+            'metadata_df',
+            editor=DataFrameEditor(columns=DISPLAYED_COLUMNS),
+            show_label=False,
+            width=1200,
+        ),
+        resizable=True
+    )
+
+    @cached_property
+    def _get_metadata_df(self):
+        return self.model.create_metadata_df()
+
+
+if __name__ == '__main__':
+    from os.path import dirname, join
+    import ets_tutorial
+
+    TUTORIAL_DIR = dirname(ets_tutorial.__file__)
+    SAMPLE_IMG_DIR = join(TUTORIAL_DIR, "..", "sample_images")
+
+    image_file = ImageFolder(directory=SAMPLE_IMG_DIR)
+    view = ImageFolderView(model=image_file)
+    view.configure_traits()

stage3.0_first_views/pycasa/ui/image_folder_view.py

@@ -0,0 +1,21 @@
+import unittest
+from os.path import dirname, join
+
+from traitsui.testing.api import UITester, IsVisible
+
+import ets_tutorial
+from pycasa.model.image_folder import ImageFolder
+from image_folder_view import ImageFolderView
+
+TUTORIAL_DIR = dirname(ets_tutorial.__file__)
+SAMPLE_IMG_DIR = join(TUTORIAL_DIR, "..", "sample_images")
+
+
+class TestImageFolderView(unittest.TestCase):
+    def test_image_folder_view(self):
+        # A smoke test.
+        view = ImageFolderView(model=ImageFolder(directory=SAMPLE_IMG_DIR))
+        tester = UITester()
+        with tester.create_ui(view) as ui:
+            df = tester.find_by_name(ui, "metadata_df")
+            df.inspect(IsVisible())

stage3.0_first_views/pycasa/ui/test_image_folder_view.py

@@ -0,0 +1,23 @@
+from os.path import abspath, dirname, join
+from setuptools import setup, find_packages
+
+HERE = dirname(abspath(__file__))
+
+PKG_NAME = "pycasa"
+
+info = {}
+init_file = join(HERE, PKG_NAME, "__init__.py")
+
+with open(init_file) as fp:
+    exec(fp.read(), globals(), info)
+
+setup(
+    name=PKG_NAME,
+    version=info["__version__"],
+    description='Introduction to TraitsUI views',
+    ext_modules=[],
+    packages=find_packages(),
+    data_files=[
+        (".", ["README.md"]),
+    ],
+)