Improve winglob docstring.

Clarify that "right results" really means consistent with windows
behavior.
This commit is contained in:
voussoir 2021-01-25 02:45:07 -08:00
parent f7e81d4f7f
commit 51bbe54f2d
No known key found for this signature in database
GPG key ID: 5F7554F8C26DACCB

View file

@ -3,10 +3,11 @@ On Windows, square brackets do not have a special meaning in glob strings.
However, python's glob module is written for unix-style globs in which brackets
represent character classes / ranges.
On Windows we should escape those brackets to get the right results.
But calling glob.escape would also escape asterisk which may not be desired.
So this module just provides a modified version of glob.glob which will escape
only square brackets when called on windows, and behave normally on linux.
On Windows we should escape those brackets to get results that are consistent
with a Windows' user's expectations. But calling glob.escape would also escape
asterisk which may not be desired. So this module just provides a modified
version of glob.glob which will escape only square brackets when called on
Windows, and behave normally on Linux.
'''
import fnmatch as python_fnmatch
import glob as python_glob