Merge pull request #1070 from wright-group/ipython-repr

ipython integration: autocompletion

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
 ## [Unreleased]
 
+## Added
+- iPython integration: autocomplete includes axis, variable, and channel names
+
 ### Fixed
 - `kit.fft`: fixed bug where Fourier coefficients were off by a scalar factor.
 

WrightTools/collection/_collection.py

@@ -45,6 +45,13 @@ def __repr__(self):
             self.natural_name, self.item_names, "::".join([self.filepath, self.name])
         )
 
+    def __dir__(self) -> list:
+        default = object.__dir__(self)
+        return default + list(self._ipython_key_completions_())
+
+    def _ipython_key_completions_(self) -> list:
+        return list(self.item_names)
+
     def __getitem__(self, key):
         if isinstance(key, int):
             key = self.item_names[key]

WrightTools/data/_data.py

@@ -85,6 +85,16 @@ def __repr__(self) -> str:
             self.natural_name, str(self.axis_names), "::".join([self.filepath, self.name])
         )
 
+    def __dir__(self) -> list:
+        default = object.__dir__(self)
+        axes = [ax.natural_name for ax in self.axes]
+        return default + axes + self._ipython_key_completions_()
+
+    def _ipython_key_completions_(self) -> list:
+        channels = [ch.natural_name for ch in self.channels]
+        variables = [v.natural_name for v in self.variables]
+        return channels + variables
+
     @property
     def axes(self) -> tuple:
         return tuple(self._axes)