]> granicus.if.org Git - python/commitdiff
Prefer lzma.open() over lzma.LZMAFile() in lzma module documentation.
authorNadeem Vawda <nadeem.vawda@gmail.com>
Sun, 23 Sep 2012 16:20:23 +0000 (18:20 +0200)
committerNadeem Vawda <nadeem.vawda@gmail.com>
Sun, 23 Sep 2012 16:20:23 +0000 (18:20 +0200)
Doc/library/lzma.rst

index 4c637db1e43d89a012c005069f902037b6da49e2..f09fa08c4198ff338df86fde0d321dabdad42ef9 100644 (file)
@@ -335,14 +335,14 @@ Examples
 Reading in a compressed file::
 
    import lzma
-   with lzma.LZMAFile("file.xz") as f:
+   with lzma.open("file.xz") as f:
        file_content = f.read()
 
 Creating a compressed file::
 
    import lzma
    data = b"Insert Data Here"
-   with lzma.LZMAFile("file.xz", "w") as f:
+   with lzma.open("file.xz", "w") as f:
        f.write(data)
 
 Compressing data in memory::
@@ -367,7 +367,7 @@ Writing compressed data to an already-open file::
    import lzma
    with open("file.xz", "wb") as f:
        f.write(b"This data will not be compressed\n")
-       with lzma.LZMAFile(f, "w") as lzf:
+       with lzma.open(f, "w") as lzf:
            lzf.write(b"This *will* be compressed\n")
        f.write(b"Not compressed\n")
 
@@ -378,5 +378,5 @@ Creating a compressed file using a custom filter chain::
        {"id": lzma.FILTER_DELTA, "dist": 5},
        {"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME},
    ]
-   with lzma.LZMAFile("file.xz", "w", filters=my_filters) as f:
+   with lzma.open("file.xz", "w", filters=my_filters) as f:
        f.write(b"blah blah blah")