Merge pull request #238 from jasongrout/hiddenwarning

Trigger warning when trying to check hidden file status on PyPy

Author: jasongrout

docs/changelog.rst

@@ -14,12 +14,15 @@ See the `jupyter_core
 4.8 <https://github.com/jupyter/jupyter_core/milestone/20?closed=1>`__
 milestone on GitHub for the full list of pull requests and issues closed.
 
+jupyter-core now has experimental support for PyPy (Python 3.7). Some features are known not to work due to limitations in PyPy, such as hidden file detection on Windows.
+
 - Print an error message instead of an exception when a command is not found (:ghpull:`218`)
 - Return canonical path when using ``%APPDATA%`` on Windows (:ghpull:`222`)
 - Print full usage on missing or invalid commands (:ghpull:`225`)
 - Remove dependency on ``pywin32`` package on PyPy (:ghpull:`230`)
 - Update packages listed in ``jupyter --version`` (:ghpull:`232`)
 - Inherit base aliases/flags from traitlets Application, including ``--show-config`` from traitlets 5 (:ghpull:`233`)
+- Trigger warning when trying to check hidden file status on PyPy (:ghpull:`238`)
 
 4.7
 ---

jupyter_core/paths.py

@@ -275,6 +275,7 @@ def is_file_hidden_win(abs_path, stat_res=None):
         # allow AttributeError on PyPy for Windows
         # 'stat_result' object has no attribute 'st_file_attributes'
         # https://foss.heptapod.net/pypy/pypy/-/issues/3469
+        warnings.warn("hidden files are not detectable on this system, so no file will be marked as hidden.")
         pass
 
     return False

jupyter_core/tests/test_paths.py

@@ -12,6 +12,7 @@
 import pytest
 import subprocess
 import sys
+import warnings
 
 from jupyter_core import paths
 from jupyter_core.paths import (
@@ -260,10 +261,10 @@ def test_is_hidden():
 
 
 @pytest.mark.skipif(
-    sys.platform != "win32" or "__pypy__" in sys.modules,
-    reason="only run on windows/cpython: https://foss.heptapod.net/pypy/pypy/-/issues/3469"
+    not (sys.platform == "win32" and (("__pypy__" not in sys.modules) or (sys.implementation.version >= (7, 3, 6)))),
+    reason="only run on windows/cpython or pypy >= 7.3.6: https://foss.heptapod.net/pypy/pypy/-/issues/3469"
 )
-def test_is_hidden_win32():
+def test_is_hidden_win32_cpython():
     import ctypes
     with tempfile.TemporaryDirectory() as root:
         subdir1 = os.path.join(root, 'subdir')
@@ -273,6 +274,39 @@ def test_is_hidden_win32():
         assert is_hidden(subdir1, root)
         assert is_file_hidden(subdir1)
 
+@pytest.mark.skipif(
+    not (sys.platform == "win32" and "__pypy__" in sys.modules and sys.implementation.version < (7, 3, 6)),
+    reason="only run on windows/pypy < 7.3.6: https://foss.heptapod.net/pypy/pypy/-/issues/3469"
+)
+def test_is_hidden_win32_pypy():
+    import ctypes
+    with tempfile.TemporaryDirectory() as root:
+        subdir1 = os.path.join(root, 'subdir')
+        os.makedirs(subdir1)
+        assert not is_hidden(subdir1, root)
+        subprocess.check_call(["attrib", "+h", subdir1])
+
+        with warnings.catch_warnings(record=True) as w:
+            # Cause all warnings to always be triggered.
+            warnings.simplefilter("always")
+            # Trigger a warning.
+            assert not is_hidden(subdir1, root)
+            # Verify the warning was triggered
+            assert len(w) == 1
+            assert issubclass(w[-1].category, UserWarning)
+            assert "hidden files are not detectable on this system" in str(w[-1].message)
+
+        with warnings.catch_warnings(record=True) as w:
+            # Cause all warnings to always be triggered.
+            warnings.simplefilter("always")
+            # Trigger a warning.
+            assert not is_file_hidden(subdir1)
+            # Verify the warning was triggered
+            assert len(w) == 1
+            assert issubclass(w[-1].category, UserWarning)
+            assert "hidden files are not detectable on this system" in str(w[-1].message)
+
+
 
 @pytest.mark.skipif(sys.platform != "win32", reason="only runs on windows")
 def test_secure_write_win32():