Changes for CI tests and code clean up

joachimmetz · joachimmetz · commit 54a0f0d9a871 · 2026-05-06T19:42:23.000+02:00
diff --git a/.github/workflows/test_docker.yml b/.github/workflows/test_docker.yml
@@ -1,4 +1,4 @@
-# Run tests on Fedora and Ubuntu Docker images using GIFT CORP and GIFT PPA on commit
+# Run tests on Fedora and Ubuntu Docker images using GIFT COPR and GIFT PPA on commit
 name: test_docker
 on: [push]
 permissions: read-all
@@ -11,7 +11,7 @@ jobs:
     container:
       image: registry.fedoraproject.org/fedora:${{ matrix.version }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up container
       run: |
         dnf install -y dnf-plugins-core langpacks-en
@@ -41,7 +41,7 @@ jobs:
     container:
       image: ubuntu:${{ matrix.version }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up container
       env:
         DEBIAN_FRONTEND: noninteractive
diff --git a/.github/workflows/test_docs.yml b/.github/workflows/test_docs.yml
@@ -1,4 +1,4 @@
-# Run docs tox tests on Ubuntu Docker images using GIFT PPA
+# Run docs tox tests on Ubuntu Docker images using the deadsnakes and GIFT PPAs
 name: test_docs
 on:
   pull_request:
@@ -13,13 +13,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        include:
-        - python-version: '3.12'
-          toxenv: 'docs'
+        python-version: ['3.12']
     container:
       image: ubuntu:24.04
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up container
       env:
         DEBIAN_FRONTEND: noninteractive
@@ -41,4 +39,4 @@ jobs:
       env:
         LANG: en_US.UTF-8
       run: |
-        tox -e${{ matrix.toxenv }}
+        tox -e docs
diff --git a/.github/workflows/test_macos.yml b/.github/workflows/test_macos.yml
@@ -12,7 +12,7 @@ jobs:
           python-version: '3.14'
           toxenv: 'py314'
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
     - name: Install dependencies
       run: |
         brew update -q
diff --git a/.github/workflows/test_tox.yml b/.github/workflows/test_tox.yml
@@ -1,4 +1,4 @@
-# Run tox tests on Ubuntu Docker images using GIFT PPA
+# Run tox tests on Ubuntu Docker images using the deadsnakes and GIFT PPAs
 name: test_tox
 on:
   pull_request:
@@ -15,19 +15,19 @@ jobs:
       matrix:
         include:
         - python-version: '3.10'
-          toxenv: 'py310,wheel'
+          toxenv: 'py310'
         - python-version: '3.11'
-          toxenv: 'py311,wheel'
+          toxenv: 'py311'
         - python-version: '3.12'
-          toxenv: 'py312,wheel'
+          toxenv: 'py312'
         - python-version: '3.13'
-          toxenv: 'py313,wheel'
+          toxenv: 'py313'
         - python-version: '3.14'
-          toxenv: 'py314,wheel'
+          toxenv: 'py314'
     container:
       image: ubuntu:24.04
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up container
       env:
         DEBIAN_FRONTEND: noninteractive
@@ -49,18 +49,16 @@ jobs:
       env:
         LANG: en_US.UTF-8
       run: |
-        tox -e${{ matrix.toxenv }}
+        tox -e ${{ matrix.toxenv }},wheel
   coverage:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        include:
-        - python-version: '3.12'
-          toxenv: 'coverage'
+        python-version: ['3.12']
     container:
       image: ubuntu:24.04
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up container
       env:
         DEBIAN_FRONTEND: noninteractive
@@ -77,27 +75,25 @@ jobs:
         add-apt-repository -y ppa:deadsnakes/ppa
         add-apt-repository -y ppa:gift/dev
         apt-get update -q
-        apt-get install -y build-essential git libffi-dev pkg-config python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libewf-python3 libexe-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwps-python3 libfwsi-python3 libhmac-python3 libluksde-python3 libmodi-python3 libphdi-python3 libqcow-python3 libregf-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 libwrc-python3 python3-acstore python3-artifacts python3-cffi-backend python3-dfdatetime python3-dfimagetools python3-dfvfs python3-dfwinreg python3-dtfabric python3-idna python3-pip python3-pytsk3 python3-setuptools python3-xattr python3-yaml tox
+        apt-get install -y build-essential curl git libffi-dev pkg-config python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcaes-python3 libcreg-python3 libewf-python3 libexe-python3 libfcrypto-python3 libfsapfs-python3 libfsext-python3 libfsfat-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libfwps-python3 libfwsi-python3 libhmac-python3 libluksde-python3 libmodi-python3 libphdi-python3 libqcow-python3 libregf-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libvhdi-python3 libvmdk-python3 libvsapm-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 libwrc-python3 python3-acstore python3-artifacts python3-cffi-backend python3-dfdatetime python3-dfimagetools python3-dfvfs python3-dfwinreg python3-dtfabric python3-idna python3-pip python3-pytsk3 python3-setuptools python3-xattr python3-yaml tox
     - name: Run tests with coverage
       env:
         LANG: en_US.UTF-8
       run: |
-        tox -e${{ matrix.toxenv }}
+        tox -e coverage
     - name: Upload coverage report to Codecov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v6
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
   lint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        include:
-        - python-version: '3.12'
-          toxenv: 'lint'
+        python-version: ['3.12']
     container:
       image: ubuntu:24.04
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up container
       env:
         DEBIAN_FRONTEND: noninteractive
@@ -119,4 +115,4 @@ jobs:
       env:
         LANG: en_US.UTF-8
       run: |
-        tox -e${{ matrix.toxenv }}
+        tox -e lint
diff --git a/.pylintrc b/.pylintrc
@@ -449,7 +449,6 @@ confidence=HIGH,
 # --disable=W".
 disable=assignment-from-none,
         bad-inline-option,
-        consider-using-f-string,
         deprecated-pragma,
         duplicate-code,
         file-ignored,
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "winshlrc"
-version = "20260501"
+version = "20260506"
 description = "Windows Shell resources (winshlrc)"
 maintainers = [
     { name = "Joachim Metz", email = "joachim.metz@gmail.com" },
diff --git a/tests/resource_file.py b/tests/resource_file.py
@@ -114,7 +114,7 @@ def get_resource_by_identifier(self, identifier):
     Returns:
       object: resource or None.
     """
-    return self.resources.get(identifier, None)
+    return self.resources.get(identifier)
 
   def get_resource_by_name(self, name):
     """Retrieves a specific resource by name.
@@ -125,7 +125,7 @@ def get_resource_by_name(self, name):
     Returns:
       object: resource or None.
     """
-    return self.resources.get(name, None)
+    return self.resources.get(name)
 
 
 class WindowsResourceFileTest(test_lib.BaseTestCase):
@@ -342,7 +342,7 @@ def testOpenFileObjectAndCloseNoWrc(self):
     with open(test_file_path, 'rb') as file_object:
       windows_resource_file.OpenFileObject(file_object)
 
-      with self.assertRaises(IOError):
+      with self.assertRaises(OSError):
         windows_resource_file.OpenFileObject(file_object)
 
       windows_resource_file.Close()
@@ -358,7 +358,7 @@ def testOpenFileObjectAndCloseWrc(self):
     with open(test_file_path, 'rb') as file_object:
       windows_resource_file.OpenFileObject(file_object)
 
-      with self.assertRaises(IOError):
+      with self.assertRaises(OSError):
         windows_resource_file.OpenFileObject(file_object)
 
       windows_resource_file.Close()
diff --git a/winshlrc/extractor.py b/winshlrc/extractor.py
@@ -353,7 +353,7 @@ def _OpenWindowsResourceFileByPathSpec(self, path_spec):
 
     try:
       file_object = dfvfs_resolver.Resolver.OpenFileObject(path_spec)
-    except IOError as exception:
+    except OSError as exception:
       logging.warning(
           f'Unable to open: {path_spec.comparable:s} with error: {exception!s}')
       file_object = None
diff --git a/winshlrc/resource_file.py b/winshlrc/resource_file.py
@@ -128,11 +128,10 @@ def Close(self):
     """Closes the Windows Resource file.
 
     Raises:
-      IOError: if not open.
       OSError: if not open.
     """
     if not self._is_open:
-      raise IOError('Not opened.')
+      raise OSError('Not opened.')
 
     if self._exe_section:
       self._wrc_stream.close()
@@ -208,7 +207,7 @@ def HasStringTableResource(self):
       try:
         wrc_resource = self._wrc_stream.get_resource_by_identifier(
             self._STRING_TABLE_RESOURCE_IDENTIFIER)
-      except IOError:
+      except OSError:
         pass
 
     return bool(wrc_resource)
@@ -220,11 +219,10 @@ def OpenFileObject(self, file_object):
       file_object (file): file-like object.
 
     Raises:
-      IOError: if already open.
       OSError: if already open.
     """
     if self._is_open:
-      raise IOError('Already open.')
+      raise OSError('Already open.')
 
     self._exe_file.open_file_object(file_object)
     self._exe_section = self._exe_file.get_section_by_name('.rsrc')
diff --git a/winshlrc/scripts/extract.py b/winshlrc/scripts/extract.py
@@ -113,7 +113,7 @@ def Main():
       windows_version = source_definition['windows_version']
 
     for shell_folder in extractor_object.CollectShellFolders():
-      existing_shell_folder = shell_folders.get(shell_folder.identifier, None)
+      existing_shell_folder = shell_folders.get(shell_folder.identifier)
 
       if not existing_shell_folder:
         shell_folders[shell_folder.identifier] = shell_folder
diff --git a/winshlrc/scripts/generate_source.py b/winshlrc/scripts/generate_source.py
@@ -680,7 +680,7 @@ def GetDescription(cls, shell_folder_identifier):
       str: description represented by the shell folder identifier or None of
           not available.
     \"\"\"
-    return cls._DESCRIPTION_PER_GUID.get(shell_folder_identifier.lower(), None)
+    return cls._DESCRIPTION_PER_GUID.get(shell_folder_identifier.lower())
 """
 
 
diff --git a/winshlrc/scripts/merge_yaml.py b/winshlrc/scripts/merge_yaml.py
@@ -82,18 +82,18 @@ def Main():
   for path in glob.glob(os.path.join(options.source, '*.yaml')):
     with open(path, 'r', encoding='utf8') as file_object:
       for yaml_definition in yaml.safe_load_all(file_object):
-        csidl = yaml_definition.get('csidl', None)
-        display_name = yaml_definition.get('display_name', None)
-        default_path = yaml_definition.get('default_path', None)
-        legacy_display_name = yaml_definition.get('legacy_display_name', None)
-        legacy_default_path = yaml_definition.get('legacy_default_path', None)
-        name = yaml_definition.get('name', None)
-        identifier = yaml_definition.get('identifier', None)
+        csidl = yaml_definition.get('csidl')
+        display_name = yaml_definition.get('display_name')
+        default_path = yaml_definition.get('default_path')
+        legacy_display_name = yaml_definition.get('legacy_display_name')
+        legacy_default_path = yaml_definition.get('legacy_default_path')
+        name = yaml_definition.get('name')
+        identifier = yaml_definition.get('identifier')
 
         # Test if the identifier is a GUID value.
         _ = uuid.UUID(identifier)
 
-        known_folder_definition = known_folder_definitions.get(identifier, None)
+        known_folder_definition = known_folder_definitions.get(identifier)
         if not known_folder_definition:
           known_folder_definition = resources.KnownFolderDefinition()
           known_folder_definition.identifier = identifier
diff --git a/winshlrc/volume_scanner.py b/winshlrc/volume_scanner.py
@@ -76,7 +76,7 @@ def Open(self, path, ascii_codepage='cp1252'):
       # Note that registry_file takes over management of file_object.
       registry_file.Open(file_object)
 
-    except IOError:
+    except OSError:
       file_object.close()
       return None
 
diff --git a/winshlrc/yaml_definitions_file.py b/winshlrc/yaml_definitions_file.py
@@ -53,9 +53,9 @@ def _ReadControlPanelItemDefinition(self, yaml_control_panel_item_definition):
         yaml_control_panel_item_definition) - self._SUPPORTED_KEYS
     if different_keys:
       different_keys = ', '.join(different_keys)
-      raise RuntimeError('Undefined keys: {0:s}'.format(different_keys))
+      raise RuntimeError(f'Undefined keys: {different_keys:s}')
 
-    identifier = yaml_control_panel_item_definition.get('identifier', None)
+    identifier = yaml_control_panel_item_definition.get('identifier')
     if not identifier:
       raise RuntimeError(
           'Invalid control panel item definition missing identifier.')
@@ -65,9 +65,9 @@ def _ReadControlPanelItemDefinition(self, yaml_control_panel_item_definition):
         yaml_control_panel_item_definition.get('alternate_module_names', []))
     control_panel_item_definition.identifier = identifier
     control_panel_item_definition.module_name = (
-        yaml_control_panel_item_definition.get('module_name', None))
+        yaml_control_panel_item_definition.get('module_name'))
     control_panel_item_definition.name = (
-        yaml_control_panel_item_definition.get('name', None))
+        yaml_control_panel_item_definition.get('name'))
     control_panel_item_definition.windows_versions = (
         yaml_control_panel_item_definition.get('windows_versions', []))
 
@@ -151,22 +151,22 @@ def _ReadKnownFolderDefinition(self, yaml_known_folder_definition):
     different_keys = set(yaml_known_folder_definition) - self._SUPPORTED_KEYS
     if different_keys:
       different_keys = ', '.join(different_keys)
-      raise RuntimeError('Undefined keys: {0:s}'.format(different_keys))
+      raise RuntimeError(f'Undefined keys: {different_keys:s}')
 
-    identifier = yaml_known_folder_definition.get('identifier', None)
+    identifier = yaml_known_folder_definition.get('identifier')
     if not identifier:
       raise RuntimeError('Invalid known folder definition missing identifier.')
 
     known_folder_definition = resources.KnownFolderDefinition()
     known_folder_definition.alternate_display_names = (
         yaml_known_folder_definition.get('alternate_display_names', []))
     known_folder_definition.default_path = (
-        yaml_known_folder_definition.get('default_path', None))
+        yaml_known_folder_definition.get('default_path'))
     known_folder_definition.display_name = (
-        yaml_known_folder_definition.get('display_name', None))
+        yaml_known_folder_definition.get('display_name'))
     known_folder_definition.identifier = identifier
     known_folder_definition.name = (
-        yaml_known_folder_definition.get('name', None))
+        yaml_known_folder_definition.get('name'))
     known_folder_definition.windows_versions = (
         yaml_known_folder_definition.get('windows_versions', []))
 
@@ -245,20 +245,20 @@ def _ReadShellFolderDefinition(self, yaml_shell_folder_definition):
     different_keys = set(yaml_shell_folder_definition) - self._SUPPORTED_KEYS
     if different_keys:
       different_keys = ', '.join(different_keys)
-      raise RuntimeError('Undefined keys: {0:s}'.format(different_keys))
+      raise RuntimeError(f'Undefined keys: {different_keys:s}')
 
-    identifier = yaml_shell_folder_definition.get('identifier', None)
+    identifier = yaml_shell_folder_definition.get('identifier')
     if not identifier:
       raise RuntimeError('Invalid shell folder definition missing identifier.')
 
     shell_folder_definition = resources.ShellFolderDefinition()
     shell_folder_definition.alternate_names = (
         yaml_shell_folder_definition.get('alternate_names', []))
     shell_folder_definition.class_name = (
-        yaml_shell_folder_definition.get('class_name', None))
+        yaml_shell_folder_definition.get('class_name'))
     shell_folder_definition.identifier = identifier
     shell_folder_definition.name = (
-        yaml_shell_folder_definition.get('name', None))
+        yaml_shell_folder_definition.get('name'))
     shell_folder_definition.windows_versions = (
         yaml_shell_folder_definition.get('windows_versions', []))
 
