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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gpshead merged 28 commits into from
May 28, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
68979bc
Add missing ARM64 and RISCV filter in lzma module
ivq Feb 27, 2024
3fa0c17
Suppress doc warning "py:const reference target not found"
ivq Feb 28, 2024
c1e166a
Add lzma version
ivq Mar 17, 2024
ea51476
Add ARM64, RISC-V filter test case
ivq Mar 17, 2024
6189ceb
Update lzma doc
ivq Mar 17, 2024
0f6fd63
Add NEWS entry
ivq Mar 17, 2024
9731225
Optimise NEWS
ivq Mar 18, 2024
40e9d34
Move version doc section
ivq Mar 19, 2024
8c922f7
Add WHATSNEW entry
ivq Mar 19, 2024
9cd4cb8
Fix filter chain specs position
ivq Mar 19, 2024
8a85c48
Suppress doc warning
ivq Mar 22, 2024
32725a7
Elide upstream binary data from the test.
gpshead Mar 30, 2024
6d94a08
Clarify the documentation a bit.
gpshead Mar 30, 2024
c62ca63
Clarifying comment, docs accuracy.
gpshead Mar 30, 2024
045aa40
Expose the version as a number.
gpshead Mar 30, 2024
8f49f69
Merge branch 'main' into xz_bcj_filters
gpshead Mar 30, 2024
832335d
minor version explanation tweak.
gpshead Mar 30, 2024
728f286
Adjust the whats new text.
gpshead Mar 30, 2024
61c4adf
NEWS wording and formatting tweak.
gpshead Mar 30, 2024
98adeee
line length
gpshead Mar 30, 2024
449b722
Merge remote-tracking branch 'origin/main' into xz_bcj_filters
ivq Jul 13, 2025
f381ca5
We've missed the 3.13 window
ivq Jul 13, 2025
9f0d4d4
Fix accidentally removed newline when merging remote main
ivq Jul 13, 2025
1a17fd5
Remove unused import
ivq Jul 13, 2025
78e7d9a
Merge remote-tracking branch 'origin/main' into xz_bcj_filters
ivq May 27, 2026
9cc998f
Remove lzma version constants
ivq May 27, 2026
5ed9891
versionadded "next" in rst
gpshead May 27, 2026
b52d942
Put whatsnew entry alphabetically
ivq May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions Doc/library/lzma.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

* :const:`FILTER_X86`
* :const:`FILTER_IA64`
* :const:`FILTER_ARM`
* :const:`FILTER_ARMTHUMB`
* :const:`FILTER_POWERPC`
* :const:`FILTER_SPARC`
* :const:`!FILTER_X86`
* :const:`!FILTER_IA64`
* :const:`!FILTER_ARM`
* :const:`!FILTER_ARMTHUMB`
* :const:`!FILTER_POWERPC`
* :const:`!FILTER_SPARC`

The above work on all lzma runtime library versions.

* :const:`!FILTER_ARM64`

Only works if the lzma version is 5.4.0 or later.

.. versionadded:: next

* :const:`!FILTER_RISCV`

Only works if the lzma version is 5.6.0 or later.

.. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down
9 changes: 9 additions & 0 deletions Doc/whatsnew/3.16.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
(Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
:const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
new filters will work only if runtime library supports them. ARM64 filter
requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
(Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down
1 change: 1 addition & 0 deletions Lib/lzma.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
"CHECK_ID_MAX", "CHECK_UNKNOWN",
"FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
"FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
"FILTER_ARM64", "FILTER_RISCV",
"FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
"MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
"MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down
6 changes: 6 additions & 0 deletions Lib/test/test_lzma.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
decompress(bytes()), b'')

def test_riscv_filter_constant_exists(self):
self.assertTrue(lzma.FILTER_RISCV)

def test_arm64_filter_constant_exists(self):
self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.
21 changes: 20 additions & 1 deletion Modules/_lzmamodule.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
#error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
* If the lzma.h we're building against is so old as not to define these, this
* provides their equivalent values so that the names remain defined in Python
* regardless of the header versions used at build time.
*/
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.
#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
case LZMA_FILTER_ARM:
case LZMA_FILTER_ARMTHUMB:
case LZMA_FILTER_SPARC:
case LZMA_FILTER_ARM64:
case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.
f->options = parse_filter_spec_bcj(state, spec);
return f->options != NULL;
default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
case LZMA_FILTER_IA64:
case LZMA_FILTER_ARM:
case LZMA_FILTER_ARMTHUMB:
case LZMA_FILTER_SPARC: {
case LZMA_FILTER_SPARC:
case LZMA_FILTER_ARM64:
case LZMA_FILTER_RISCV: {
lzma_options_bcj *options = f->options;
if (options) {
ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
ADD_INT_PREFIX_MACRO(module, MF_HC3);
ADD_INT_PREFIX_MACRO(module, MF_HC4);
ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
gh-115988: Add missing ARM64 and RISCV filter in lzma module#115989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

gpshead
merged 28 commits into

from

May 28, 2026
 Merged


gh-115988: Add missing ARM64 and RISCV filter in lzma module
#115989
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


28 commits


Select commit
Hold shift + click to select a range
68979bc

Add missing ARM64 and RISCV filter in lzma module


ivq Feb 27, 2024
3fa0c17

Suppress doc warning "py:const reference target not found"


ivq Feb 28, 2024
c1e166a

Add lzma version


ivq Mar 17, 2024
ea51476

Add ARM64, RISC-V filter test case


ivq Mar 17, 2024
6189ceb

Update lzma doc


ivq Mar 17, 2024
0f6fd63

Add NEWS entry


ivq Mar 17, 2024
9731225

Optimise NEWS


ivq Mar 18, 2024
40e9d34

Move version doc section


ivq Mar 19, 2024
8c922f7

Add WHATSNEW entry


ivq Mar 19, 2024
9cd4cb8

Fix filter chain specs position


ivq Mar 19, 2024
8a85c48

Suppress doc warning


ivq Mar 22, 2024
32725a7

Elide upstream binary data from the test.


gpshead Mar 30, 2024
6d94a08

Clarify the documentation a bit.


gpshead Mar 30, 2024
c62ca63

Clarifying comment, docs accuracy.


gpshead Mar 30, 2024
045aa40

Expose the version as a number.


gpshead Mar 30, 2024
8f49f69

Merge branch 'main' into xz_bcj_filters


gpshead Mar 30, 2024
832335d

minor version explanation tweak.


gpshead Mar 30, 2024
728f286

Adjust the whats new text.


gpshead Mar 30, 2024
61c4adf

NEWS wording and formatting tweak.


gpshead Mar 30, 2024
98adeee

line length


gpshead Mar 30, 2024
449b722

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq Jul 13, 2025
f381ca5

We've missed the 3.13 window


ivq Jul 13, 2025
9f0d4d4

Fix accidentally removed newline when merging remote main


ivq Jul 13, 2025
1a17fd5

Remove unused import


ivq Jul 13, 2025
78e7d9a

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq May 27, 2026
9cc998f

Remove lzma version constants


ivq May 27, 2026
5ed9891

versionadded "next" in rst


gpshead May 27, 2026
b52d942

Put whatsnew entry alphabetically


ivq May 28, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 20 additions & 6 deletions
Doc/library/lzma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

 * :const:`FILTER_X86`
 * :const:`FILTER_IA64`
 * :const:`FILTER_ARM`
 * :const:`FILTER_ARMTHUMB`
 * :const:`FILTER_POWERPC`
 * :const:`FILTER_SPARC`
 * :const:`!FILTER_X86`
 * :const:`!FILTER_IA64`
 * :const:`!FILTER_ARM`
 * :const:`!FILTER_ARMTHUMB`
 * :const:`!FILTER_POWERPC`
 * :const:`!FILTER_SPARC`

 The above work on all lzma runtime library versions.

 * :const:`!FILTER_ARM64`

 Only works if the lzma version is 5.4.0 or later.

 .. versionadded:: next

 * :const:`!FILTER_RISCV`

 Only works if the lzma version is 5.6.0 or later.

 .. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down

9 changes: 9 additions & 0 deletions
Doc/whatsnew/3.16.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
 which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
 (Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
 :const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
 new filters will work only if runtime library supports them. ARM64 filter
 requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
 (Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down

1 change: 1 addition & 0 deletions
Lib/lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
 "CHECK_ID_MAX", "CHECK_UNKNOWN",
 "FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
 "FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
 "FILTER_ARM64", "FILTER_RISCV",
 "FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
 "MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
 "MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down

6 changes: 6 additions & 0 deletions
Lib/test/test_lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
 self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
 decompress(bytes()), b'')

 def test_riscv_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_RISCV)

 def test_arm64_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down

1 change: 1 addition & 0 deletions
Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.

21 changes: 20 additions & 1 deletion
Modules/_lzmamodule.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
 #error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
 * If the lzma.h we're building against is so old as not to define these, this
 * provides their equivalent values so that the names remain defined in Python
 * regardless of the header versions used at build time.
 */
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.

#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
 On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.

 f->options = parse_filter_spec_bcj(state, spec);
 return f->options != NULL;
 default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
 case LZMA_FILTER_IA64:
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC: {
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV: {
 lzma_options_bcj *options = f->options;
 if (options) {
 ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
 ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
 ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
 ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
 ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
 ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
 ADD_INT_PREFIX_MACRO(module, MF_HC3);
 ADD_INT_PREFIX_MACRO(module, MF_HC4);
 ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
gh-115988: Add missing ARM64 and RISCV filter in lzma module#115989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

gpshead
merged 28 commits into

from

May 28, 2026
 Merged


gh-115988: Add missing ARM64 and RISCV filter in lzma module
#115989
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


28 commits


Select commit
Hold shift + click to select a range
68979bc

Add missing ARM64 and RISCV filter in lzma module


ivq Feb 27, 2024
3fa0c17

Suppress doc warning "py:const reference target not found"


ivq Feb 28, 2024
c1e166a

Add lzma version


ivq Mar 17, 2024
ea51476

Add ARM64, RISC-V filter test case


ivq Mar 17, 2024
6189ceb

Update lzma doc


ivq Mar 17, 2024
0f6fd63

Add NEWS entry


ivq Mar 17, 2024
9731225

Optimise NEWS


ivq Mar 18, 2024
40e9d34

Move version doc section


ivq Mar 19, 2024
8c922f7

Add WHATSNEW entry


ivq Mar 19, 2024
9cd4cb8

Fix filter chain specs position


ivq Mar 19, 2024
8a85c48

Suppress doc warning


ivq Mar 22, 2024
32725a7

Elide upstream binary data from the test.


gpshead Mar 30, 2024
6d94a08

Clarify the documentation a bit.


gpshead Mar 30, 2024
c62ca63

Clarifying comment, docs accuracy.


gpshead Mar 30, 2024
045aa40

Expose the version as a number.


gpshead Mar 30, 2024
8f49f69

Merge branch 'main' into xz_bcj_filters


gpshead Mar 30, 2024
832335d

minor version explanation tweak.


gpshead Mar 30, 2024
728f286

Adjust the whats new text.


gpshead Mar 30, 2024
61c4adf

NEWS wording and formatting tweak.


gpshead Mar 30, 2024
98adeee

line length


gpshead Mar 30, 2024
449b722

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq Jul 13, 2025
f381ca5

We've missed the 3.13 window


ivq Jul 13, 2025
9f0d4d4

Fix accidentally removed newline when merging remote main


ivq Jul 13, 2025
1a17fd5

Remove unused import


ivq Jul 13, 2025
78e7d9a

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq May 27, 2026
9cc998f

Remove lzma version constants


ivq May 27, 2026
5ed9891

versionadded "next" in rst


gpshead May 27, 2026
b52d942

Put whatsnew entry alphabetically


ivq May 28, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 20 additions & 6 deletions
Doc/library/lzma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

 * :const:`FILTER_X86`
 * :const:`FILTER_IA64`
 * :const:`FILTER_ARM`
 * :const:`FILTER_ARMTHUMB`
 * :const:`FILTER_POWERPC`
 * :const:`FILTER_SPARC`
 * :const:`!FILTER_X86`
 * :const:`!FILTER_IA64`
 * :const:`!FILTER_ARM`
 * :const:`!FILTER_ARMTHUMB`
 * :const:`!FILTER_POWERPC`
 * :const:`!FILTER_SPARC`

 The above work on all lzma runtime library versions.

 * :const:`!FILTER_ARM64`

 Only works if the lzma version is 5.4.0 or later.

 .. versionadded:: next

 * :const:`!FILTER_RISCV`

 Only works if the lzma version is 5.6.0 or later.

 .. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down

9 changes: 9 additions & 0 deletions
Doc/whatsnew/3.16.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
 which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
 (Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
 :const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
 new filters will work only if runtime library supports them. ARM64 filter
 requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
 (Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down

1 change: 1 addition & 0 deletions
Lib/lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
 "CHECK_ID_MAX", "CHECK_UNKNOWN",
 "FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
 "FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
 "FILTER_ARM64", "FILTER_RISCV",
 "FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
 "MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
 "MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down

6 changes: 6 additions & 0 deletions
Lib/test/test_lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
 self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
 decompress(bytes()), b'')

 def test_riscv_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_RISCV)

 def test_arm64_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down

1 change: 1 addition & 0 deletions
Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.

21 changes: 20 additions & 1 deletion
Modules/_lzmamodule.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
 #error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
 * If the lzma.h we're building against is so old as not to define these, this
 * provides their equivalent values so that the names remain defined in Python
 * regardless of the header versions used at build time.
 */
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.

#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
 On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.

 f->options = parse_filter_spec_bcj(state, spec);
 return f->options != NULL;
 default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
 case LZMA_FILTER_IA64:
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC: {
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV: {
 lzma_options_bcj *options = f->options;
 if (options) {
 ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
 ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
 ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
 ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
 ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
 ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
 ADD_INT_PREFIX_MACRO(module, MF_HC3);
 ADD_INT_PREFIX_MACRO(module, MF_HC4);
 ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
gh-115988: Add missing ARM64 and RISCV filter in lzma module#115989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

gpshead
merged 28 commits into

from

May 28, 2026
 Merged


gh-115988: Add missing ARM64 and RISCV filter in lzma module
#115989
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


28 commits


Select commit
Hold shift + click to select a range
68979bc

Add missing ARM64 and RISCV filter in lzma module


ivq Feb 27, 2024
3fa0c17

Suppress doc warning "py:const reference target not found"


ivq Feb 28, 2024
c1e166a

Add lzma version


ivq Mar 17, 2024
ea51476

Add ARM64, RISC-V filter test case


ivq Mar 17, 2024
6189ceb

Update lzma doc


ivq Mar 17, 2024
0f6fd63

Add NEWS entry


ivq Mar 17, 2024
9731225

Optimise NEWS


ivq Mar 18, 2024
40e9d34

Move version doc section


ivq Mar 19, 2024
8c922f7

Add WHATSNEW entry


ivq Mar 19, 2024
9cd4cb8

Fix filter chain specs position


ivq Mar 19, 2024
8a85c48

Suppress doc warning


ivq Mar 22, 2024
32725a7

Elide upstream binary data from the test.


gpshead Mar 30, 2024
6d94a08

Clarify the documentation a bit.


gpshead Mar 30, 2024
c62ca63

Clarifying comment, docs accuracy.


gpshead Mar 30, 2024
045aa40

Expose the version as a number.


gpshead Mar 30, 2024
8f49f69

Merge branch 'main' into xz_bcj_filters


gpshead Mar 30, 2024
832335d

minor version explanation tweak.


gpshead Mar 30, 2024
728f286

Adjust the whats new text.


gpshead Mar 30, 2024
61c4adf

NEWS wording and formatting tweak.


gpshead Mar 30, 2024
98adeee

line length


gpshead Mar 30, 2024
449b722

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq Jul 13, 2025
f381ca5

We've missed the 3.13 window


ivq Jul 13, 2025
9f0d4d4

Fix accidentally removed newline when merging remote main


ivq Jul 13, 2025
1a17fd5

Remove unused import


ivq Jul 13, 2025
78e7d9a

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq May 27, 2026
9cc998f

Remove lzma version constants


ivq May 27, 2026
5ed9891

versionadded "next" in rst


gpshead May 27, 2026
b52d942

Put whatsnew entry alphabetically


ivq May 28, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 20 additions & 6 deletions
Doc/library/lzma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

 * :const:`FILTER_X86`
 * :const:`FILTER_IA64`
 * :const:`FILTER_ARM`
 * :const:`FILTER_ARMTHUMB`
 * :const:`FILTER_POWERPC`
 * :const:`FILTER_SPARC`
 * :const:`!FILTER_X86`
 * :const:`!FILTER_IA64`
 * :const:`!FILTER_ARM`
 * :const:`!FILTER_ARMTHUMB`
 * :const:`!FILTER_POWERPC`
 * :const:`!FILTER_SPARC`

 The above work on all lzma runtime library versions.

 * :const:`!FILTER_ARM64`

 Only works if the lzma version is 5.4.0 or later.

 .. versionadded:: next

 * :const:`!FILTER_RISCV`

 Only works if the lzma version is 5.6.0 or later.

 .. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down

9 changes: 9 additions & 0 deletions
Doc/whatsnew/3.16.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
 which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
 (Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
 :const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
 new filters will work only if runtime library supports them. ARM64 filter
 requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
 (Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down

1 change: 1 addition & 0 deletions
Lib/lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
 "CHECK_ID_MAX", "CHECK_UNKNOWN",
 "FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
 "FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
 "FILTER_ARM64", "FILTER_RISCV",
 "FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
 "MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
 "MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down

6 changes: 6 additions & 0 deletions
Lib/test/test_lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
 self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
 decompress(bytes()), b'')

 def test_riscv_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_RISCV)

 def test_arm64_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down

1 change: 1 addition & 0 deletions
Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.

21 changes: 20 additions & 1 deletion
Modules/_lzmamodule.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
 #error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
 * If the lzma.h we're building against is so old as not to define these, this
 * provides their equivalent values so that the names remain defined in Python
 * regardless of the header versions used at build time.
 */
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.

#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
 On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.

 f->options = parse_filter_spec_bcj(state, spec);
 return f->options != NULL;
 default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
 case LZMA_FILTER_IA64:
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC: {
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV: {
 lzma_options_bcj *options = f->options;
 if (options) {
 ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
 ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
 ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
 ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
 ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
 ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
 ADD_INT_PREFIX_MACRO(module, MF_HC3);
 ADD_INT_PREFIX_MACRO(module, MF_HC4);
 ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
gh-115988: Add missing ARM64 and RISCV filter in lzma module#115989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

gpshead
merged 28 commits into

from

May 28, 2026
 Merged


gh-115988: Add missing ARM64 and RISCV filter in lzma module
#115989
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


28 commits


Select commit
Hold shift + click to select a range
68979bc

Add missing ARM64 and RISCV filter in lzma module


ivq Feb 27, 2024
3fa0c17

Suppress doc warning "py:const reference target not found"


ivq Feb 28, 2024
c1e166a

Add lzma version


ivq Mar 17, 2024
ea51476

Add ARM64, RISC-V filter test case


ivq Mar 17, 2024
6189ceb

Update lzma doc


ivq Mar 17, 2024
0f6fd63

Add NEWS entry


ivq Mar 17, 2024
9731225

Optimise NEWS


ivq Mar 18, 2024
40e9d34

Move version doc section


ivq Mar 19, 2024
8c922f7

Add WHATSNEW entry


ivq Mar 19, 2024
9cd4cb8

Fix filter chain specs position


ivq Mar 19, 2024
8a85c48

Suppress doc warning


ivq Mar 22, 2024
32725a7

Elide upstream binary data from the test.


gpshead Mar 30, 2024
6d94a08

Clarify the documentation a bit.


gpshead Mar 30, 2024
c62ca63

Clarifying comment, docs accuracy.


gpshead Mar 30, 2024
045aa40

Expose the version as a number.


gpshead Mar 30, 2024
8f49f69

Merge branch 'main' into xz_bcj_filters


gpshead Mar 30, 2024
832335d

minor version explanation tweak.


gpshead Mar 30, 2024
728f286

Adjust the whats new text.


gpshead Mar 30, 2024
61c4adf

NEWS wording and formatting tweak.


gpshead Mar 30, 2024
98adeee

line length


gpshead Mar 30, 2024
449b722

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq Jul 13, 2025
f381ca5

We've missed the 3.13 window


ivq Jul 13, 2025
9f0d4d4

Fix accidentally removed newline when merging remote main


ivq Jul 13, 2025
1a17fd5

Remove unused import


ivq Jul 13, 2025
78e7d9a

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq May 27, 2026
9cc998f

Remove lzma version constants


ivq May 27, 2026
5ed9891

versionadded "next" in rst


gpshead May 27, 2026
b52d942

Put whatsnew entry alphabetically


ivq May 28, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 20 additions & 6 deletions
Doc/library/lzma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

 * :const:`FILTER_X86`
 * :const:`FILTER_IA64`
 * :const:`FILTER_ARM`
 * :const:`FILTER_ARMTHUMB`
 * :const:`FILTER_POWERPC`
 * :const:`FILTER_SPARC`
 * :const:`!FILTER_X86`
 * :const:`!FILTER_IA64`
 * :const:`!FILTER_ARM`
 * :const:`!FILTER_ARMTHUMB`
 * :const:`!FILTER_POWERPC`
 * :const:`!FILTER_SPARC`

 The above work on all lzma runtime library versions.

 * :const:`!FILTER_ARM64`

 Only works if the lzma version is 5.4.0 or later.

 .. versionadded:: next

 * :const:`!FILTER_RISCV`

 Only works if the lzma version is 5.6.0 or later.

 .. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down

9 changes: 9 additions & 0 deletions
Doc/whatsnew/3.16.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
 which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
 (Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
 :const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
 new filters will work only if runtime library supports them. ARM64 filter
 requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
 (Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down

1 change: 1 addition & 0 deletions
Lib/lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
 "CHECK_ID_MAX", "CHECK_UNKNOWN",
 "FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
 "FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
 "FILTER_ARM64", "FILTER_RISCV",
 "FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
 "MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
 "MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down

6 changes: 6 additions & 0 deletions
Lib/test/test_lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
 self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
 decompress(bytes()), b'')

 def test_riscv_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_RISCV)

 def test_arm64_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down

1 change: 1 addition & 0 deletions
Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.

21 changes: 20 additions & 1 deletion
Modules/_lzmamodule.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
 #error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
 * If the lzma.h we're building against is so old as not to define these, this
 * provides their equivalent values so that the names remain defined in Python
 * regardless of the header versions used at build time.
 */
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.

#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
 On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.

 f->options = parse_filter_spec_bcj(state, spec);
 return f->options != NULL;
 default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
 case LZMA_FILTER_IA64:
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC: {
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV: {
 lzma_options_bcj *options = f->options;
 if (options) {
 ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
 ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
 ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
 ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
 ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
 ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
 ADD_INT_PREFIX_MACRO(module, MF_HC3);
 ADD_INT_PREFIX_MACRO(module, MF_HC4);
 ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
gh-115988: Add missing ARM64 and RISCV filter in lzma module#115989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

gpshead
merged 28 commits into

from

May 28, 2026
 Merged


gh-115988: Add missing ARM64 and RISCV filter in lzma module
#115989
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


28 commits


Select commit
Hold shift + click to select a range
68979bc

Add missing ARM64 and RISCV filter in lzma module


ivq Feb 27, 2024
3fa0c17

Suppress doc warning "py:const reference target not found"


ivq Feb 28, 2024
c1e166a

Add lzma version


ivq Mar 17, 2024
ea51476

Add ARM64, RISC-V filter test case


ivq Mar 17, 2024
6189ceb

Update lzma doc


ivq Mar 17, 2024
0f6fd63

Add NEWS entry


ivq Mar 17, 2024
9731225

Optimise NEWS


ivq Mar 18, 2024
40e9d34

Move version doc section


ivq Mar 19, 2024
8c922f7

Add WHATSNEW entry


ivq Mar 19, 2024
9cd4cb8

Fix filter chain specs position


ivq Mar 19, 2024
8a85c48

Suppress doc warning


ivq Mar 22, 2024
32725a7

Elide upstream binary data from the test.


gpshead Mar 30, 2024
6d94a08

Clarify the documentation a bit.


gpshead Mar 30, 2024
c62ca63

Clarifying comment, docs accuracy.


gpshead Mar 30, 2024
045aa40

Expose the version as a number.


gpshead Mar 30, 2024
8f49f69

Merge branch 'main' into xz_bcj_filters


gpshead Mar 30, 2024
832335d

minor version explanation tweak.


gpshead Mar 30, 2024
728f286

Adjust the whats new text.


gpshead Mar 30, 2024
61c4adf

NEWS wording and formatting tweak.


gpshead Mar 30, 2024
98adeee

line length


gpshead Mar 30, 2024
449b722

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq Jul 13, 2025
f381ca5

We've missed the 3.13 window


ivq Jul 13, 2025
9f0d4d4

Fix accidentally removed newline when merging remote main


ivq Jul 13, 2025
1a17fd5

Remove unused import


ivq Jul 13, 2025
78e7d9a

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq May 27, 2026
9cc998f

Remove lzma version constants


ivq May 27, 2026
5ed9891

versionadded "next" in rst


gpshead May 27, 2026
b52d942

Put whatsnew entry alphabetically


ivq May 28, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 20 additions & 6 deletions
Doc/library/lzma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

 * :const:`FILTER_X86`
 * :const:`FILTER_IA64`
 * :const:`FILTER_ARM`
 * :const:`FILTER_ARMTHUMB`
 * :const:`FILTER_POWERPC`
 * :const:`FILTER_SPARC`
 * :const:`!FILTER_X86`
 * :const:`!FILTER_IA64`
 * :const:`!FILTER_ARM`
 * :const:`!FILTER_ARMTHUMB`
 * :const:`!FILTER_POWERPC`
 * :const:`!FILTER_SPARC`

 The above work on all lzma runtime library versions.

 * :const:`!FILTER_ARM64`

 Only works if the lzma version is 5.4.0 or later.

 .. versionadded:: next

 * :const:`!FILTER_RISCV`

 Only works if the lzma version is 5.6.0 or later.

 .. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down

9 changes: 9 additions & 0 deletions
Doc/whatsnew/3.16.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
 which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
 (Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
 :const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
 new filters will work only if runtime library supports them. ARM64 filter
 requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
 (Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down

1 change: 1 addition & 0 deletions
Lib/lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
 "CHECK_ID_MAX", "CHECK_UNKNOWN",
 "FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
 "FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
 "FILTER_ARM64", "FILTER_RISCV",
 "FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
 "MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
 "MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down

6 changes: 6 additions & 0 deletions
Lib/test/test_lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
 self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
 decompress(bytes()), b'')

 def test_riscv_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_RISCV)

 def test_arm64_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down

1 change: 1 addition & 0 deletions
Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.

21 changes: 20 additions & 1 deletion
Modules/_lzmamodule.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
 #error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
 * If the lzma.h we're building against is so old as not to define these, this
 * provides their equivalent values so that the names remain defined in Python
 * regardless of the header versions used at build time.
 */
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.

#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
 On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.

 f->options = parse_filter_spec_bcj(state, spec);
 return f->options != NULL;
 default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
 case LZMA_FILTER_IA64:
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC: {
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV: {
 lzma_options_bcj *options = f->options;
 if (options) {
 ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
 ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
 ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
 ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
 ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
 ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
 ADD_INT_PREFIX_MACRO(module, MF_HC3);
 ADD_INT_PREFIX_MACRO(module, MF_HC4);
 ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
gh-115988: Add missing ARM64 and RISCV filter in lzma module#115989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

gpshead
merged 28 commits into

from

May 28, 2026
 Merged


gh-115988: Add missing ARM64 and RISCV filter in lzma module
#115989
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


28 commits


Select commit
Hold shift + click to select a range
68979bc

Add missing ARM64 and RISCV filter in lzma module


ivq Feb 27, 2024
3fa0c17

Suppress doc warning "py:const reference target not found"


ivq Feb 28, 2024
c1e166a

Add lzma version


ivq Mar 17, 2024
ea51476

Add ARM64, RISC-V filter test case


ivq Mar 17, 2024
6189ceb

Update lzma doc


ivq Mar 17, 2024
0f6fd63

Add NEWS entry


ivq Mar 17, 2024
9731225

Optimise NEWS


ivq Mar 18, 2024
40e9d34

Move version doc section


ivq Mar 19, 2024
8c922f7

Add WHATSNEW entry


ivq Mar 19, 2024
9cd4cb8

Fix filter chain specs position


ivq Mar 19, 2024
8a85c48

Suppress doc warning


ivq Mar 22, 2024
32725a7

Elide upstream binary data from the test.


gpshead Mar 30, 2024
6d94a08

Clarify the documentation a bit.


gpshead Mar 30, 2024
c62ca63

Clarifying comment, docs accuracy.


gpshead Mar 30, 2024
045aa40

Expose the version as a number.


gpshead Mar 30, 2024
8f49f69

Merge branch 'main' into xz_bcj_filters


gpshead Mar 30, 2024
832335d

minor version explanation tweak.


gpshead Mar 30, 2024
728f286

Adjust the whats new text.


gpshead Mar 30, 2024
61c4adf

NEWS wording and formatting tweak.


gpshead Mar 30, 2024
98adeee

line length


gpshead Mar 30, 2024
449b722

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq Jul 13, 2025
f381ca5

We've missed the 3.13 window


ivq Jul 13, 2025
9f0d4d4

Fix accidentally removed newline when merging remote main


ivq Jul 13, 2025
1a17fd5

Remove unused import


ivq Jul 13, 2025
78e7d9a

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq May 27, 2026
9cc998f

Remove lzma version constants


ivq May 27, 2026
5ed9891

versionadded "next" in rst


gpshead May 27, 2026
b52d942

Put whatsnew entry alphabetically


ivq May 28, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 20 additions & 6 deletions
Doc/library/lzma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

 * :const:`FILTER_X86`
 * :const:`FILTER_IA64`
 * :const:`FILTER_ARM`
 * :const:`FILTER_ARMTHUMB`
 * :const:`FILTER_POWERPC`
 * :const:`FILTER_SPARC`
 * :const:`!FILTER_X86`
 * :const:`!FILTER_IA64`
 * :const:`!FILTER_ARM`
 * :const:`!FILTER_ARMTHUMB`
 * :const:`!FILTER_POWERPC`
 * :const:`!FILTER_SPARC`

 The above work on all lzma runtime library versions.

 * :const:`!FILTER_ARM64`

 Only works if the lzma version is 5.4.0 or later.

 .. versionadded:: next

 * :const:`!FILTER_RISCV`

 Only works if the lzma version is 5.6.0 or later.

 .. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down

9 changes: 9 additions & 0 deletions
Doc/whatsnew/3.16.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
 which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
 (Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
 :const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
 new filters will work only if runtime library supports them. ARM64 filter
 requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
 (Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down

1 change: 1 addition & 0 deletions
Lib/lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
 "CHECK_ID_MAX", "CHECK_UNKNOWN",
 "FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
 "FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
 "FILTER_ARM64", "FILTER_RISCV",
 "FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
 "MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
 "MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down

6 changes: 6 additions & 0 deletions
Lib/test/test_lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
 self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
 decompress(bytes()), b'')

 def test_riscv_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_RISCV)

 def test_arm64_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down

1 change: 1 addition & 0 deletions
Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.

21 changes: 20 additions & 1 deletion
Modules/_lzmamodule.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
 #error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
 * If the lzma.h we're building against is so old as not to define these, this
 * provides their equivalent values so that the names remain defined in Python
 * regardless of the header versions used at build time.
 */
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.

#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
 On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.

 f->options = parse_filter_spec_bcj(state, spec);
 return f->options != NULL;
 default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
 case LZMA_FILTER_IA64:
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC: {
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV: {
 lzma_options_bcj *options = f->options;
 if (options) {
 ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
 ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
 ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
 ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
 ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
 ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
 ADD_INT_PREFIX_MACRO(module, MF_HC3);
 ADD_INT_PREFIX_MACRO(module, MF_HC4);
 ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
gh-115988: Add missing ARM64 and RISCV filter in lzma module#115989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

gpshead
merged 28 commits into

from

May 28, 2026
 Merged


gh-115988: Add missing ARM64 and RISCV filter in lzma module
#115989
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


28 commits


Select commit
Hold shift + click to select a range
68979bc

Add missing ARM64 and RISCV filter in lzma module


ivq Feb 27, 2024
3fa0c17

Suppress doc warning "py:const reference target not found"


ivq Feb 28, 2024
c1e166a

Add lzma version


ivq Mar 17, 2024
ea51476

Add ARM64, RISC-V filter test case


ivq Mar 17, 2024
6189ceb

Update lzma doc


ivq Mar 17, 2024
0f6fd63

Add NEWS entry


ivq Mar 17, 2024
9731225

Optimise NEWS


ivq Mar 18, 2024
40e9d34

Move version doc section


ivq Mar 19, 2024
8c922f7

Add WHATSNEW entry


ivq Mar 19, 2024
9cd4cb8

Fix filter chain specs position


ivq Mar 19, 2024
8a85c48

Suppress doc warning


ivq Mar 22, 2024
32725a7

Elide upstream binary data from the test.


gpshead Mar 30, 2024
6d94a08

Clarify the documentation a bit.


gpshead Mar 30, 2024
c62ca63

Clarifying comment, docs accuracy.


gpshead Mar 30, 2024
045aa40

Expose the version as a number.


gpshead Mar 30, 2024
8f49f69

Merge branch 'main' into xz_bcj_filters


gpshead Mar 30, 2024
832335d

minor version explanation tweak.


gpshead Mar 30, 2024
728f286

Adjust the whats new text.


gpshead Mar 30, 2024
61c4adf

NEWS wording and formatting tweak.


gpshead Mar 30, 2024
98adeee

line length


gpshead Mar 30, 2024
449b722

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq Jul 13, 2025
f381ca5

We've missed the 3.13 window


ivq Jul 13, 2025
9f0d4d4

Fix accidentally removed newline when merging remote main


ivq Jul 13, 2025
1a17fd5

Remove unused import


ivq Jul 13, 2025
78e7d9a

Merge remote-tracking branch 'origin/main' into xz_bcj_filters


ivq May 27, 2026
9cc998f

Remove lzma version constants


ivq May 27, 2026
5ed9891

versionadded "next" in rst


gpshead May 27, 2026
b52d942

Put whatsnew entry alphabetically


ivq May 28, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 20 additions & 6 deletions
Doc/library/lzma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -356,12 +356,26 @@ options. Valid filter IDs are as follows:

* Branch-Call-Jump (BCJ) filters:

 * :const:`FILTER_X86`
 * :const:`FILTER_IA64`
 * :const:`FILTER_ARM`
 * :const:`FILTER_ARMTHUMB`
 * :const:`FILTER_POWERPC`
 * :const:`FILTER_SPARC`
 * :const:`!FILTER_X86`
 * :const:`!FILTER_IA64`
 * :const:`!FILTER_ARM`
 * :const:`!FILTER_ARMTHUMB`
 * :const:`!FILTER_POWERPC`
 * :const:`!FILTER_SPARC`

 The above work on all lzma runtime library versions.

 * :const:`!FILTER_ARM64`

 Only works if the lzma version is 5.4.0 or later.

 .. versionadded:: next

 * :const:`!FILTER_RISCV`

 Only works if the lzma version is 5.6.0 or later.

 .. versionadded:: next

A filter chain can consist of up to 4 filters, and cannot be empty. The last
filter in the chain must be a compression filter, and any other filters must be
Expand Down

9 changes: 9 additions & 0 deletions
Doc/whatsnew/3.16.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,15 @@ gzip
 which is passed on to the constructor of the :class:`~gzip.GzipFile` class.
 (Contributed by Marin Misur in :gh:`91372`.)

lzma
----

* Add support of new BCJ filters ARM64 and RISC-V via
 :const:`!lzma.FILTER_ARM64` and :const:`!lzma.FILTER_RISCV`. Note that the
 new filters will work only if runtime library supports them. ARM64 filter
 requires ``lzma`` 5.4.0 or newer while RISC-V requires 5.6.0 or newer.
 (Contributed by Chien Wong in :gh:`115988`.)

os
--

Expand Down

1 change: 1 addition & 0 deletions
Lib/lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
 "CHECK_ID_MAX", "CHECK_UNKNOWN",
 "FILTER_LZMA1", "FILTER_LZMA2", "FILTER_DELTA", "FILTER_X86", "FILTER_IA64",
 "FILTER_ARM", "FILTER_ARMTHUMB", "FILTER_POWERPC", "FILTER_SPARC",
 "FILTER_ARM64", "FILTER_RISCV",
 "FORMAT_AUTO", "FORMAT_XZ", "FORMAT_ALONE", "FORMAT_RAW",
 "MF_HC3", "MF_HC4", "MF_BT2", "MF_BT3", "MF_BT4",
 "MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
Expand Down

6 changes: 6 additions & 0 deletions
Lib/test/test_lzma.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -383,6 +383,12 @@ def test_uninitialized_LZMADecompressor_crash(self):
 self.assertEqual(LZMADecompressor.__new__(LZMADecompressor).
 decompress(bytes()), b'')

 def test_riscv_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_RISCV)

 def test_arm64_filter_constant_exists(self):
 self.assertTrue(lzma.FILTER_ARM64)


class CompressDecompressFunctionTestCase(unittest.TestCase):

Expand Down

1 change: 1 addition & 0 deletions
Misc/NEWS.d/next/Library/2024-03-17-22-16-53.gh-issue-115988.EshSDM.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
:mod:`lzma` adds constants to support the newer BCJ filters for ARM64 and RISC-V.

21 changes: 20 additions & 1 deletion
Modules/_lzmamodule.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,19 @@
 #error "The maximum block size accepted by liblzma is SIZE_MAX."
#endif


/*
 * If the lzma.h we're building against is so old as not to define these, this
 * provides their equivalent values so that the names remain defined in Python
 * regardless of the header versions used at build time.
 */
#ifndef LZMA_FILTER_ARM64
Comment thread
gpshead marked this conversation as resolved.

#define LZMA_FILTER_ARM64 LZMA_VLI_C(0x0A)
#endif
#ifndef LZMA_FILTER_RISCV
#define LZMA_FILTER_RISCV LZMA_VLI_C(0x0B)
#endif

/* On success, return value >= 0
 On failure, return -1 */
static inline Py_ssize_t
Expand DownExpand Up@@ -373,6 +386,8 @@ lzma_filter_converter(_lzma_state *state, PyObject *spec, void *ptr)
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV:
Comment thread
gpshead marked this conversation as resolved.

 f->options = parse_filter_spec_bcj(state, spec);
 return f->options != NULL;
 default:
Expand DownExpand Up@@ -491,7 +506,9 @@ build_filter_spec(const lzma_filter *f)
 case LZMA_FILTER_IA64:
 case LZMA_FILTER_ARM:
 case LZMA_FILTER_ARMTHUMB:
 case LZMA_FILTER_SPARC: {
 case LZMA_FILTER_SPARC:
 case LZMA_FILTER_ARM64:
 case LZMA_FILTER_RISCV: {
 lzma_options_bcj *options = f->options;
 if (options) {
 ADD_FIELD(options, start_offset);
Expand DownExpand Up@@ -1544,6 +1561,8 @@ lzma_exec(PyObject *module)
 ADD_INT_PREFIX_MACRO(module, FILTER_ARMTHUMB);
 ADD_INT_PREFIX_MACRO(module, FILTER_SPARC);
 ADD_INT_PREFIX_MACRO(module, FILTER_POWERPC);
 ADD_INT_PREFIX_MACRO(module, FILTER_ARM64);
 ADD_INT_PREFIX_MACRO(module, FILTER_RISCV);
 ADD_INT_PREFIX_MACRO(module, MF_HC3);
 ADD_INT_PREFIX_MACRO(module, MF_HC4);
 ADD_INT_PREFIX_MACRO(module, MF_BT2);
Expand Down
Loading