lsfiles 0.1.1

Path object VC index

Path object VC index

Install

pip install lsfiles

Development

poetry install

Usage

>>> from lsfiles import LSFiles
>>> from pathlib import Path
>>> files = LSFiles()  # begin with an empty index
>>> # the `LSFiles` object is a mutable sequence (list-like object)
>>> print(files)
<LSFiles []>
>>> # `lsfiles` is designed to work with `git`, and only versioned files
>>> # are indexed
>>> # $ git init
>>> files.populate()  # <LSFiles []>
>>> # $ git add .
>>> files.populate()  # <LSFiles [PosixPath(...), ...]>
>>> files.clear()  # clear the index
>>> print(files)
<LSFiles []>
>>> # as `lsfiles` is an index of unique file paths, its implementation
>>> # of extend prevents duplicates
>>> values = [Path.cwd() / "1", Path.cwd() / "1"]
>>> files.extend(values)  # <LSFiles [PosixPath('.../lsfiles/1')]>
>>> files.clear()
>>> # reduce minimizes index to directories and individual files
>>> # the list value is returned, leaving `LSFiles` unaltered
>>> values = [
...     Path.cwd() / "f1",
...     Path.cwd() / 'd1' / "1",
...     Path.cwd() / 'd1' / "2",
... ]
>>> files.extend(values)
>>> files.reduce() # -> [PosixPath('.../f1'), PosixPath('.../d1')]
>>> # exclusions are evaluated by their basename, and does not have
>>> # have to be an absolute path
>>> # exclusions can be added on instantiation
>>> files = LSFiles("f1")
>>> # or with the add exclusions method
>>> files = LSFiles()
>>> files.add_exclusions()