Allow pathlib.Path object to be used in ignore items (#48)

Author: pwwang

docs/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## v0.6.3
 - Fix standard library ignoring ignores 3rd-party libraries under site-packages/
+- Allow pathlib.Path object to be used in ignore items
 
 ## v0.6.2
 - Remove argument `full` for `nameof`, use `vars_only` instead. When `vars_only=False`, source of the argument returned.

tests/test_varname.py

@@ -374,13 +374,13 @@ def test_ignore_dirname(tmp_path):
         'ignore_dirname',
         """
         from varname import varname
-        def bar():
-            return varname(ignore=[%r])
-        """ % tmp_path.as_posix(),
+        def bar(dirname):
+            return varname(ignore=[dirname])
+        """,
         tmp_path
     )
     def foo():
-        return module.bar()
+        return module.bar(tmp_path)
 
     f = foo()
     assert f == 'f'

varname/ignore.py

@@ -22,6 +22,7 @@
 import distutils.sysconfig as sysconfig
 import warnings
 from os import path
+from pathlib import Path
 from fnmatch import fnmatch
 from abc import ABC, abstractmethod
 from typing import List, Optional, Union
@@ -116,6 +117,8 @@ class IgnoreDirname(IgnoreElem, attrs=['dirname']):
     def _post_init(self) -> None:
         # pylint: disable=access-member-before-definition
         # pylint: disable=attribute-defined-outside-init
+
+        # Path object will turn into str here
         self.dirname = path.realpath(self.dirname)
 
         if not self.dirname.endswith(path.sep):
@@ -247,7 +250,7 @@ def create_ignore_elem(ignore_elem: IgnoreElemType) -> IgnoreElem:
     """Create an ignore element according to the type"""
     if isinstance(ignore_elem, ModuleType):
         return IgnoreModule(ignore_elem)
-    if isinstance(ignore_elem, str):
+    if isinstance(ignore_elem, (Path, str)):
         return (IgnoreDirname(ignore_elem)
                 if path.isdir(ignore_elem)
                 else IgnoreFilename(ignore_elem))
@@ -267,7 +270,7 @@ def create_ignore_elem(ignore_elem: IgnoreElemType) -> IgnoreElem:
 
     if isinstance(ignore_elem[0], ModuleType):
         return IgnoreModuleQualname(*ignore_elem)
-    if isinstance(ignore_elem[0], str):
+    if isinstance(ignore_elem[0], (Path, str)):
         return IgnoreFilenameQualname(*ignore_elem)
     if ignore_elem[0] is None:
         return IgnoreOnlyQualname(*ignore_elem)

varname/utils.py

@@ -15,6 +15,7 @@
 import warnings
 import inspect
 from os import path
+from pathlib import Path
 from functools import lru_cache
 from types import ModuleType, FunctionType, CodeType, FrameType
 from typing import Optional, Tuple, Union, List, MutableMapping, Callable
@@ -26,6 +27,7 @@
     ModuleType,
     # filename of a module
     str,
+    Path,
     FunctionType,
     # the module (filename) and qualname
     # If module is None, then all qualname matches the 2nd element