fix: added support for custom file extension with multiple parts

[tolgaeren]

Description

This PR modifies the single_file.py to add support for multiple extension parts. An example is setting "tar.gz" as the custom _file_extention string:

class DotInFileExtension(SingleFileSnapshotExtension):
    _file_extension = "tar.gz"

Previously this was causing some unexpected behavior as described in #703 . I've found the problematic part in SingleFileSnapshotExtension._read_snapshot_collection in single_file.py:

 snapshot_collection.add(Snapshot(name=Path(snapshot_location).stem))

.stem only removes the last extension not all the extensions as documented. We would like to remove as many extensions as there are in the _file_extension string.

There are a few ways to fix it:

1. Calling .stem as many times as number of extensions.
2. Calling .with_suffix("") as many times as the number of extensions.
3. Replacing the self._file_extension at the end of snapsot_location with "".

I tried option 3 first, it seemed to break a lot of other tests. Then I picked option 1 as it seemed it was the closest to original implementation. Let me know if you think of a better way to do it.

Added a test under test_single_file.py as it seemed like the right location for it.

Related Issues

• Closes having a dot in the file extension causes unexpected behavior #703 , a short description of the linked issue.

Checklist

• This PR has sufficient documentation.
• This PR has sufficient test coverage.
• This PR title satisfies semantic convention.

Additional Comments

No additional comments.

[noahnu]

Ignore the benchmark failure, it's a permissions issue. I'll try take a look at this PR in the next couple days. Rather than loop through stems, I feel like there should be some sort of "basename without user supplied extension" function in the python stdlib.

[tolgaeren]

"basename without user supplied extension"

I don't like the loop either. I looked for this but couldn't find it😀 if I can find some time tomorrow, I'll check the stem implementation and get some inspiration from that 😅

[noahnu]

I couldn't make your test fail on main, so I've replaced it with more of an integration test.

[tolgaeren]

I think you couldn't trigger the test because of a typo:

class DotInFileExtension(SingleFileSnapshotExtension):
    _file_extension = "{file_extension}"

The f was missing before the f-string :) That was fixed when you moved it into an integration test setup.

Anyways, thank you for the merge!

[noahnu]

@all-contributors add @tolgaeren for bug

[allcontributors]

@noahnu

I've put up a pull request to add @tolgaeren! 🎉

[tophat-opensource-bot]

🎉 This PR is included in version 4.0.1 🎉

The release is available on:

• v4.0.1
• GitHub release

Your semantic-release bot 📦🚀