Run black after a version update

PR #36

Author: vxgmichel

.github/workflows/ci.yml

@@ -4,6 +4,9 @@ on:
   push:
   pull_request:
 
+env:
+  winfsp_version: "1.12.22339"
+
 jobs:
 
   Quality:
@@ -18,6 +21,7 @@ jobs:
 
     runs-on: windows-latest
     strategy:
+      fail-fast: false
       matrix:
         python_version: [cp36, cp37, cp38, cp39, cp310, cp311]
         architecture: [win32, win_amd64]
@@ -27,13 +31,13 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Install winfsp
-        run: choco install winfsp -y --version=1.10.22006
+        run: choco install winfsp -y --version=${{ env.winfsp_version }}
 
       - name: Download winfsp-tests-x86
         uses: engineerd/configurator@v0.0.6
         with:
           name: winfsp-tests-x86.exe
-          url: https://github.com/winfsp/winfsp/releases/download/v1.10/winfsp-tests-1.10.22006.zip
+          url: https://github.com/winfsp/winfsp/releases/download/v${{ env.winfsp_version }}/winfsp-tests-${{ env.winfsp_version }}.zip
           pathInArchive: winfsp-tests-x86.exe
 
       - name: Run cibuildwheel for ${{ matrix.python_version }}-${{ matrix.architecture }}
@@ -65,7 +69,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Install winfsp
-        run: choco install winfsp -y --version=1.8.20304
+        run: choco install winfsp -y --version=${{ env.winfsp_version }}
 
       - name: Set up Python
         uses: actions/setup-python@v2

src/winfspy/file_system.py

@@ -1,3 +1,7 @@
+import os
+import time
+import errno
+
 from .plumbing import ffi, lib, cook_ntstatus, nt_success, file_system_interface_trampoline_factory
 from .plumbing import WinFSPyError, FileSystemAlreadyStarted, FileSystemNotStarted
 from .operations import BaseFileSystemOperations
@@ -150,7 +154,10 @@ def _create_file_system(self):
             device_path = lib.WFSPY_FSP_FSCTL_DISK_DEVICE_NAME
 
         result = lib.FspFileSystemCreate(
-            device_path, self._volume_params, self._file_system_interface, self._file_system_ptr,
+            device_path,
+            self._volume_params,
+            self._file_system_interface,
+            self._file_system_ptr,
         )
         if not nt_success(result):
             raise WinFSPyError(f"Cannot create file system: {cook_ntstatus(result).name}")
@@ -173,6 +180,21 @@ def start(self):
         result = lib.FspFileSystemStartDispatcher(self._file_system_ptr[0], 0)
         if not nt_success(result):
             raise WinFSPyError(f"Cannot start file system dispatcher: {cook_ntstatus(result).name}")
+        # Since winfsp 1.12.22301 (2022-2), the file system might not be reachable as soon as the dispatcher is started.
+        # Instead a request might fail with the following error:
+        # [WinError 995] The I/O operation has been aborted because of either a thread exit or an application request
+        # In order to avoid this issue, we simply stat the mountpoint until it responds, with a maximum of 10 attempts.
+        attemps = 10
+        delay = 0.01  # seconds
+        for i in range(attemps):
+            try:
+                os.stat(self.mountpoint)
+                break
+            except OSError as e:
+                if e.errno == errno.EINVAL and e.winerror in (995, 1005):
+                    time.sleep(delay)
+                    continue
+                raise
 
     def restart(self, **volume_params):
         self.stop()

src/winfspy/memfs.py

@@ -195,15 +195,19 @@ def __init__(self, volume_label, read_only=False):
     def _create_directory(self, path):
         path = self._root_path / path
         obj = FolderObj(
-            path, FILE_ATTRIBUTE.FILE_ATTRIBUTE_DIRECTORY, self._root_obj.security_descriptor,
+            path,
+            FILE_ATTRIBUTE.FILE_ATTRIBUTE_DIRECTORY,
+            self._root_obj.security_descriptor,
         )
         self._entries[path] = obj
 
     def _import_files(self, file_path):
         file_path = Path(file_path)
         path = self._root_path / file_path.name
         obj = FileObj(
-            path, FILE_ATTRIBUTE.FILE_ATTRIBUTE_ARCHIVE, self._root_obj.security_descriptor,
+            path,
+            FILE_ATTRIBUTE.FILE_ATTRIBUTE_ARCHIVE,
+            self._root_obj.security_descriptor,
         )
         self._entries[path] = obj
         obj.write(file_path.read_bytes(), 0, False)
@@ -270,7 +274,10 @@ def create(
             )
         else:
             file_obj = self._entries[file_name] = FileObj(
-                file_name, file_attributes, security_descriptor, allocation_size,
+                file_name,
+                file_attributes,
+                security_descriptor,
+                allocation_size,
             )
 
         return OpenedObj(file_obj)

src/winfspy/operations.py

@@ -252,7 +252,10 @@ def ll_overwrite(
         cooked_file_context = ffi.from_handle(file_context)
         try:
             self.overwrite(
-                cooked_file_context, file_attributes, replace_file_attributes, allocation_size,
+                cooked_file_context,
+                file_attributes,
+                replace_file_attributes,
+                allocation_size,
             )
 
         except NTStatusError as exc:
@@ -261,7 +264,11 @@ def ll_overwrite(
         return self.ll_get_file_info(file_context, file_info)
 
     def overwrite(
-        self, file_context, file_attributes, replace_file_attributes: bool, allocation_size: int,
+        self,
+        file_context,
+        file_attributes,
+        replace_file_attributes: bool,
+        allocation_size: int,
     ) -> None:
         raise NotImplementedError()
 
@@ -350,7 +357,11 @@ def ll_write(
 
         try:
             p_bytes_transferred[0] = self.write(
-                cooked_file_context, cooked_buffer, offset, write_to_end_of_file, constrained_io,
+                cooked_file_context,
+                cooked_buffer,
+                offset,
+                write_to_end_of_file,
+                constrained_io,
             )
 
         except NTStatusError as exc:

src/winfspy/plumbing/file_system_interface.py

@@ -23,7 +23,10 @@ def _trampolin_fs_GetSecurityByName(
 ):
     user_context = ffi.from_handle(FileSystem.UserContext)
     return user_context.ll_get_security_by_name(
-        FileName, PFileAttributesOrReparsePointIndex, SecurityDescriptor, PSecurityDescriptorSize,
+        FileName,
+        PFileAttributesOrReparsePointIndex,
+        SecurityDescriptor,
+        PSecurityDescriptorSize,
     )
 
 
@@ -60,7 +63,12 @@ def _trampolin_fs_Open(FileSystem, FileName, CreateOptions, GrantedAccess, PFile
 
 @ffi.def_extern()
 def _trampolin_fs_Overwrite(
-    FileSystem, FileContext, FileAttributes, ReplaceFileAttributes, AllocationSize, FileInfo,
+    FileSystem,
+    FileContext,
+    FileAttributes,
+    ReplaceFileAttributes,
+    AllocationSize,
+    FileInfo,
 ):
     user_context = ffi.from_handle(FileSystem.UserContext)
     return user_context.ll_overwrite(
@@ -188,7 +196,13 @@ def _trampolin_fs_ReadDirectory(
 
 @ffi.def_extern()
 def _trampolin_fs_ResolveReparsePoints(
-    FileSystem, FileName, ReparsePointIndex, ResolveLastPathComponent, PIoStatus, Buffer, PSize,
+    FileSystem,
+    FileName,
+    ReparsePointIndex,
+    ResolveLastPathComponent,
+    PIoStatus,
+    Buffer,
+    PSize,
 ):
     user_context = ffi.from_handle(FileSystem.UserContext)
     return user_context.ll_resolve_reparse_points(

src/winfspy/plumbing/get_winfsp_dir.py

@@ -61,5 +61,5 @@ def get_winfsp_bin_dir():
 def get_winfsp_library_name():
     # See:
     # https://docs.python.org/3/library/platform.html#platform.architecture
-    is_64bits = sys.maxsize > 2 ** 32
+    is_64bits = sys.maxsize > 2**32
     return "winfsp-" + ("x64" if is_64bits else "x86")

src/winfspy/plumbing/win32_filetime.py

@@ -98,7 +98,10 @@ def filetime_to_dt(ft):
     >>> assert dt_to_filetime(filetime_to_dt(now)) == now, now
     """
     milliseconds = (ft - EPOCH_AS_FILETIME) // MILLISEDCONDS_TO_HNS
-    return datetime.fromtimestamp(milliseconds / MILLISECONDS, timezone.utc,)
+    return datetime.fromtimestamp(
+        milliseconds / MILLISECONDS,
+        timezone.utc,
+    )
 
 
 def filetime_now():

src/winfspy/tests/fixtures.py

@@ -14,7 +14,10 @@ def pytest_addoption(parser):
             help="A path to the file system to test",
         )
         parser.addoption(
-            "--enable-stream-tests", action="store_true", default=False, help="Enable stream tests",
+            "--enable-stream-tests",
+            action="store_true",
+            default=False,
+            help="Enable stream tests",
         )
     # Options already added (via the pluging module)
     except ValueError:

src/winfspy/tests/winfstest/test_winfs.py

@@ -106,8 +106,11 @@ def create_file(
     security_attributes = win32security.SECURITY_ATTRIBUTES()
     security_attributes.bInheritHandle = 0
     if sddl:
-        security_attributes.SECURITY_DESCRIPTOR = win32security.ConvertStringSecurityDescriptorToSecurityDescriptor(
-            sddl, win32security.SDDL_REVISION_1,
+        security_attributes.SECURITY_DESCRIPTOR = (
+            win32security.ConvertStringSecurityDescriptorToSecurityDescriptor(
+                sddl,
+                win32security.SDDL_REVISION_1,
+            )
         )
 
     # Windows API call
@@ -172,8 +175,11 @@ def create_directory(path, sddl):
     security_attributes = win32security.SECURITY_ATTRIBUTES()
     security_attributes.bInheritHandle = 0
     if sddl:
-        security_attributes.SECURITY_DESCRIPTOR = win32security.ConvertStringSecurityDescriptorToSecurityDescriptor(
-            sddl, win32security.SDDL_REVISION_1,
+        security_attributes.SECURITY_DESCRIPTOR = (
+            win32security.ConvertStringSecurityDescriptorToSecurityDescriptor(
+                sddl,
+                win32security.SDDL_REVISION_1,
+            )
         )
 
     # Windows API call
@@ -213,7 +219,9 @@ def set_end_of_file(path, length):
     # Second windows API call
     assert handle != win32file.INVALID_HANDLE_VALUE
     win32file.SetFileInformationByHandle(
-        handle, SYMBOLS.FileEndOfFileInfo, length,
+        handle,
+        SYMBOLS.FileEndOfFileInfo,
+        length,
     )
 
     # Close the handle
@@ -251,7 +259,10 @@ def prepare(x):
     # Second windows API call
     assert handle != win32file.INVALID_HANDLE_VALUE
     win32file.SetFileTime(
-        handle, creation_time, last_access_time, last_write_time,
+        handle,
+        creation_time,
+        last_access_time,
+        last_write_time,
     )
 
     # Close the handle
@@ -280,7 +291,8 @@ def get_file_security(path, info):
 def set_file_security(path, info, sddl):
     # Create security descriptor
     descriptor = win32security.ConvertStringSecurityDescriptorToSecurityDescriptor(
-        sddl, win32security.SDDL_REVISION_1,
+        sddl,
+        win32security.SDDL_REVISION_1,
     )
 
     # Windows api call
@@ -428,7 +440,9 @@ def runner(fn, *args, **kwargs):
 
 
 @pytest.mark.parametrize(
-    "test_module_path", TEST_MODULES, ids=[path.name for path in TEST_MODULES],
+    "test_module_path",
+    TEST_MODULES,
+    ids=[path.name for path in TEST_MODULES],
 )
 def test_winfs(test_module_path, file_system_path, process_runner):
     parser = partial(parse_argument, file_system_path)