https://github.com/jwodder/gitmatch

Gitignore-style path matching
https://github.com/jwodder/gitmatch

available-on-pypi fnmatch git gitignore glob python wildmatch

Last synced: 3 months ago
JSON representation

Gitignore-style path matching

• Host: GitHub
• URL: https://github.com/jwodder/gitmatch
• Owner: jwodder
• License: mit
• Created: 2022-06-27T02:06:15.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-04-07T02:22:57.000Z (3 months ago)
• Last Synced: 2025-04-12T20:09:51.598Z (3 months ago)
• Topics: available-on-pypi, fnmatch, git, gitignore, glob, python, wildmatch
• Language: Python
• Homepage:
• Size: 68.4 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
|repostatus| |ci-status| |coverage| |pyversions| |license|

.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg

    :target: https://www.repostatus.org/#active

    :alt: Project Status: Active — The project has reached a stable, usable

          state and is being actively developed.

.. |ci-status| image:: https://github.com/jwodder/gitmatch/actions/workflows/test.yml/badge.svg

    :target: https://github.com/jwodder/gitmatch/actions/workflows/test.yml

    :alt: CI Status

.. |coverage| image:: https://codecov.io/gh/jwodder/gitmatch/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/jwodder/gitmatch

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/gitmatch.svg

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

.. |license| image:: https://img.shields.io/github/license/jwodder/gitmatch.svg

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

    :alt: MIT License

`GitHub `_

| `PyPI `_

| `Documentation `_

| `Issues `_

| `Changelog `_

``gitmatch`` provides ``gitignore``-style pattern matching of file paths.

Simply pass in a sequence of ``gitignore`` patterns and you'll get back an

object for testing whether a given relative path matches the patterns.

Installation

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

``gitmatch`` requires Python 3.8 or higher.  Just use `pip

`_ for Python 3 (You have pip, right?) to install it::

    python3 -m pip install gitmatch

Examples

========

Basic usage::

    >>> import gitmatch

    >>> gi = gitmatch.compile(["foo", "!bar", "*.dir/"])

    >>> bool(gi.match("foo"))

    True

    >>> bool(gi.match("bar"))

    False

    >>> bool(gi.match("quux"))

    False

    >>> bool(gi.match("foo/quux"))

    True

    >>> bool(gi.match("foo/bar"))

    True

    >>> bool(gi.match("bar/foo"))

    True

    >>> bool(gi.match("bar/quux"))

    False

    >>> bool(gi.match("foo.dir"))

    False

    >>> bool(gi.match("foo.dir/"))

    True

See what pattern was matched::

    >>> m1 = gi.match("foo/bar")

    >>> m1 is None

    False

    >>> bool(m1)

    True

    >>> m1.pattern

    'foo'

    >>> m1.path

    'foo'

    >>> m2 = gi.match("bar")

    >>> m2 is None

    False

    >>> bool(m2)

    False

    >>> m2.pattern

    '!bar'

    >>> m2.pattern_obj.negative

    True

    >>> m3 = gi.match("quux")

    >>> m3 is None

    True