resolve issues in review

guoci · guoci · commit 6f465cc07aba · 2018-11-05T16:24:01.000-05:00
diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst
@@ -157,15 +157,15 @@ The module defines the following items:
       Accepts a :term:`path-like object`.
 
 
-.. function:: compress(data, compresslevel=9, mtime=None)
+.. function:: compress(data, compresslevel=9, *, mtime=None)
 
    Compress the *data*, returning a :class:`bytes` object containing
    the compressed data.  *compresslevel* and *mtime* have the same meaning as in
    the :class:`GzipFile` constructor above.
 
    .. versionadded:: 3.2
    .. versionchanged:: 3.8
-      Added *mtime* argument
+      Added the *mtime* parameter for reproducible output.
 
 .. function:: decompress(data)
 
diff --git a/Doc/whatsnew/3.8.rst b/Doc/whatsnew/3.8.rst
@@ -128,6 +128,13 @@ asyncio
 On Windows, the default event loop is now :class:`~asyncio.ProactorEventLoop`.
 
 
+gzip
+----
+
+Added the *mtime* parameter to :func:`gzip.compress` for reproducible output.
+(Contributed by Guo Ci Teo in :issue:`34898`.)
+
+
 idlelib and IDLE
 ----------------
 
diff --git a/Lib/gzip.py b/Lib/gzip.py
@@ -520,7 +520,7 @@ def _rewind(self):
         super()._rewind()
         self._new_member = True
 
-def compress(data, compresslevel=_COMPRESS_LEVEL_BEST, mtime=None):
+def compress(data, compresslevel=_COMPRESS_LEVEL_BEST, *, mtime=None):
     """Compress data in one shot and return the compressed string.
     Optional argument is the compression level, in range of 0-9.
     """
diff --git a/Lib/test/test_gzip.py b/Lib/test/test_gzip.py
@@ -502,9 +502,9 @@ def test_compress(self):
     def test_compress_mtime(self):
         mtime = 123456789
         for data in [data1, data2]:
-            for args in [(1, mtime), (6, mtime), (9, mtime)]:
+            for args in [(), (1,), (6,), (9,)]:
                 with self.subTest(data=data, args=args):
-                    datac = gzip.compress(data, *args)
+                    datac = gzip.compress(data, *args, mtime=mtime)
                     self.assertEqual(type(datac), bytes)
                     with gzip.GzipFile(fileobj=io.BytesIO(datac), mode="rb") as f:
                         f.read(1) # to set mtime attribute
diff --git a/Misc/ACKS b/Misc/ACKS
@@ -1615,6 +1615,7 @@ Monty Taylor
 Anatoly Techtonik
 Martin Teichmann
 Gustavo Temple
+Guo Ci Teo
 Mikhail Terekhov
 Victor Terrón
 Pablo Galindo
diff --git a/Misc/NEWS.d/next/Library/2018-10-04-17-23-43.bpo-34898.Wo2PoJ.rst b/Misc/NEWS.d/next/Library/2018-10-04-17-23-43.bpo-34898.Wo2PoJ.rst
@@ -1 +1,2 @@
 Add `mtime` argument to `gzip.compress` for reproducible output.
+Patch by Guo Ci Teo.

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	Add `mtime` argument to `gzip.compress` for reproducible output.
	`2`	`+Patch by Guo Ci Teo.`