Filter tar in extract_archive() for Python>=3.12

[hagenw]

In Python 3.12 the filter argument was introduced to TarFile.extract(), see tarfile.TarFile.extract and tarfile-extraction-filter.

When testing with Python 3.13 it raises the following deprecation warning:

.../audeer/core/io.py:374: DeprecationWarning: Python 3.14 will, by default,
filter extracted tar archives and reject files or modify their metadata.
Use the filter argument to control this behavior.

To avoid this, and make it also safe when Python 3.14 is introduced, this pull requests adds filter="tar" when extracting a tar archive in audeer.extract_archive() in Python >=3.12.

Summary by Sourcery

Bug Fixes:

• Add the 'filter' argument to TarFile.extract() in extract_archive() for Python >=3.12 to prevent deprecation warnings in future Python versions.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.0%. Comparing base (92e64c6) to head (937013a).
Report is 1 commits behind head on main.

Additional details and impacted files

Files with missing lines	Coverage Δ
audeer/core/io.py	100.0% <100.0%> (ø)

[hagenw]

@sourcery-ai review

[sourcery-ai]

Reviewer's Guide by Sourcery

The PR updates the extract_archive() function to handle the new filter parameter introduced in Python 3.12 for tar file extraction. The implementation uses version checking to conditionally add the filter parameter, ensuring compatibility with Python 3.12+ while maintaining backward compatibility with older versions.

Class diagram for extract_archive() function update

classDiagram
    class ExtractArchive {
        +extract_archive()
    }
    class TarFile {
        +extract(member, destination, numeric_owner=True)
    }
    ExtractArchive --|> TarFile : uses
    note for ExtractArchive "Updated to include filter parameter for Python >= 3.12"
    note for TarFile "Python 3.12 introduces filter argument"

Loading

File-Level Changes

Change	Details	Files
Added version-specific handling for tar file extraction	Created a kwargs dictionary to store extraction parameters Added version check for Python 3.12 and above Conditionally added 'filter="tar"' parameter for Python 3.12+ Updated extract call to use kwargs unpacking	audeer/core/io.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @hagenw - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[ChristianGeng]

The version-specific choice of a sane default for the filter argument has been discussed in a separate thread that is settled now.

Therefore it feels safe to approve right now.