This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: lzma documentation: example to XZ compress file on disk
Type: enhancement Stage:
Components: Documentation, IO Versions: Python 3.8, Python 3.7
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: dhimmel, docs@python
Priority: normal Keywords:

Created on 2017-11-28 20:41 by dhimmel, last changed 2022-04-11 14:58 by admin.

Messages (2)
msg307163 - (view) Author: Daniel Himmelstein (dhimmel) * Date: 2017-11-28 20:41
The documentation for the lzma module currently contains 6 examples ( However, it does not include an example to XZ compress a file on disk. The functionality I'm envisioning would be similar to the command:

xz --compress --keep path

I believe this is possible in python with:

with open(in_path) as in_file,, 'w') as out_file:
    shutil.copyfileobj(in_path, out_file)

Note gzip has a similar example (

Compressing an existing file on disk is a use case I commonly encounter. Python is ideal for the task because it provides a cross-platform solution that doesn't require installing additional command line utilities. Before finding shutil.copyfileobj, I assumed memory-efficient on-disk XZ compression was not possible in Python, due to its omission from the docs.

I'm happy to propose example code for the documentation.

Alternatively, if this feature is considered useful, we could consider an API addition to provide a one-line command for on-disk compressing/decompressing files. Since this would be a major addition that should be consistent across compression modules, perhaps we should just start with a lzma doc example?
msg307166 - (view) Author: Daniel Himmelstein (dhimmel) * Date: 2017-11-28 20:50
> we could consider an API addition

Just brainstorming here... perhaps an API addition would be most appropriate in the shutil module ( which already contains shutil.make_archive and shutil.unpack_archive. One could imagine shutil.compress and shutil.decompress that took a format argument to specify the compression type.
Date User Action Args
2022-04-11 14:58:54adminsetgithub: 76341
2017-11-28 20:50:25dhimmelsetmessages: + msg307166
2017-11-28 20:43:43dhimmelsetassignee: docs@python

type: enhancement
components: + Documentation
nosy: + docs@python
2017-11-28 20:41:15dhimmelcreate