8000 GH-116380: Support `include_hidden` argument in `glob._Globber`. by barneygale · Pull Request #117738 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

GH-116380: Support include_hidden argument in glob._Globber. #117738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
GH-116380: Support include_hidden argument in glob._Globber.
Add support for excluding hidden files (with names beginning `.`) in our
internal `glob._Globber` class. This is necessary for unifying the `glob`
and `pathlib` globbing implementations.
  • Loading branch information
barneygale committed Apr 10, 2024
commit f378d718f43baad9ae4900c07bcc8af4c60cf07a
13 changes: 7 additions & 6 deletions Lib/glob.py
Original file line number Diff line number Diff line change
Expand Up @@ -319,22 +319,23 @@ def translate(pat, *, recursive=False, include_hidden=False, seps=None):


@functools.lru_cache(maxsize=512)
def _compile_pattern(pat, sep, case_sensitive, recursive=True):
def _compile_pattern(pat, sep, case_sensitive, recursive=True, include_hidden=False):
"""Compile given glob pattern to a re.Pattern object (observing case
sensitivity)."""
flags = re.NOFLAG if case_sensitive else re.IGNORECASE
regex = translate(pat, recursive=recursive, include_hidden=True, seps=sep)
regex = translate(pat, recursive=recursive, include_hidden=include_hidden, seps=sep)
return re.compile(regex, flags=flags).match


class _Globber:
"""Class providing shell-style pattern matching and globbing.
"""

def __init__(self, sep, case_sensitive, recursive=False):
def __init__(self, sep, case_sensitive, recursive=False, include_hidden=False):
self.sep = sep
self.case_sensitive = case_sensitive
self.recursive = recursive
self.include_hidden = include_hidden

# Low-level methods

Expand All @@ -360,7 +361,7 @@ def add_slash(pathname):
# High-level methods

def compile(self, pat):
return _compile_pattern(pat, self.sep, self.case_sensitive, self.recursive)
return _compile_pattern(pat, self.sep, self.case_sensitive, self.recursive, self.include_hidden)

def selector(self, parts):
"""Returns a function that selects from a given path, walking and
Expand Down Expand Up @@ -392,7 +393,7 @@ def wildcard_selector(self, part, parts):
filtering by pattern.
"""

match = None if part == '*' else self.compile(part)
match = None if self.include_hidden and part == '*' else self.compile(part)
dir_only = bool(parts)
if dir_only:
select_next = self.selector(parts)
Expand Down Expand Up @@ -440,7 +441,7 @@ def recursive_selector(self, part, parts):
while parts and parts[-1] not in _special_parts:
part += self.sep + parts.pop()

match = None if part == '**' else self.compile(part)
match = None if self.include_hidden and part == '**' else self.compile(part)
dir_only = bool(parts)
select_next = self.selector(parts)

Expand Down
7 changes: 4 additions & 3 deletions Lib/pathlib/_abc.py
4FC4
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ def match(self, path_pattern, *, case_sensitive=None):
return False
if len(path_parts) > len(pattern_parts) and path_pattern.anchor:
return False
globber = self._globber(sep, case_sensitive)
globber = self._globber(sep, case_sensitive, include_hidden=True)
for path_part, pattern_part in zip(path_parts, pattern_parts):
match = globber.compile(pattern_part)
if match(path_part) is None:
Expand All @@ -412,7 +412,8 @@ def full_match(self, pattern, *, case_sensitive=None):
pattern = self.with_segments(pattern)
if case_sensitive is None:
case_sensitive = _is_case_sensitive(self.parser)
globber = self._globber(pattern.parser.sep, case_sensitive, recursive=True)
globber = self._globber(pattern.parser.sep, case_sensitive,
recursive=True, include_hidden=True)
match = globber.compile(pattern._pattern_str)
return match(self._pattern_str) is not None

Expand Down Expand Up @@ -695,7 +696,7 @@ def _glob_selector(self, parts, case_sensitive, recurse_symlinks):
if case_sensitive is None:
case_sensitive = _is_case_sensitive(self.parser)
recursive = True if recurse_symlinks else glob._no_recurse_symlinks
globber = self._globber(self.parser.sep, case_sensitive, recursive)
globber = self._globber(self.parser.sep, case_sensitive, recursive, include_hidden=True)
return globber.selector(parts)

def glob(self, pattern, *, case_sensitive=None, recurse_symlinks=True):
Expand Down
0