]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-33032: Mention the implicit cache in struct.Struct() docs (GH-7700)
authorZackery Spytz <zspytz@gmail.com>
Tue, 11 Sep 2018 04:37:33 +0000 (22:37 -0600)
committerGregory P. Smith <greg@krypto.org>
Tue, 11 Sep 2018 04:37:33 +0000 (21:37 -0700)
Mention the implicit cache in struct.Struct() docs.

Consistent with the re.compile documentation note.

Doc/library/struct.rst

index d6a3cb721e8388121261fdadff4ae37076aa208b..bad33ac666ed3d2e774865938859700ef87afc6f 100644 (file)
@@ -405,6 +405,12 @@ The :mod:`struct` module also defines the following type:
    methods is more efficient than calling the :mod:`struct` functions with the
    same format since the format string only needs to be compiled once.
 
+   .. note::
+
+      The compiled versions of the most recent format strings passed to
+      :class:`Struct` and the module-level functions are cached, so programs
+      that use only a few format strings needn't worry about reusing a single
+      :class:`Struct` instance.
 
    Compiled Struct objects support the following methods and attributes: