Implement descriptive string representations (#369)

* Implement descriptive string representations

* update changelog

* adjust repr of MagView

Author: rschwanhold

Changelog.md

@@ -7,14 +7,37 @@ and this project adheres to [Calendar Versioning](http://calver.org/) `0Y.0M.MIC
 For upgrade instructions, please check the respective *Breaking Changes* sections.
 
 ## Unreleased
-[Commits](https://github.com/scalableminds/webknossos-cuber/compare/v0.8.4...HEAD)
+[Commits](https://github.com/scalableminds/webknossos-cuber/compare/v0.8.6...HEAD)
+
+### Breaking Changes in Config & CLI
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.8.6](https://github.com/scalableminds/webknossos-cuber/releases/tag/v0.8.6) - 2021-07-29
+[Commits](https://github.com/scalableminds/webknossos-cuber/compare/v0.8.5...v0.8.6)
+
+### Breaking Changes in Config & CLI
+
+### Added
+- Implement descriptive string representations for `Dataset`, `Layer`, `MagView` and `View`. [#369](https://github.com/scalableminds/webknossos-cuber/pull/369)
+- Added option to rename a layer. [#368](https://github.com/scalableminds/webknossos-cuber/pull/368)
+
+### Changed
+
+### Fixed
+
+## [0.8.5](https://github.com/scalableminds/webknossos-cuber/releases/tag/v0.8.5) - 2021-07-29
+[Commits](https://github.com/scalableminds/webknossos-cuber/compare/v0.8.4...v0.8.5)
 
 ### Breaking Changes in Config & CLI
 - The parameter allow_compressed_write from View.write() is now removed. Writing to compressed magnifications is now always allowed. If the user decides to write unaligned data, a warning about a possible performance impact is displayed once. [#356](https://github.com/scalableminds/webknossos-cuber/pull/356)
 
 ### Added
 - Added functions to `wkcuber.api.dataset.Dataset` and `wkcuber.api.layer.Layer` to set and get the view configuration. [#344](https://github.com/scalableminds/webknossos-cuber/pull/344)
-- Added option to rename a layer. [#368](https://github.com/scalableminds/webknossos-cuber/pull/368)
 
 ### Changed
 

wkcuber/api/dataset.py

@@ -697,6 +697,9 @@ def get_view_configuration(self) -> Optional["DatasetViewConfiguration"]:
             else None,
         )
 
+    def __repr__(self) -> str:
+        return repr("Dataset(%s)" % self.path)
+
 
 class DatasetViewConfiguration:
     """

wkcuber/api/layer.py

@@ -667,6 +667,12 @@ def get_view_configuration(self) -> Optional["LayerViewConfiguration"]:
             is_in_edit_mode=view_configuration_dict.get("isInEditMode"),
         )
 
+    def __repr__(self) -> str:
+        return repr(
+            "Layer(%s, dtype_per_channel=%s, num_channels=%s)"
+            % (self.name, self.dtype_per_channel, self.num_channels)
+        )
+
 
 class SegmentationLayer(Layer):
     @property

wkcuber/api/mag_view.py

@@ -328,6 +328,12 @@ def _get_file_dimensions(self) -> Tuple[int, int, int]:
             Tuple[int, int, int], (self.header.file_len * self.header.block_len,) * 3
         )
 
+    def __repr__(self) -> str:
+        return repr(
+            "MagView(name=%s, global_offset=%s, size=%s)"
+            % (self.name, self.global_offset, self.size)
+        )
+
 
 def _extract_file_index(file_path: Path) -> Tuple[int, int, int]:
     zyx_index = [int(el[1:]) for el in file_path.parts]

wkcuber/api/view.py

@@ -478,6 +478,12 @@ def __exit__(
     ) -> None:
         self.close()
 
+    def __repr__(self) -> str:
+        return repr(
+            "View(%s, global_offset=%s, size=%s)"
+            % (self.path, self.global_offset, self.size)
+        )
+
 
 def _assert_positive_dimensions(
     offset: Tuple[int, int, int], size: Tuple[int, int, int]