Skip to main content

Version of the glob module that can capture patterns and supports recursive wildcards

Project description

This is an extended version of Python’s builtin glob module ( which adds:

  • The ability to capture the text matched by glob patterns, and return those matches alongside the filenames.

  • A recursive ‘**’ globbing syntax, akin for example to the globstar option of the bash shell.

  • The ability to replace the filesystem functions used, in order to glob on virtual filesystems.

  • Compatible with Python 2 and Python 3 (tested with 3.3).

It’s currently based on the glob code from Python 3.3.1.


Matches being returned:

import glob2

for filename, (version,) in glob2.iglob('./binaries/project-*.zip', with_matches=True):
    print version

Recursive glob:

>>> import glob2
>>> all_header_files = glob2.glob('src/**/*.h')
['src/fs.h', 'src/media/mp3.h', 'src/media/mp3/frame.h', ...]

Note that ** must appear on it’s own as a directory element to have its special meaning. **h will not have the desired effect.

** will match “.”, so **/*.py returns Python files in the current directory. If this is not wanted, */**/*.py should be used instead.

Custom Globber:

from glob2 import Globber

class VirtualStorageGlobber(Globber):
    def __init__(self, storage): = storage
    def listdir(self, path):
        # Must raise os.error if path is not a directory
    def exists(self, path):
    def isdir(self, path):
        # Used only for trailing slash syntax (``foo/``).
    def islink(self, path):
        # Used only for recursive glob (``**``).

globber = VirtualStorageGlobber(sftp_storage)

If isdir and/or islink cannot be implemented for a storage, you can make them return a fixed value, with the following consequences:

  • If isdir returns True, a glob expression ending with a slash will return all items, even non-directories, if it returns False, the same glob expression will return nothing.

  • Return islink True, the recursive globbing syntax ** will follow all links. If you return False, it will not work at all.

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

glob2-0.5.tar.gz (10.1 kB view hashes)

Uploaded Source

Built Distribution

glob2-0.5-py2.py3-none-any.whl (8.6 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