zipindex 1.0.0__tar.gz

zipindex-1.0.0/.gitignore

@@ -0,0 +1,16 @@
+
+# Resources
+*.png
+
+
+# Project
+.spyproject/
+.venv
+dist/
+uv.lock
+.python-version
+.pypirc
+
+# Python Artifacts
+*.egg-info
+__pycache__/

zipindex-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Trent Oberlander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zipindex-1.0.0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: zipindex
+Version: 1.0.0
+Summary: Simple indexing for working with files inside zipfiles
+Project-URL: homepage, https://www.github.com/ResoluteVinculum/ZipIndex
+Project-URL: issues, https://www.github.com/ResoluteVinculum/ZipIndex/issues
+Author-email: Trent Oberlander <trentoberlander@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Trent Oberlander
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: files
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# ZipIndex
+
+Simple, pure-python object package for dealing with many files inside of
+zipfiles.
+
+# Example Usage
+```python
+from zipindex import ZipIndex
+
+# Single Instance
+inst = ZipIndex(zipfile_path="...", member_name="...")
+
+# Simple Factory
+members: dict[str, ZipIndex] = ZipIndex.factory(zipfile_path="...")
+
+# Categorical Factory
+categories: dict[str, ZipIndex] = ZipIndex.categorical_factory(zipfile_path="...", categories={"empty" : {0 : b""}})
+
+# Use
+with inst.open() as fid:
+    data = fid.read()
+
+```

zipindex-1.0.0/README.md

@@ -0,0 +1,23 @@
+# ZipIndex
+
+Simple, pure-python object package for dealing with many files inside of
+zipfiles.
+
+# Example Usage
+```python
+from zipindex import ZipIndex
+
+# Single Instance
+inst = ZipIndex(zipfile_path="...", member_name="...")
+
+# Simple Factory
+members: dict[str, ZipIndex] = ZipIndex.factory(zipfile_path="...")
+
+# Categorical Factory
+categories: dict[str, ZipIndex] = ZipIndex.categorical_factory(zipfile_path="...", categories={"empty" : {0 : b""}})
+
+# Use
+with inst.open() as fid:
+    data = fid.read()
+
+```

zipindex-1.0.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning"]
+build-backend = "hatchling.build"
+
+[project]
+name = "zipindex"
+description = "Simple indexing for working with files inside zipfiles"
+readme = "README.md"
+authors = [
+    { name="Trent Oberlander", email="trentoberlander@gmail.com"}
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = { file = "LICENSE" }
+keywords = ["files"]
+dependencies = [
+]
+dynamic = ["version"]
+
+[tool.hatch.build]
+include = [
+]
+
+
+[tool.hatch.build.targets.wheel]
+packages = ["zipindex"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["zipindex"]
+
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.uv-dynamic-versioning]
+fallback-version = "0.1.0"
+
+[project.urls]
+homepage = "https://www.github.com/ResoluteVinculum/ZipIndex"
+issues = "https://www.github.com/ResoluteVinculum/ZipIndex/issues"

zipindex-1.0.0/zipindex/__init__.py

@@ -0,0 +1,2 @@
+#
+from zipindex.indexer import ZipIndex

zipindex-1.0.0/zipindex/indexer.py

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+"""
+Simple addition to zipfile options that allows for intuitive control over
+zipfile internal uses
+
+"""
+
+import zipfile
+from typing import Self, Iterable
+import os
+from functools import partial
+import re
+
+
+def member_endswith(member: zipfile.ZipInfo,
+                    match_key: str) -> bool:
+    return member.filename.endswith(match_key)
+
+class ZipIndex:
+    
+    def __repr__(self) -> str:
+        return (f"ZipIndex(zipfile_path={self.zipfile_path}, "
+                         f"member_name={self.member_name})")
+    
+    def __init__(self, 
+                 zipfile_path: str,
+                 member_name: str) -> Self:
+        
+        self.zipfile_path = zipfile_path
+        self.member_name = member_name
+        
+    def open(self, mode:str = 'r') -> os.PathLike:
+        self.zf = zipfile.ZipFile(self.zipfile_path, mode)
+        matched_file = max(self.zf.filelist,
+                           key=partial(member_endswith, 
+                                       match_key=self.member_name))
+        self.fid = self.zf.open(matched_file, mode)
+        return self.fid
+    
+    def suffix(self):
+        m = re.match(r"^.*(\.\w+)$", self.member_name)
+        if m:
+            return m.group(1)
+        return ""
+    
+    
+    def __enter__(self) -> os.PathLike:
+        return self.open()
+    
+    def __exit__(self, etype, e, tb) -> None:
+        self.fid.close()
+        self.zf.close()
+        return None
+    
+
+    @classmethod
+    def factory(cls, zipfile_path: str) -> dict[str, Self]:
+        with zipfile.ZipFile(zipfile_path, 'r') as zf:
+            output = {
+                member.filename : cls(zipfile_path, 
+                                      member.filename.split("/")[-1]) 
+                for member in zf.filelist
+                if not member.filename.endswith("/")}
+        return output
+    
+    @classmethod
+    def categorical_factory(cls, 
+                            zipfile_path: str,
+                            categories: dict[str, Iterable[dict[int, bytes]]]) -> dict[str, tuple[Self]]:
+        """
+        Provides a factory for categorizing internal files in a zipfile.ZipFile
+        Must match all conditions of at least one category to be included in 
+        the output.
+
+        Parameters
+        ----------
+        zipfile_path : str
+            Path to the zipfile.
+        categories : dict[str, Iterable[dict[int, bytes]]]
+            Dictionary definition of bytes-wise matching for type detection.
+            Ex: {"empty" : [{0: b""}]}
+        Returns
+        -------
+        dict[str, tuple[Self]]
+            {category : tuple[ZipIndex]}.
+
+        """
+        assert categories
+        output = {cat: [] for cat in categories}
+        with zipfile.ZipFile(zipfile_path, 'r') as zf:
+            for category, definition in categories.items():
+                for member in zf.filelist:
+                    if member.filename.endswith("/"): continue
+                    with zf.open(member, 'r') as fid:
+                        matched = []
+                        for position, condition in definition.items():
+                            fid.seek(position, 0)
+                            if len(condition) == 0:
+                                b = fid.read()
+                            else:
+                                b = fid.read(len(condition))
+                            matched.append((b == condition))
+                        if all(matched):
+                            output[category].append(cls(zipfile_path, 
+                                                        member.filename.split("/")[-1]))
+        return output
+
+idx = ZipIndex.categorical_factory(zipfile_path='C:/dev/data.zip', 
+                                   categories={"empty": {0: b""},
+                                               "bin" : {0: b"BIN"}})