API reference¶

Glob pattern matcher with configurable features.

Use Glob.default() for POSIX fnmatch-like matching (bracket expansion and escape sequences enabled), or Glob.empty() for a minimal configuration. Chain builder methods to enable or disable features, then call match() to test patterns.

Examples:

>>> from globlin import Glob
>>> glob = Glob.default()
>>> glob.match("*.py", "foo.py")
True
>>> glob.match("*.py", "foo.txt")
False

New in version 0.3.

Methods:

• default –

  Create a glob with POSIX fnmatch-like defaults.

• empty –

  Create a glob with no features enabled.

• from_flags –

  Create a glob from raw bitflags.

• globstar –

  Enable ** globstar matching.

• no_globstar –

  Disable ** globstar matching.

• bracket_expansion –

  Enable [abc] / [a-z] bracket expansion.

• no_bracket_expansion –

  Disable [abc] / [a-z] bracket expansion.

• brace_expansion –

  Enable {a,b,c} brace expansion.

• no_brace_expansion –

  Disable {a,b,c} brace expansion.

• negate –

  Enable !pattern negation.

• no_negate –

  Disable !pattern negation.

• escape –

  Enable \ escape sequences.

• no_escape –

  Disable \ escape sequences.

• path_separator –

  Enable path separator handling (* and ? do not match /).

• no_path_separator –

  Disable path separator handling (* and ? match /).

• match –

  Match a glob pattern against a value.

default() -> Glob

>>> glob = Glob.default()
>>> glob.match("[abc]", "b")
True
>>> glob.match(r"\*", "*")
True

29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

"""

BRACKET_EXPANSION = _flags.BRACKET_EXPANSION
"""Enable ``[abc]`` / ``[a-z]`` bracket expansion.

*New in version 0.3.*
"""

BRACE_EXPANSION = _flags.BRACE_EXPANSION
"""Enable ``{a,b,c}`` brace expansion.

*New in version 0.3.*
"""

NEGATE = _flags.NEGATE
"""Enable ``!pattern`` negation.

empty() -> Glob

>>> glob = Glob.empty()
>>> glob.match("*.py", "foo.py")
True
>>> glob.match("[abc]", "b")
False

46
47
48
49
50
51
52
53
54
55
56
57
58
59

*New in version 0.3.*
"""

ESCAPE = _flags.ESCAPE
r"""Enable ``\`` escape sequences.

*New in version 0.3.*
"""

PATH_SEPARATOR = _flags.PATH_SEPARATOR
r"""Treat ``/`` as path separator — ``*`` and ``?`` do not match ``/``.

*New in version 0.3.*
"""

from_flags(flags: int) -> Glob

>>> from globlin import Flags
>>> glob = Glob.from_flags(Flags.GLOB_STAR | Flags.PATH_SEPARATOR | Flags.ESCAPE)
>>> glob.match("src/**/*.py", "src/a/b/foo.py")
True

62
63
64
65
66
67
68
69
70
71

"""All features enabled.

*New in version 0.3.*
"""

DEFAULT = _flags.DEFAULT
"""POSIX fnmatch-like defaults (``BRACKET_EXPANSION | ESCAPE``).

*New in version 0.3.*
"""

globstar() -> Self

>>> glob = Glob.default().globstar()
>>> glob.match("src/**/*.py", "src/a/b/foo.py")
True
>>> glob.match("src/**/*.py", "src/foo.py")
True

no_globstar() -> Self

bracket_expansion() -> Self

>>> glob = Glob.empty().bracket_expansion()
>>> glob.match("[a-z]", "m")
True
>>> glob.match("[!abc]", "d")
True

no_bracket_expansion() -> Self

>>> glob = Glob.default().no_bracket_expansion()
>>> glob.match("[abc]", "[abc]")
True

brace_expansion() -> Self

>>> glob = Glob.default().brace_expansion()
>>> glob.match("{src,lib}/*.py", "src/foo.py")
True
>>> glob.match("{src,lib}/*.py", "test/foo.py")
False

no_brace_expansion() -> Self

negate() -> Self

>>> glob = Glob.default().negate()
>>> glob.match("!*.py", "foo.txt")
True
>>> glob.match("!*.py", "foo.py")
False

no_negate() -> Self

escape() -> Self

>>> glob = Glob.empty().escape()
>>> glob.match("\\*", "*")
True
>>> glob.match("\\*", "foo")
False

no_escape() -> Self

>>> glob = Glob.default().no_escape()
>>> glob.match("\\*", "\\foo")
True

path_separator() -> Self

>>> glob = Glob.default().path_separator()
>>> glob.match("*.py", "foo.py")
True
>>> glob.match("*.py", "dir/foo.py")
False

no_path_separator() -> Self

match(pattern: str, value: str) -> bool

>>> glob = Glob.default()
>>> glob.match("test_?", "test_a")
True
>>> glob.match("test_?", "test_ab")
False

Bases: IntFlag

Low-level flag constants for bitwise composition.

Attributes:

• EMPTY –

  No features enabled.

• GLOB_STAR –

  Enable ** globstar matching.

• BRACKET_EXPANSION –

  Enable [abc] / [a-z] bracket expansion.

• BRACE_EXPANSION –

  Enable {a,b,c} brace expansion.

• NEGATE –

  Enable !pattern negation.

• ESCAPE –

  Enable \ escape sequences.

• PATH_SEPARATOR –

  Treat / as path separator — * and ? do not match /.

• ALL –

  All features enabled.

• DEFAULT –

  POSIX fnmatch-like defaults (BRACKET_EXPANSION | ESCAPE).

EMPTY = EMPTY

GLOB_STAR = GLOB_STAR

BRACKET_EXPANSION = BRACKET_EXPANSION

BRACE_EXPANSION = BRACE_EXPANSION

NEGATE = NEGATE

ESCAPE = ESCAPE

PATH_SEPARATOR = PATH_SEPARATOR

ALL = ALL

DEFAULT = DEFAULT

Flag enum for fnmatch.

Attributes:

• EMPTY (Flag) –

  No features enabled.

• GLOB_STAR (Flag) –

  Enable ** globstar matching.

• BRACKET_EXPANSION (Flag) –

  Enable [abc] / [a-z] bracket expansion.

• BRACE_EXPANSION (Flag) –

  Enable {a,b,c} brace expansion.

• NEGATE (Flag) –

  Enable !pattern negation.

• ESCAPE (Flag) –

  Enable \ escape sequences.

• NO_PATH (Flag) –

  * and ? match / (disables path separator handling).

EMPTY: Flag

GLOB_STAR: Flag

BRACKET_EXPANSION: Flag

BRACE_EXPANSION: Flag

NEGATE: Flag

ESCAPE: Flag

NO_PATH: Flag