fpathlib 0.1.1.post0__py3-none-any.whl

fpathlib/__init__.py

@@ -0,0 +1,11 @@
+
+from pathlib import *
+
+from fpathlib.path import Path, PathPattern, ExpandedPathPattern
+
+__all__ = [
+	"Path",
+	"PathPattern",
+	"ExpandedPathPattern",
+    "expand_path_pattern",
+]

fpathlib/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.1.post0'
+__version_tuple__ = version_tuple = (0, 1, 1, 'post0')
+
+__commit_id__ = commit_id = None

fpathlib/path.py

@@ -0,0 +1,121 @@
+from glob import glob
+import parse
+import pathlib
+import re
+
+
+class Path(pathlib.Path):
+    """
+    :obj:`Path` is simply :obj:`pathlib.Path` with metadata.
+        
+    Parameters
+    ----------
+    *pathsegments 
+    """
+
+    def __init__(self, *pathsegments, metadata=None):
+        super().__init__(*pathsegments)
+        self.metadata = metadata
+
+    def match_any(self, path_patterns):
+        """
+        Perform :meth:`pathlib.Path.match` on several `path_patterns`.
+
+        Returns
+        -------
+        :obj:`bool`
+        """
+
+        if isinstance(path_patterns, str):
+            path_patterns = [path_patterns]
+  
+        for path_pattern in path_patterns:
+            if self.match(path_pattern):
+                return True
+
+        return False
+
+
+class FPath:
+    """
+    :obj:`FPath` is an f-string version of :obj:`Path`. This does not behave like a typical Path, because typically there are several matches to the f-string Path. Therefore, the :meth:`.FPath.expand` method must be used to create an :obj:`ExpandedFPath` that lists all the possibilities.
+
+    Example:
+    
+
+    Parameters
+    ----------
+    fpath : :obj:`str`
+
+    Returns
+    -------
+    :obj:`.FPath`
+    """
+
+    def __init__(self, fpath):
+        self.fpath = fpath
+
+    def expand(self, exclude_path_patterns=None, require_metadata=True):
+        """
+        Use an f-string to extract out a collection of paths, where the f-string variables are captured and stored along the path name.
+    
+        Parameters
+        ----------
+        exclude_path_patterns : :obj:`str` or :obj:`Iterable`[:obj:`str`]
+            Exclude paths that match the supplied pattern. (Default: None).
+        require_metadata : :obj:`bool`
+            Require that all paths identified must have found metadata. (Default: True).
+
+        Returns
+        -------
+        :obj:`.ExpandedFPath`
+        """
+    
+        parser = parse.compile(self.fpath)
+    
+        paths = []
+        for fname in glob(re.sub(r"\{.*?\}", "*", self.fpath)):
+            path = Path(fname)
+            if exclude_path_patterns and path.match_any(exclude_path_patterns):
+                continue
+            path.metadata = getattr(parser.parse(fname), "named", None)
+            if require_metadata and path.metadata is None:
+                msg = f"metadata not found for '{fname}' with fstring '{fstring}'"
+                raise AttributeError(msg)
+            paths.append(path)
+    
+        return ExpandedFPath(paths)
+
+
+# TODO does scan_csv belong here?
+class ExpandedFPath:
+    def __init__(self, paths, path_pattern):
+        if len(paths) != len(set(paths)):
+            raise AttributeError("paths are not unique")
+        self.paths = paths
+        self.path_pattern = path_pattern
+
+    def __getitem__(self, item):
+        return self.paths[item]
+
+    def __len__(self):
+        return len(self.paths)
+
+    @property
+    def metadata(self):
+        metadata = {path: path.metadata for path in self.paths}
+        return metadata
+
+    def to_polars(self, lazy=False):
+        data = [{"fname": str(key), **value} for key, value in self.metadata.items()]
+        df = pl.DataFrame(data)
+        if lazy:
+            df = df.lazy()
+        return df
+
+
+def expand_fpath(fpath, exclude=None, require_metadata=True):
+    """
+    """
+
+    return FPath(fpath).expand(exclude=exclude, require_metadata=require_metadata)

fpathlib-0.1.1.post0.dist-info/METADATA

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: fpathlib
+Version: 0.1.1.post0
+Summary: A package to combine paths with metadata
+Author-email: "C. Lockhart" <clockha2@gmu.edu>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: parse
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Dynamic: license-file
+
+fpathlib
+========
+
+A Python package for adding metadata to file paths.

fpathlib-0.1.1.post0.dist-info/RECORD

@@ -0,0 +1,8 @@
+fpathlib/__init__.py,sha256=8hUfYyGLWDAhFsuM9xjKvCVohOur7sx3N9hOaq3f2yY,180
+fpathlib/_version.py,sha256=sIqpOcrwP7UeMcz5uPF6Tnd5RgYb-DnIQQng-hqRGJI,535
+fpathlib/path.py,sha256=eM0o78gk1kqFEV7YBjdrhuci98P3BGuMBOyVrBuEPBY,3377
+fpathlib-0.1.1.post0.dist-info/licenses/LICENSE,sha256=76rZ9i4ZumZ1M4jlYM9ZDOTYEeyzuxdsTKjF2qha3Lc,1069
+fpathlib-0.1.1.post0.dist-info/METADATA,sha256=XB1ZY8wnc7Uz7JnhxxWSBS8gsQZuZZ9G8pct9aLU4DE,488
+fpathlib-0.1.1.post0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+fpathlib-0.1.1.post0.dist-info/top_level.txt,sha256=QT5pDgO4--AJn7X4RB51xpNTt0pD5_U2mCjsydpQAQw,9
+fpathlib-0.1.1.post0.dist-info/RECORD,,

fpathlib-0.1.1.post0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fpathlib-0.1.1.post0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lockhart Lab
+
+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.

fpathlib-0.1.1.post0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fpathlib