pyguymer3.xz

pyguymer3.xz(fname, /, *, cwd=None, stderr=None, stdout=None, threads=0, timeout=60.0, xzPath=None)[source]

Compress a file using “xz” (with SHA-256 integrity checks).

Parameters:

  • fname (str) – the name of the file to compress

  • cwd (str, optional) – the child working directory (default None)

  • stderr (subprocess.PIPE, subprocess.DEVNULL, io.TextIOWrapper, optional) – the destination of STDERR (default None)

  • stdout (subprocess.PIPE, subprocess.DEVNULL, io.TextIOWrapper, optional) – the destination of STDOUT (default None)

  • threads (int, optional) – the number of threads to use (default 0)

  • timeout (float, optional) – the timeout for any requests/subprocess calls

  • xzPath (str, optional) – the path to the “xz” binary (if not provided then Python will attempt to find the binary itself)

Notes

I still need to provide justification for using this function over https://docs.python.org/3.12/library/lzma.html

Copyright 2017 Thomas Guymer [1]

References