Support all tar archives in create and extract

[hagenw]

This adds support to not only create and extract tar.gz files, but all other tar files as well.

In addition, audeer.create_archive() and audeer.extract_archive() were slightly refactored to improve the code quality.

Updated docstring of audeer.create_archive():

Updated docstring of audeer.extract_archive():

Updated docstring of audeer.extract_archives():

Summary by Sourcery

Extend archive creation and extraction to support all tar formats, including tar, tar.gz, tar.bz2, and tar.xz.

New Features:

• Support for creating and extracting all tar archive formats, including .tar, .tar.gz, .tar.bz2, and .tar.xz, has been added.

Tests:

• Added tests for the new tar archive formats

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request extends the support for TAR archives in the create_archive and extract_archive functions to include all supported TAR formats, not just TAR.GZ. It also includes minor refactoring to improve code quality and updates the docstrings of related functions.

Sequence diagram for improved archive creation process

sequenceDiagram
    participant Client
    participant CreateArchive
    participant ArchiveHandlers
    participant FileSystem

    Client->>CreateArchive: create_archive(root, files, archive)
    CreateArchive->>ArchiveHandlers: Get handler for extension
    alt zip format
        ArchiveHandlers-->>CreateArchive: Return ZIP handler
        CreateArchive->>FileSystem: Write files using ZIP_DEFLATED
    else tar format
        ArchiveHandlers-->>CreateArchive: Return appropriate TAR handler
        Note right of ArchiveHandlers: Supports tar, tar.gz, tar.bz2, tar.xz
        CreateArchive->>FileSystem: Write files using selected compression
    end
    CreateArchive-->>Client: Archive created

Loading

Sequence diagram for enhanced archive extraction process

sequenceDiagram
    participant Client
    participant ExtractArchive
    participant Archive
    participant FileSystem

    Client->>ExtractArchive: extract_archive(archive, destination)
    alt zip format
        ExtractArchive->>Archive: Open as ZIP
        Archive->>FileSystem: Extract members
    else tar format
        ExtractArchive->>Archive: Check if tarfile
        Archive->>FileSystem: Extract members with appropriate handler
    end
    ExtractArchive-->>Client: Return extracted files

Loading

Class diagram for archive handlers structure

classDiagram
    class ArchiveHandlers {
        +Dict handlers
        +handle_zip()
        +handle_tar()
        +handle_tar_gz()
        +handle_tar_bz2()
        +handle_tar_xz()
    }

    class CreateArchive {
        +create_archive(root, files, archive)
    }

    class ExtractArchive {
        +extract_archive(archive, destination)
        +extract_zip(archive)
        +extract_tar(archive)
    }

    CreateArchive --> ArchiveHandlers
    ExtractArchive --> ArchiveHandlers
    note for ArchiveHandlers "New unified handler system"
    note for ExtractArchive "Refactored with separate
extraction methods"

Loading

File-Level Changes

Change	Details	Files
Added support for all TAR archive formats	Modified create_archive to handle '.tar', '.tar.gz', '.tar.bz2', and '.tar.xz' formats. Updated extract_archive to handle all TAR formats using tarfile.is_tarfile(). Added tests for the new TAR formats in test_io.py. Updated docstrings to reflect the broader TAR support	audeer/core/io.py tests/test_io.py
Refactored archive handling logic	Simplified the archive creation and extraction logic by using a dictionary to map file extensions to archive handlers. Improved code readability and maintainability	audeer/core/io.py
Updated docstrings	Clarified the supported archive formats in the docstrings of create_archive, extract_archive, and extract_archives. Included examples of usage for the different archive types	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: 1 issue found
• 🟢 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.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.0%. Comparing base (4592c91) to head (9fddb1d).
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%> (ø)

[ChristianGeng]

Single issues have been discussed in separate threads.
As these are resolved I think that it will be safe to proceed and give approval.