Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jshwi/lsfiles

Path object VC index
https://github.com/jshwi/lsfiles

git index lsfiles oop vc

Last synced: 3 months ago
JSON representation

Path object VC index

Awesome Lists containing this project

README 

        
Status: Archived

==================

This repository has been archived and is no longer maintained



lsfiles

=======

|Inactive| |License| |PyPI| |CI| |CodeQL| |pre-commit.ci status| |codecov.io| |readthedocs.org| |python3.8| |Black| |isort| |docformatter| |pylint| |Security Status| |Known Vulnerabilities| |turba|



.. |Inactive| image:: https://img.shields.io/badge/status-inactive-red.svg

   :target: https://img.shields.io/badge/status-inactive-red.svg

   :alt: Status Inactive

.. |License| image:: https://img.shields.io/badge/License-MIT-yellow.svg

   :target: https://opensource.org/licenses/MIT

   :alt: License

.. |PyPI| image:: https://img.shields.io/pypi/v/turba

   :target: https://pypi.org/project/turba/

   :alt: PyPI

.. |CI| image:: https://github.com/jshwi/turba/actions/workflows/build.yaml/badge.svg

   :target: https://github.com/jshwi/turba/actions/workflows/build.yaml

   :alt: CI

.. |CodeQL| image:: https://github.com/jshwi/turba/actions/workflows/codeql-analysis.yml/badge.svg

   :target: https://github.com/jshwi/turba/actions/workflows/codeql-analysis.yml

   :alt: CodeQL

.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/jshwi/turba/master.svg

   :target: https://results.pre-commit.ci/latest/github/jshwi/turba/master

   :alt: pre-commit.ci status

.. |codecov.io| image:: https://codecov.io/gh/jshwi/turba/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/jshwi/turba

   :alt: codecov.io

.. |readthedocs.org| image:: https://readthedocs.org/projects/turba/badge/?version=latest

   :target: https://turba.readthedocs.io/en/latest/?badge=latest

   :alt: readthedocs.org

.. |python3.8| image:: https://img.shields.io/badge/python-3.8-blue.svg

   :target: https://www.python.org/downloads/release/python-380

   :alt: python3.8

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg

   :target: https://github.com/psf/black

   :alt: Black

.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336

   :target: https://pycqa.github.io/isort/

   :alt: isort

.. |docformatter| image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg

   :target: https://github.com/PyCQA/docformatter

   :alt: docformatter

.. |pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen

   :target: https://github.com/PyCQA/pylint

   :alt: pylint

.. |Security Status| image:: https://img.shields.io/badge/security-bandit-yellow.svg

   :target: https://github.com/PyCQA/bandit

   :alt: Security Status

.. |Known Vulnerabilities| image:: https://snyk.io/test/github/jshwi/turba/badge.svg

   :target: https://snyk.io/test/github/jshwi/turba/badge.svg

   :alt: Known Vulnerabilities

.. |turba| image:: https://snyk.io/advisor/python/docsig/badge.svg

   :target: https://snyk.io/advisor/python/turba

   :alt: turba



Path object VC index

--------------------



Index versioned .py files



Install

-------



``pip install lsfiles``



Development

-----------



``poetry install``



Usage

-----



The ``LSFiles`` instance is a list-like object instantiated with an empty index



.. code-block:: python



    >>> from lsfiles import LSFiles

    >>> from pathlib import Path

    >>>

    >>> files = LSFiles()

    >>> files

    



The ``LSFiles`` index calls ``git ls-files`` and only versioned files are indexed



.. code-block:: python



    >>> files.populate()

    >>> for path in sorted([p.relative_to(Path.cwd()) for p in files]):

    ...     print(path)

    docs/conf.py

    lsfiles/__init__.py

    lsfiles/_indexing.py

    lsfiles/_objects.py

    lsfiles/_version.py

    tests/__init__.py

    tests/_environ.py

    tests/_test.py

    tests/conftest.py

    whitelist.py



The ``LSFiles`` instance is an index of unique file paths



It's implementation of ``extend`` prevents duplicates



.. code-block:: python



    >>> p1 = Path.cwd() / "f1"

    >>> p2 = Path.cwd() / "f1"

    >>>

    >>> files = LSFiles()

    >>> files.extend([p1, p2])

    >>> sorted([p.relative_to(Path.cwd()) for p in files.reduce()])

    [PosixPath('f1')]



Reduce minimizes index to directories and individual files relative to the current working dir



The list value is returned, leaving the instance unaltered



.. code-block:: python



    >>> p1 = Path.cwd() / "f1"

    >>>

    >>> d = Path.cwd() / "dir"

    >>> p2 = d / "f2"

    >>> p3 = d / "f3"

    >>>

    >>> files = LSFiles()

    >>> files.extend([p1, p2, p3])

    >>> sorted(p.relative_to(Path.cwd()) for p in files.reduce())

    [PosixPath('dir'), PosixPath('f1')]



Exclusions can be added on instantiation



Exclusions are evaluated by their basename, and does not have to be an absolute path



.. code-block:: python



    >>> p1 = Path.cwd() / "docs" / "conf.py"

    >>> p2 = Path.cwd() / "lsfiles" / "__init__.py"

    >>>

    >>> files = LSFiles()

    >>> files.populate(f".*\/{p1.name}")

    >>>

    >>> ps = [str(p) for p in files]

    >>>

    >>> assert not str(p1) in ps

    >>> assert str(p2) in ps