glob.py 2.23 KB
Newer Older
Guido van Rossum's avatar
Guido van Rossum committed
1
"""Filename globbing utility."""
Guido van Rossum's avatar
Guido van Rossum committed
2

Guido van Rossum's avatar
Guido van Rossum committed
3
import os
4
import re
5
import fnmatch
Guido van Rossum's avatar
Guido van Rossum committed
6

Johannes Gijsbers's avatar
Johannes Gijsbers committed
7
__all__ = ["glob", "iglob"]
Guido van Rossum's avatar
Guido van Rossum committed
8

Guido van Rossum's avatar
Guido van Rossum committed
9
def glob(pathname):
Tim Peters's avatar
Tim Peters committed
10 11 12 13
    """Return a list of paths matching a pathname pattern.

    The pattern may contain simple shell-style wildcards a la fnmatch.

Johannes Gijsbers's avatar
Johannes Gijsbers committed
14 15 16 17
    """
    return list(iglob(pathname))

def iglob(pathname):
Benjamin Peterson's avatar
Benjamin Peterson committed
18
    """Return an iterator which yields the paths matching a pathname pattern.
Johannes Gijsbers's avatar
Johannes Gijsbers committed
19 20 21

    The pattern may contain simple shell-style wildcards a la fnmatch.

Tim Peters's avatar
Tim Peters committed
22 23
    """
    if not has_magic(pathname):
24
        if os.path.lexists(pathname):
Johannes Gijsbers's avatar
Johannes Gijsbers committed
25 26
            yield pathname
        return
Tim Peters's avatar
Tim Peters committed
27
    dirname, basename = os.path.split(pathname)
28
    if not dirname:
29
        for name in glob1(None, basename):
Johannes Gijsbers's avatar
Johannes Gijsbers committed
30 31 32 33
            yield name
        return
    if has_magic(dirname):
        dirs = iglob(dirname)
Tim Peters's avatar
Tim Peters committed
34
    else:
Johannes Gijsbers's avatar
Johannes Gijsbers committed
35 36 37
        dirs = [dirname]
    if has_magic(basename):
        glob_in_dir = glob1
Tim Peters's avatar
Tim Peters committed
38
    else:
Johannes Gijsbers's avatar
Johannes Gijsbers committed
39 40 41 42 43 44 45 46
        glob_in_dir = glob0
    for dirname in dirs:
        for name in glob_in_dir(dirname, basename):
            yield os.path.join(dirname, name)

# These 2 helper functions non-recursively glob inside a literal directory.
# They return a list of basenames. `glob1` accepts a pattern while `glob0`
# takes a literal basename (so it only has to check for its existence).
Guido van Rossum's avatar
Guido van Rossum committed
47 48

def glob1(dirname, pattern):
Johannes Gijsbers's avatar
Johannes Gijsbers committed
49
    if not dirname:
50 51 52 53
        if isinstance(pattern, bytes):
            dirname = bytes(os.curdir, 'ASCII')
        else:
            dirname = os.curdir
Tim Peters's avatar
Tim Peters committed
54 55 56 57
    try:
        names = os.listdir(dirname)
    except os.error:
        return []
58
    if pattern[0] != '.':
Alexandre Vassalotti's avatar
Alexandre Vassalotti committed
59
        names = [x for x in names if x[0] != '.']
60
    return fnmatch.filter(names, pattern)
Guido van Rossum's avatar
Guido van Rossum committed
61

Johannes Gijsbers's avatar
Johannes Gijsbers committed
62 63 64 65
def glob0(dirname, basename):
    if basename == '':
        # `os.path.split()` returns an empty basename for paths ending with a
        # directory separator.  'q*x/' should match only directories.
66
        if os.path.isdir(dirname):
Johannes Gijsbers's avatar
Johannes Gijsbers committed
67 68 69 70 71 72
            return [basename]
    else:
        if os.path.lexists(os.path.join(dirname, basename)):
            return [basename]
    return []

73

74
magic_check = re.compile('[*?[]')
75
magic_check_bytes = re.compile(b'[*?[]')
76

Guido van Rossum's avatar
Guido van Rossum committed
77
def has_magic(s):
78 79 80 81 82
    if isinstance(s, bytes):
        match = magic_check_bytes.search(s)
    else:
        match = magic_check.search(s)
    return match is not None