Merge pull request #180 from facelessuser/chore/typing

Add static typing

Author: facelessuser

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
       max-parallel: 4
       matrix:
         platform: [ubuntu-latest, windows-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9, 3.10.0-beta.1]
+        python-version: [3.6, 3.7, 3.8, 3.9, '3.10']
         include:
           - python-version: 3.6
             tox-env: py36
@@ -27,11 +27,8 @@ jobs:
             tox-env: py38
           - python-version: 3.9
             tox-env: py39
-          - python-version: 3.10.0-beta.1
+          - python-version: '3.10'
             tox-env: py310
-        exclude:
-          - platform: windows-latest
-            python-version: 3.10.0-beta.1
 
     env:
       TOXENV: ${{ matrix.tox-env }}

.pyspelling.yml

@@ -67,7 +67,7 @@ matrix:
       context_visible_first: true
       delimiters:
       # Ignore lint (noqa) and coverage (pragma) as well as shebang (#!)
-      - open: '^(?: *(?:noqa\b|pragma: no cover)|!)'
+      - open: '^(?: *(?:noqa\b|pragma: no cover|type: .*?)|!)'
         close: '$'
       # Ignore Python encoding string -*- encoding stuff -*-
       - open: '^ *-\*-'

docs/src/markdown/about/changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 8.3
+
+- **NEW**: Officially support Python 3.10.
+- **NEW**: Provide type hints for API.
+- **FIX**: Gracefully handle calls with an empty pattern list.
+
 ## 8.2
 
 - **NEW**: Add support for `dir_fd` in glob patterns.

requirements/test.txt

@@ -1,3 +1,4 @@
 pytest
 pytest-cov
 coverage
+mypy

setup.py

@@ -66,6 +66,7 @@ def get_description():
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
         'Topic :: Software Development :: Libraries :: Python Modules'
     ]
 )

tests/test_fnmatch.py

@@ -708,3 +708,22 @@ def test_limit_translate(self):
 
         with self.assertRaises(_wcparse.PatternLimitException):
             fnmatch.translate('{1..11}', flags=fnmatch.BRACE, limit=10)
+
+
+class TestTypes(unittest.TestCase):
+    """Test basic sequences."""
+
+    def test_match_set(self):
+        """Test `set` matching."""
+
+        self.assertTrue(fnmatch.fnmatch('a', set(['a'])))
+
+    def test_match_tuple(self):
+        """Test `tuple` matching."""
+
+        self.assertTrue(fnmatch.fnmatch('a', tuple(['a'])))
+
+    def test_match_list(self):
+        """Test `list` matching."""
+
+        self.assertTrue(fnmatch.fnmatch('a', ['a']))

tests/test_glob.py

@@ -23,6 +23,9 @@
 import unittest
 import warnings
 import getpass
+from collections.abc import MutableMapping
+
+PY310 = (3, 10) <= sys.version_info
 
 # Below is general helper stuff that Python uses in `unittests`.  As these
 # not meant for users, and could change without notice, include them
@@ -34,6 +37,87 @@
 TESTFN = "{}_{}_tmp".format(TESTFN, os.getpid())
 
 
+class EnvironmentVarGuard(MutableMapping):
+    """
+    Class to help protect the environment variable properly.  Can be used as a context manager.
+
+    Directly ripped from Python support tools so that we can actually try and test `~user` expansion.
+
+    Taken from: https://github.com/python/cpython/blob/main/Lib/test/support/os_helper.py.
+    """
+
+    def __init__(self):
+        """Initialize."""
+
+        self._environ = os.environ
+        self._changed = {}
+
+    def __getitem__(self, envvar):
+        """Get item."""
+
+        return self._environ[envvar]
+
+    def __setitem__(self, envvar, value):
+        """Set item."""
+
+        # Remember the initial value on the first access
+        if envvar not in self._changed:
+            self._changed[envvar] = self._environ.get(envvar)
+        self._environ[envvar] = value
+
+    def __delitem__(self, envvar):
+        """Delete item."""
+
+        # Remember the initial value on the first access
+        if envvar not in self._changed:
+            self._changed[envvar] = self._environ.get(envvar)
+        if envvar in self._environ:
+            del self._environ[envvar]
+
+    def keys(self):
+        """Get keys."""
+        return self._environ.keys()
+
+    def __iter__(self):
+        """Iterate."""
+
+        return iter(self._environ)
+
+    def __len__(self):
+        """Get length."""
+        return len(self._environ)
+
+    def set(self, envvar, value):  # noqa: A003
+        """Set variable."""
+
+        self[envvar] = value
+
+    def unset(self, envvar):
+        """Unset variable."""
+
+        del self[envvar]
+
+    def copy(self):
+        """Copy environment."""
+
+        # We do what `os.environ.copy()` does.
+        return dict(self)
+
+    def __enter__(self):
+        """Enter."""
+        return self
+
+    def __exit__(self, *ignore_exc):
+        """Exit."""
+        for (k, v) in self._changed.items():
+            if v is None:
+                if k in self._environ:
+                    del self._environ[k]
+            else:
+                self._environ[k] = v
+        os.environ = self._environ
+
+
 @contextlib.contextmanager
 def change_cwd(path, quiet=False):
     """
@@ -1543,19 +1627,34 @@ def test_tilde_bytes(self):
     def test_tilde_user(self):
         """Test tilde user cases."""
 
-        # Accommodate non-Windows user behavior
-        user = None
-        if not sys.platform.startswith('win'):
-            try:
-                user = getpass.getuser()
-            except ModuleNotFoundError:
-                pass
+        if sys.platform.startswith('win') and PY310:
+            # In CI, and maybe on other systems, we cannot be sure we'll be able to get the user.
+            # So fake it by using our own user name with the current `USERPROFILE` path.
+            with EnvironmentVarGuard() as env:
+                userpath = os.environ.get('USERPROFILE')
+                env.clear()
+                user = 'test_user'
+                env['USERPROFILE'] = userpath
+                env['USERNAME'] = 'test_user'
+
+                files = os.listdir(userpath)
+                self.assertEqual(len(glob.glob('~{}/*'.format(user), flags=glob.T | glob.D)), len(files))
+        else:
+            # Accommodate non-Windows user behavior
+            user = None
+            if not sys.platform.startswith('win'):
+                try:
+                    user = getpass.getuser()
+                except ModuleNotFoundError:
+                    pass
 
-        if user is None:
-            user = os.path.basename(os.path.expanduser('~'))
+            if user is None:
+                # Last ditch effort to get a user.
+                user = os.path.basename(os.path.expanduser('~'))
 
-        files = os.listdir(os.path.expanduser('~{}'.format(user)))
-        self.assertEqual(len(glob.glob('~{}/*'.format(user), flags=glob.T | glob.D)), len(files))
+            userpath = os.path.expanduser('~{}'.format(user))
+            files = os.listdir(userpath)
+            self.assertEqual(len(glob.glob('~{}/*'.format(user), flags=glob.T | glob.D)), len(files))
 
     def test_tilde_disabled(self):
         """Test when tilde is disabled."""
@@ -1629,3 +1728,8 @@ def test_cwd_root_dir_str_bytes(self):
 
         with self.assertRaises(TypeError):
             glob.glob('docs/*', root_dir=b'.')
+
+    def test_cwd_root_dir_empty(self):
+        """Test empty patterns with current working directory."""
+
+        self.assertEqual(glob.glob([], root_dir='.'), [])

tests/test_globmatch.py

@@ -996,6 +996,12 @@ def test_unfinished_ext(self):
             self.assertTrue(glob.globmatch(x + '(a|B', x + '(a|B', flags=flags))
             self.assertFalse(glob.globmatch(x + '(a|B', 'B', flags=flags))
 
+    def test_empty_pattern_lists(self):
+        """Test empty pattern lists."""
+
+        self.assertFalse(glob.globmatch('test', []))
+        self.assertEqual(glob.globfilter(['test'], []), [])
+
     def test_windows_drives(self):
         """Test windows drives."""
 

tests/test_wcparse.py

@@ -45,38 +45,38 @@ def test_preprocessor_sequence(self):
     def test_compile_expansion_okay(self):
         """Test expansion is okay."""
 
-        self.assertEqual(len(_wcparse.compile('{1..10}', _wcparse.BRACE)), 10)
+        self.assertEqual(len(_wcparse.compile(['{1..10}'], _wcparse.BRACE)), 10)
 
     def test_compile_unique_optimization_okay(self):
         """Test that redundant patterns are reduced in compile."""
 
-        self.assertEqual(len(_wcparse.compile('|'.join(['a'] * 10), _wcparse.SPLIT, 10)), 1)
+        self.assertEqual(len(_wcparse.compile(['|'.join(['a'] * 10)], _wcparse.SPLIT, 10)), 1)
 
     def test_translate_expansion_okay(self):
         """Test expansion is okay."""
 
-        p1, p2 = _wcparse.translate('{1..10}', _wcparse.BRACE, 10)
+        p1, p2 = _wcparse.translate(['{1..10}'], _wcparse.BRACE, 10)
         count = len(p1) + len(p2)
         self.assertEqual(count, 10)
 
     def test_translate_unique_optimization_okay(self):
         """Test that redundant patterns are reduced in translate."""
-        p1, p2 = _wcparse.translate('|'.join(['a'] * 10), _wcparse.SPLIT, 10)
+        p1, p2 = _wcparse.translate(['|'.join(['a'] * 10)], _wcparse.SPLIT, 10)
         count = len(p1) + len(p2)
         self.assertEqual(count, 1)
 
     def test_expansion_limt(self):
         """Test expansion limit."""
 
         with self.assertRaises(_wcparse.PatternLimitException):
-            _wcparse.compile('{1..11}', _wcparse.BRACE, 10)
+            _wcparse.compile(['{1..11}'], _wcparse.BRACE, 10)
 
         with self.assertRaises(_wcparse.PatternLimitException):
-            _wcparse.compile('|'.join(['a'] * 11), _wcparse.SPLIT, 10)
+            _wcparse.compile(['|'.join(['a'] * 11)], _wcparse.SPLIT, 10)
 
         with self.assertRaises(_wcparse.PatternLimitException):
             _wcparse.compile(
-                '{{{},{}}}'.format('|'.join(['a'] * 6), '|'.join(['a'] * 5)),
+                ['{{{},{}}}'.format('|'.join(['a'] * 6), '|'.join(['a'] * 5))],
                 _wcparse.SPLIT | _wcparse.BRACE, 10
             )
 
@@ -90,14 +90,14 @@ def test_expansion_limt_translation(self):
         """Test expansion limit."""
 
         with self.assertRaises(_wcparse.PatternLimitException):
-            _wcparse.translate('{1..11}', _wcparse.BRACE, 10)
+            _wcparse.translate(['{1..11}'], _wcparse.BRACE, 10)
 
         with self.assertRaises(_wcparse.PatternLimitException):
-            _wcparse.translate('|'.join(['a'] * 11), _wcparse.SPLIT, 10)
+            _wcparse.translate(['|'.join(['a'] * 11)], _wcparse.SPLIT, 10)
 
         with self.assertRaises(_wcparse.PatternLimitException):
             _wcparse.translate(
-                '{{{},{}}}'.format('|'.join(['a'] * 6), '|'.join(['a'] * 5)),
+                ['{{{},{}}}'.format('|'.join(['a'] * 6), '|'.join(['a'] * 5))],
                 _wcparse.SPLIT | _wcparse.BRACE, 10
             )
 
@@ -110,12 +110,12 @@ def test_expansion_limt_translation(self):
     def test_expansion_no_limit_compile(self):
         """Test no expansion limit compile."""
 
-        self.assertEqual(len(_wcparse.compile('{1..11}', _wcparse.BRACE, -1)), 11)
+        self.assertEqual(len(_wcparse.compile(['{1..11}'], _wcparse.BRACE, -1)), 11)
 
     def test_expansion_no_limit_translate(self):
         """Test no expansion limit translate."""
 
-        p1, p2 = _wcparse.translate('{1..11}', _wcparse.BRACE, 0)
+        p1, p2 = _wcparse.translate(['{1..11}'], _wcparse.BRACE, 0)
         count = len(p1) + len(p2)
         self.assertEqual(count, 11)
 
@@ -158,3 +158,9 @@ def test_unc_pattern(self):
             _wcparse.RE_WIN_DRIVE[0].match('//?/GLOBAL/UNC/server/mount/temp').group(0),
             '//?/GLOBAL/UNC/server/mount/'
         )
+
+    def test_bad_root_dir(self):
+        """Test bad root directory."""
+
+        with self.assertRaises(TypeError):
+            _wcparse.compile(['string'], _wcparse.PATHNAME | _wcparse.REALPATH, 0).match('string', b'rdir', None)

tox.ini

@@ -10,6 +10,7 @@ deps=
     -r requirements/setup.txt
     -r requirements/test.txt
 commands=
+    {envbindir}/mypy --strict --show-error-codes --no-warn-unused-ignores wcmatch
     {envbindir}/py.test --cov wcmatch --cov-append tests
     {envbindir}/coverage html -d {envtmpdir}/coverage
     {envbindir}/coverage xml