diff options
| author | Hai Shi <shihai1992@gmail.com> | 2019-08-14 22:03:11 (GMT) |
|---|---|---|
| committer | Victor Stinner <vstinner@redhat.com> | 2019-08-14 22:03:11 (GMT) |
| commit | 68e495df909a33e719e3f1ef5b4893ec785e10a4 (patch) | |
| tree | 0eb77a9c7783ef828c3e6b61ec7b30808f187d50 /Doc/library/compileall.rst | |
| parent | ac827edc493d3ac3f5b9b0cc353df1d4b418a9aa (diff) | |
| download | cpython-68e495df909a33e719e3f1ef5b4893ec785e10a4.zip cpython-68e495df909a33e719e3f1ef5b4893ec785e10a4.tar.gz cpython-68e495df909a33e719e3f1ef5b4893ec785e10a4.tar.bz2 | |
bpo-37775: Update compileall doc for invalidation_mode parameter (GH-15148)
Diffstat (limited to 'Doc/library/compileall.rst')
| -rw-r--r-- | Doc/library/compileall.rst | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst index bb5000a..9ce5ca8 100644 --- a/Doc/library/compileall.rst +++ b/Doc/library/compileall.rst @@ -120,7 +120,7 @@ runtime. Public functions ---------------- -.. function:: compile_dir(dir, maxlevels=10, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP) +.. function:: compile_dir(dir, maxlevels=10, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=None) Recursively descend the directory tree named by *dir*, compiling all :file:`.py` files along the way. Return a true value if all the files compiled successfully, @@ -185,10 +185,13 @@ Public functions .. versionchanged:: 3.7 The *invalidation_mode* parameter was added. + .. versionchanged:: 3.7.2 + The *invalidation_mode* parameter's default value is updated to None. + .. versionchanged:: 3.8 Setting *workers* to 0 now chooses the optimal number of cores. -.. function:: compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP) +.. function:: compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None) Compile the file with path *fullname*. Return a true value if the file compiled successfully, and a false value otherwise. @@ -232,7 +235,10 @@ Public functions .. versionchanged:: 3.7 The *invalidation_mode* parameter was added. -.. function:: compile_path(skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=py_compile.PycInvalidationMode.TIMESTAMP) + .. versionchanged:: 3.7.2 + The *invalidation_mode* parameter's default value is updated to None. + +.. function:: compile_path(skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=None) Byte-compile all the :file:`.py` files found along ``sys.path``. Return a true value if all the files compiled successfully, and a false value otherwise. @@ -255,6 +261,9 @@ Public functions .. versionchanged:: 3.7 The *invalidation_mode* parameter was added. + .. versionchanged:: 3.7.2 + The *invalidation_mode* parameter's default value is updated to None. + To force a recompile of all the :file:`.py` files in the :file:`Lib/` subdirectory and all its subdirectories:: |