1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
"""Useful functions for working with glob patterns.
"""
from __future__ import unicode_literals
import typing
import re
from collections import namedtuple
from . import wildcard
from ._repr import make_repr
from .lrucache import LRUCache
from .path import iteratepath
GlobMatch = namedtuple("GlobMatch", ["path", "info"])
Counts = namedtuple("Counts", ["files", "directories", "data"])
LineCounts = namedtuple("LineCounts", ["lines", "non_blank"])
if typing.TYPE_CHECKING:
from typing import Iterator, List, Optional, Pattern, Text, Tuple
from .base import FS
_PATTERN_CACHE = LRUCache(
1000
) # type: LRUCache[Tuple[Text, bool], Tuple[int, bool, Pattern]]
def _translate_glob(pattern, case_sensitive=True):
levels = 0
recursive = False
re_patterns = [""]
for component in iteratepath(pattern):
if component == "**":
re_patterns.append(".*/?")
recursive = True
else:
re_patterns.append(
"/" + wildcard._translate(component, case_sensitive=case_sensitive)
)
levels += 1
re_glob = "(?ms)^" + "".join(re_patterns) + ("/$" if pattern.endswith("/") else "$")
return (
levels,
recursive,
re.compile(re_glob, 0 if case_sensitive else re.IGNORECASE),
)
def match(pattern, path):
# type: (str, str) -> bool
"""Compare a glob pattern with a path (case sensitive).
Arguments:
pattern (str): A glob pattern.
path (str): A path.
Returns:
bool: ``True`` if the path matches the pattern.
Example:
>>> from fs.glob import match
>>> match("**/*.py", "/fs/glob.py")
True
"""
try:
levels, recursive, re_pattern = _PATTERN_CACHE[(pattern, True)]
except KeyError:
levels, recursive, re_pattern = _translate_glob(pattern, case_sensitive=True)
_PATTERN_CACHE[(pattern, True)] = (levels, recursive, re_pattern)
return bool(re_pattern.match(path))
def imatch(pattern, path):
# type: (str, str) -> bool
"""Compare a glob pattern with a path (case insensitive).
Arguments:
pattern (str): A glob pattern.
path (str): A path.
Returns:
bool: ``True`` if the path matches the pattern.
"""
try:
levels, recursive, re_pattern = _PATTERN_CACHE[(pattern, False)]
except KeyError:
levels, recursive, re_pattern = _translate_glob(pattern, case_sensitive=True)
_PATTERN_CACHE[(pattern, False)] = (levels, recursive, re_pattern)
return bool(re_pattern.match(path))
class Globber(object):
"""A generator of glob results."""
def __init__(
self,
fs,
pattern,
path="/",
namespaces=None,
case_sensitive=True,
exclude_dirs=None,
):
# type: (FS, str, str, Optional[List[str]], bool, Optional[List[str]]) -> None
"""Create a new Globber instance.
Arguments:
fs (~fs.base.FS): A filesystem object
pattern (str): A glob pattern, e.g. ``"**/*.py"``
path (str): A path to a directory in the filesystem.
namespaces (list): A list of additional info namespaces.
case_sensitive (bool): If ``True``, the path matching will be
case *sensitive* i.e. ``"FOO.py"`` and ``"foo.py"`` will be
different, otherwise path matching will be case *insensitive*.
exclude_dirs (list): A list of patterns to exclude when searching,
e.g. ``["*.git"]``.
"""
self.fs = fs
self.pattern = pattern
self.path = path
self.namespaces = namespaces
self.case_sensitive = case_sensitive
self.exclude_dirs = exclude_dirs
def __repr__(self):
return make_repr(
self.__class__.__name__,
self.fs,
self.pattern,
path=(self.path, "/"),
namespaces=(self.namespaces, None),
case_sensitive=(self.case_sensitive, True),
exclude_dirs=(self.exclude_dirs, None),
)
def _make_iter(self, search="breadth", namespaces=None):
# type: (str, List[str]) -> Iterator[GlobMatch]
try:
levels, recursive, re_pattern = _PATTERN_CACHE[
(self.pattern, self.case_sensitive)
]
except KeyError:
levels, recursive, re_pattern = _translate_glob(
self.pattern, case_sensitive=self.case_sensitive
)
for path, info in self.fs.walk.info(
path=self.path,
namespaces=namespaces or self.namespaces,
max_depth=None if recursive else levels,
search=search,
exclude_dirs=self.exclude_dirs,
):
if info.is_dir:
path += "/"
if re_pattern.match(path):
yield GlobMatch(path, info)
def __iter__(self):
# type: () -> Iterator[GlobMatch]
"""Get an iterator of :class:`fs.glob.GlobMatch` objects."""
return self._make_iter()
def count(self):
# type: () -> Counts
"""Count files / directories / data in matched paths.
Example:
>>> my_fs.glob('**/*.py').count()
Counts(files=2, directories=0, data=55)
Returns:
`~Counts`: A named tuple containing results.
"""
directories = 0
files = 0
data = 0
for _path, info in self._make_iter(namespaces=["details"]):
if info.is_dir:
directories += 1
else:
files += 1
data += info.size
return Counts(directories=directories, files=files, data=data)
def count_lines(self):
# type: () -> LineCounts
"""Count the lines in the matched files.
Returns:
`~LineCounts`: A named tuple containing line counts.
Example:
>>> my_fs.glob('**/*.py').count_lines()
LineCounts(lines=4, non_blank=3)
"""
lines = 0
non_blank = 0
for path, info in self._make_iter():
if info.is_file:
for line in self.fs.open(path, "rb"):
lines += 1
if line.rstrip():
non_blank += 1
return LineCounts(lines=lines, non_blank=non_blank)
def remove(self):
# type: () -> int
"""Remove all matched paths.
Returns:
int: Number of file and directories removed.
Example:
>>> my_fs.glob('**/*.pyc').remove()
2
"""
removes = 0
for path, info in self._make_iter(search="depth"):
if info.is_dir:
self.fs.removetree(path)
else:
self.fs.remove(path)
removes += 1
return removes
class BoundGlobber(object):
"""A `~fs.glob.Globber` object bound to a filesystem.
An instance of this object is available on every Filesystem object
as the `~fs.base.FS.glob` property.
"""
__slots__ = ["fs"]
def __init__(self, fs):
# type: (FS) -> None
"""Create a new bound Globber.
Arguments:
fs (FS): A filesystem object to bind to.
"""
self.fs = fs
def __repr__(self):
return make_repr(self.__class__.__name__, self.fs)
def __call__(
self, pattern, path="/", namespaces=None, case_sensitive=True, exclude_dirs=None
):
# type: (str, str, Optional[List[str]], bool, Optional[List[str]]) -> Globber
"""Match resources on the bound filesystem againsts a glob pattern.
Arguments:
pattern (str): A glob pattern, e.g. ``"**/*.py"``
namespaces (list): A list of additional info namespaces.
case_sensitive (bool): If ``True``, the path matching will be
case *sensitive* i.e. ``"FOO.py"`` and ``"foo.py"`` will
be different, otherwise path matching will be case **insensitive**.
exclude_dirs (list): A list of patterns to exclude when searching,
e.g. ``["*.git"]``.
Returns:
`Globber`: An object that may be queried for the glob matches.
"""
return Globber(
self.fs,
pattern,
path,
namespaces=namespaces,
case_sensitive=case_sensitive,
exclude_dirs=exclude_dirs,
)
|
