gh-115988: Add missing ARM64 and RISCV filter in lzma module

[ivq]

#115988

Example:

import lzma

filter = [
    { "id": lzma.FILTER_RISCV },
    { "id": lzma.FILTER_LZMA2 },
]

in_fn = "in.bin"
out_fn = "out.bin"

with open(in_fn, mode="rb") as f:
    in_data = f.read()

with lzma.open(out_fn, mode="wb", filters=filter) as f:
    f.write(in_data)

---

📚 Documentation preview 📚: https://cpython-previews--115989.org.readthedocs.build/

[ghost]

All commit authors signed the Contributor License Agreement.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[terryjreedy]

Does test_lzma test the existing constants in any way? Such as for validity of the spelling? If so, the new ones should be added.

Someone more familiar with lzma should do a commit review.

[bedevere-app]

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[ivq]

I have made the requested changes; please review again.

[terryjreedy]

I cannot do a commit review of this as it is out of my expertise. I requested reviews from two coredevs who have edited the file most recently.

[serhiy-storchaka]

They are pretty new features (https://xz.tukaani.org/format/xz-file-format-1.2.0.txt):

        1.2.0     2024-01-19    Added RISC-V filter and updated URLs in
                                Sections 0.2 and 7. The URL of this
                                specification was changed.

        1.1.0     2022-12-11    Added ARM64 filter and clarified 32-bit
                                ARM endianness in Section 5.3.2,
                                language improvements in Section 5.4

Adding support for them is a new feature in Python, so you need to add versionadded or versionchanged directives in the module documentation and add the corresponding entry in the What's New file.

You should also specify that the new filters (work? are supported? are available?) only with the specified XZ (library? file format?) version. Please add tests for new filters. They should produce expected result or raise an expected exception depending on the xz version.

I am not sure whether these constants should be defined if the underlying library does not support them. The new tests should show what is better.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[ivq]

They are pretty new features (xz.tukaani.org/format/xz-file-format-1.2.0.txt):

        1.2.0     2024-01-19    Added RISC-V filter and updated URLs in
                                Sections 0.2 and 7. The URL of this
                                specification was changed.

        1.1.0     2022-12-11    Added ARM64 filter and clarified 32-bit
                                ARM endianness in Section 5.3.2,
                                language improvements in Section 5.4

Adding support for them is a new feature in Python, so you need to add versionadded or versionchanged directives in the module documentation and add the corresponding entry in the What's New file.

You should also specify that the new filters (work? are supported? are available?) only with the specified XZ (library? file format?) version. Please add tests for new filters. They should produce expected result or raise an expected exception depending on the xz version.

I am not sure whether these constants should be defined if the underlying library does not support them. The new tests should show what is better.

OK. Done. Correct my if anything is missing.

[serhiy-storchaka]

LGTM. You only need to add an entry in the What's New document.

[StanFromIreland]

This has conflicts, and the version has to be changed to next as this is not making it to 3.13 :-(

[ivq]

Merged latest main branch and adjusted available version number. Please review.

[furkanonder]

!buildbot onder-riscv64

[bedevere-bot]

The regex 'onder-riscv64' did not match any buildbot builder. Is the requested builder in the list of stable builders?

[furkanonder]

!buildbot riscv64

[bedevere-bot]

🤖 New build scheduled with the buildbot fleet by @furkanonder for commit 1a17fd5 🤖

Results will be shown at:

https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F115989%2Fmerge

The command will test the builders whose names match following regular expression: riscv64

The builders matched are:

• riscv64 Ubuntu23 PR

[github-actions]

This PR is stale because it has been open for 30 days with no activity.

[serhiy-storchaka]

Let's remove the version attributes, they are still discussed.

@hugovk, any chance to include this in 3.15 (after excluding the discussed part)?

[hugovk]

This has been "ready" for two years, what would be the justification to include in 3.15 after the freeze?

[serhiy-storchaka]

The main reason is my feeling of guilt. We could have merged it long ago, but once again we missed the deadline.

This is not critical feature, so if no, then no. It will be in 3.16 then.

[read-the-docs-community]

Documentation build overview

📚 cpython-previews | 🛠️ Build #32871667 | 📁 Comparing 5ed9891 against main (55f2518)

  🔍 Preview build  

3 files changed

± library/lzma.html
± whatsnew/3.16.html
± whatsnew/changelog.html

[ivq]

The version attributes are removed. Hope it lands in 3.16.

[serhiy-storchaka]

Module names should be sorted alphabetically. Move this entry above os.