Skip to main content

Matching paths against globs

Project description

Installation | Usage | Testing | License

globmatch - Matching paths against globs

globmatch provides functions for matching a path against one ore more glob patterns in Python. This differs from the glob module of the standard library, which matches a glob against the file-tree on your system. globmatch does not interact with the filesystem at all, but relies on generic matching. It also differs from the fnmatch module of the standard library in that it accepts the double star (**) element, which matches zero or more directories. Additionally, the star element (*) in fnmatch will also match across path separators. In globmatch the star element matches zero or more characters of the current path element (directory/file name).


Install globmatch with pip:

pip install globmatch

or for a development install:

pip install -e git+


from globmatch import glob_match

# Some paths that match (returns True):
glob_match('.git/gitconfig/', ['.git'])
glob_match('foo/config', ['**/config'])
glob_match('foo/config/bar', ['**/config'])
glob_match('.git/gitconfig/', ['.git', '**/config'])
glob_match('foo/config/bar', ['.git', '**/config'])
glob_match('/.git/gitconfig/', ['**/.git'])

# Some paths that do not match (returns False):
glob_match('/.git/gitconfig/', ['.git'])   # Needs ** to match subdir of root dir
glob_match('foo/node_modules', ['node_modules'])   # Will not match subdir without preceding **


Install the develop install with test requirements:

pip install -e globmatch[test]

To run Python tests locally, enter on the command line: pytest

Install the codecov browser extension to view test coverage in the source browser on github.


All code is licensed under the terms of the revised BSD license.


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

globmatch-2.0.0.tar.gz (10.2 kB view hashes)

Uploaded Source

Built Distribution

globmatch-2.0.0-py2.py3-none-any.whl (7.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page