From 266c2c9a072bf3289fd7f2d75278b7d59528378c Mon Sep 17 00:00:00 2001
From: Matthias Baumgartner <dev@igsor.net>
Date: Sat, 24 Dec 2022 10:27:09 +0100
Subject: package restructuring: base

* Reader and Extractor to respective reader/extractor modules
* ReaderBuilder to reader module
* ExtractorBuilder to extractor module
* Loading module in utils (safe_load, unpack_name)
* Pipeline and PipelineBuilder to lib module
* errors to utils
* documentation: "standard import" and "external import"
---
 bsie/reader/base.py | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 bsie/reader/base.py

(limited to 'bsie/reader/base.py')

diff --git a/bsie/reader/base.py b/bsie/reader/base.py
new file mode 100644
index 0000000..cbabd36
--- /dev/null
+++ b/bsie/reader/base.py
@@ -0,0 +1,47 @@
+"""The Reader classes return high-level content structures from files.
+
+The Reader fulfills two purposes:
+    First, it brokers between multiple libraries and file formats.
+    Second, it separates multiple aspects of a file into distinct content types.
+
+Part of the bsie module.
+A copy of the license is provided with the project.
+Author: Matthias Baumgartner, 2022
+"""
+# imports
+import abc
+import typing
+
+# bsie imports
+from bsie.utils import bsfs
+
+# exports
+__all__: typing.Sequence[str] = (
+    'Reader',
+    )
+
+
+## code ##
+
+class Reader(abc.ABC):
+    """Read and return some content from a file."""
+
+    def __str__(self) -> str:
+        return bsfs.typename(self)
+
+    def __repr__(self) -> str:
+        return f'{bsfs.typename(self)}()'
+
+    def __eq__(self, other: typing.Any) -> bool:
+        return isinstance(other, type(self))
+
+    def __hash__(self) -> int:
+        return hash(type(self))
+
+    @abc.abstractmethod
+    def __call__(self, path: bsfs.URI) -> typing.Any:
+        """Return some content of the file at *path*.
+        Raises a `ReaderError` if the reader cannot make sense of the file format.
+        """
+
+## EOF ##
-- 
cgit v1.2.3


From 07219685d01f803dc46c8d5465fa542c1d822cb4 Mon Sep 17 00:00:00 2001
From: Matthias Baumgartner <dev@igsor.net>
Date: Sat, 24 Dec 2022 10:39:51 +0100
Subject: documentation: standard vs external import

---
 bsie/reader/base.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'bsie/reader/base.py')

diff --git a/bsie/reader/base.py b/bsie/reader/base.py
index cbabd36..08d6cc6 100644
--- a/bsie/reader/base.py
+++ b/bsie/reader/base.py
@@ -8,7 +8,7 @@ Part of the bsie module.
 A copy of the license is provided with the project.
 Author: Matthias Baumgartner, 2022
 """
-# imports
+# standard imports
 import abc
 import typing
 
-- 
cgit v1.2.3


From 17f03ae3d3dc53fe973f37fe4dea4a831b4f97d7 Mon Sep 17 00:00:00 2001
From: Matthias Baumgartner <dev@igsor.net>
Date: Sat, 24 Dec 2022 16:06:16 +0100
Subject: ReaderChain and image reader

---
 bsie/reader/base.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'bsie/reader/base.py')

diff --git a/bsie/reader/base.py b/bsie/reader/base.py
index 08d6cc6..099a327 100644
--- a/bsie/reader/base.py
+++ b/bsie/reader/base.py
@@ -39,7 +39,7 @@ class Reader(abc.ABC):
         return hash(type(self))
 
     @abc.abstractmethod
-    def __call__(self, path: bsfs.URI) -> typing.Any:
+    def __call__(self, path: str) -> typing.Any:
         """Return some content of the file at *path*.
         Raises a `ReaderError` if the reader cannot make sense of the file format.
         """
-- 
cgit v1.2.3


From 4b5c4d486bb4f0f4da2e25ad464e8336a781cdcb Mon Sep 17 00:00:00 2001
From: Matthias Baumgartner <dev@igsor.net>
Date: Wed, 1 Mar 2023 22:31:03 +0100
Subject: removed module header stubs

---
 bsie/reader/base.py | 9 ---------
 1 file changed, 9 deletions(-)

(limited to 'bsie/reader/base.py')

diff --git a/bsie/reader/base.py b/bsie/reader/base.py
index 099a327..a775701 100644
--- a/bsie/reader/base.py
+++ b/bsie/reader/base.py
@@ -1,13 +1,4 @@
-"""The Reader classes return high-level content structures from files.
 
-The Reader fulfills two purposes:
-    First, it brokers between multiple libraries and file formats.
-    Second, it separates multiple aspects of a file into distinct content types.
-
-Part of the bsie module.
-A copy of the license is provided with the project.
-Author: Matthias Baumgartner, 2022
-"""
 # standard imports
 import abc
 import typing
-- 
cgit v1.2.3