Extend data info

micromagneticdata/data.py

@@ -1,19 +1,18 @@
 import glob
 import os
+from pathlib import Path
 
 import ipywidgets
 import pandas as pd
-import ubermagutil.typesystem as ts
 
 import micromagneticdata as md
 
 
-@ts.typesystem(name=ts.Typed(expected_type=str), dirname=ts.Typed(expected_type=str))
 class Data:
     """Computational magnetism data class.
 
-    It requires the name of the system to be passed. If `dirname` was used when
-    the system was driven, it can be passed here via ``dirname``.
+    It requires the name of the system to be passed and optionally accepts
+    a directory `dirname` or a full path `path` to locate the system's data.
 
     Parameters
     ----------
@@ -25,33 +24,67 @@ class Data:
 
         Directory in which system's data is saved. Defults to ``'./'``.
 
+    path : pathlib.Path
+
+        Full path to where the data is stored. Defaults to `None`.
+
     Raises
     ------
-    IOError
+    TypeError
 
-        If the system's directory cannot be found.
+        If the system's name or path cannot be found.
 
     Examples
     --------
-    1. Creating data object.
+    1. Creating data object using `dirname`
+
+    >>> import micromagneticdata as mdata
+    ...
+    >>> data = mdata.Data(
+                path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle"
+                )
+
+    2. Creating data object using `name` and `dirname`
 
     >>> import os
-    >>> import micromagneticdata as md
     ...
     >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
-    >>> data = md.Data(name='rectangle', dirname=dirname)
+    >>> data = mdata.Data(name='rectangle', dirname=dirname)
+    ...
 
     """
 
-    def __init__(self, name, dirname="./"):
-        self.name = name
-        self.dirname = dirname
-        self.path = os.path.join(dirname, name)
-
+    def __init__(self, name=None, dirname="./", path=None):
+        if path is not None:
+            if name is not None:
+                raise TypeError("No other arguments can be passed with `path`.")
+            self.path = path
+        else:
+            if name is None:
+                raise TypeError("`name` must be provided if `path` is not given.")
+            self.path = Path(dirname) / name
         if not os.path.exists(self.path):
-            msg = f"Directory {self.path=} cannot be found."
+            msg = f"Directory {self.path} cannot be found."
             raise OSError(msg)
 
+    @property
+    def path(self):
+        return self._path
+
+    @path.setter
+    def path(self, path):
+        if not isinstance(path, (str, Path)):
+            raise TypeError(f"Unsupported {type(path)=}; expected str or pathlib.Path")
+        self._path = Path(path).absolute()
+
+    @property
+    def name(self):
+        return self.path.name
+
+    @property
+    def dirname(self):
+        return self.path.parent
+
     def __repr__(self):
         """Representation string.
 
@@ -63,18 +96,27 @@ def __repr__(self):
 
         Examples
         --------
-        1. Representation string.
+        1. Representation string using `path`
+
+        >>> import micromagneticdata as mdata
+        ...
+        >>> data = mdata.Data(
+                path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle"
+                )
+        >>> data
+        Data(...)
+
+        2. Representation string using `name` and `dirname`
 
         >>> import os
-        >>> import micromagneticdata as md
         ...
         >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
-        >>> data = md.Data(name='rectangle', dirname=dirname)
+        >>> data = mdata.Data(name='rectangle', dirname=dirname)
         >>> data
         Data(...)
 
         """
-        return f"Data(name='{self.name}', dirname='{self.dirname}')"
+        return f"Data(path='{self.path}')"
 
     @property
     def info(self):
@@ -92,13 +134,22 @@ def info(self):
 
         Examples
         --------
-        1. Getting information about data.
+        1. Getting information about data using `path`.
+
+        >>> import micromagneticdata as mdata
+        ...
+        >>> data = mdata.Data(
+                path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle"
+                )
+        >>> data.info
+           drive_number...
+
+        2. Getting information about data using `name` and `dirname`.
 
         >>> import os
-        >>> import micromagneticdata as md
         ...
         >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
-        >>> data = md.Data(name='rectangle', dirname=dirname)
+        >>> data = mdata.Data(name='rectangle', dirname=dirname)
         >>> data.info
            drive_number...
         """
@@ -116,13 +167,22 @@ def n(self):
 
         Examples
         --------
-        1. Getting the number of drives.
+        1. Getting the number of drives using 'path'.
+
+        >>> import micromagneticdata as mdata
+        ...
+        >>> data = mdata.Data(
+                path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle"
+                )
+        >>> data.n
+        7
+
+        1. Getting the number of drives using `name` and 'dirname'.
 
         >>> import os
-        >>> import micromagneticdata as md
         ...
         >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
-        >>> data = md.Data(name='rectangle', dirname=dirname)
+        >>> data = mdata.Data(name='rectangle', dirname=dirname)
         >>> data.n
         7
 
@@ -149,13 +209,28 @@ def __getitem__(self, item):
 
         Examples
         --------
-        1. Getting drive.
+        1. Getting drive using `path`
+
+        >>> import micromagneticdata as mdata
+        ...
+        >>> data = mdata.Data(
+                path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle"
+                )
+        >>> data.n
+        7
+        >>> data[0]  # first (0th) drive
+        OOMMFDrive(...)
+        >>> data[1]  # second (1th) drive
+        Mumax3Drive(...)
+        >>> data[-1]  # last (6th) drive
+        OOMMFDrive(...)
+
+        2. Getting drive using `name` and  `dirname`
 
         >>> import os
-        >>> import micromagneticdata as md
         ...
         >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
-        >>> data = md.Data(name='rectangle', dirname=dirname)
+        >>> data = mdata.Data(name='rectangle', dirname=dirname)
         >>> data.n
         7
         >>> data[0]  # first (0th) drive
@@ -169,7 +244,7 @@ def __getitem__(self, item):
         return md.Drive(
             name=self.name,
             number=range(self.n)[item],
-            dirname=self.dirname,
+            dirname=str(self.dirname),
         )
 
     def __iter__(self):
@@ -185,13 +260,25 @@ def __iter__(self):
 
         Examples
         --------
-        1. Iterating data object.
+
+        1. Iterating data object using `path`
+
+        >>> import micromagneticdata as mdata
+        ...
+        >>> data = mdata.Data(
+                path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle"
+                )
+        >>> data.n
+        7
+        >>> len(list(data))
+        7
+
+        2. Iterating data object using `name` and `dirname`
 
         >>> import os
-        >>> import micromagneticdata as md
         ...
         >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
-        >>> data = md.Data(name='rectangle', dirname=dirname)
+        >>> data = mdata.Data(name='rectangle', dirname=dirname)
         >>> data.n
         7
         >>> len(list(data))
@@ -221,13 +308,22 @@ def selector(self, description="drive", **kwargs):
 
         Examples
         --------
-        1. Selection widget.
+        1. Selection widget using `path`
+
+        >>> import micromagneticdata as mdata
+        ...
+        >>> data = mdata.Data(
+                path="/home/zulfigak/ubermag_devtools/repos/micromagneticdata/micromagneticdata/tests/test_sample/rectangle"
+                )
+        >>> data.selector()
+        BoundedIntText(...)
+
+        2. Selection widget using `name` and `dirname`
 
         >>> import os
-        >>> import micromagneticdata as md
         ...
         >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
-        >>> data = md.Data(name='rectangle', dirname=dirname)
+        >>> data = mdata.Data(name='rectangle', dirname=dirname)
         >>> data.selector()
         BoundedIntText(...)
 

micromagneticdata/tests/test_data.py

@@ -1,4 +1,5 @@
 import os
+from pathlib import Path
 
 import ipywidgets
 import pandas as pd
@@ -17,7 +18,9 @@ def setup_method(self):
     def test_init(self):
         assert isinstance(self.data, md.Data)
 
-        # Exception
+        with pytest.raises(IOError):
+            md.Data(path=Path(self.dirname) / "nonexistent")
+
         with pytest.raises(IOError):
             md.Data(name="wrong", dirname=self.dirname)