traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-37775: Update compileall doc for invalidation_mode parameter (GH-15148)

This commit is contained in:
Hai Shi 2019-08-14 17:03:11 -05:00 committed by Victor Stinner
parent ac827edc49
commit 68e495df90
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/library/compileall.rst
View File

@ -120,7 +120,7 @@ runtime.
Public functions 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` 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, files along the way. Return a true value if all the files compiled successfully,
@ -185,10 +185,13 @@ Public functions
.. versionchanged:: 3.7 .. versionchanged:: 3.7
The *invalidation_mode* parameter was added. The *invalidation_mode* parameter was added.
.. versionchanged:: 3.7.2
The *invalidation_mode* parameter's default value is updated to None.
.. versionchanged:: 3.8 .. versionchanged:: 3.8
Setting *workers* to 0 now chooses the optimal number of cores. 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 Compile the file with path *fullname*. Return a true value if the file
compiled successfully, and a false value otherwise. compiled successfully, and a false value otherwise.
@ -232,7 +235,10 @@ Public functions
.. versionchanged:: 3.7 .. versionchanged:: 3.7
The *invalidation_mode* parameter was added. 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 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. true value if all the files compiled successfully, and a false value otherwise.
@ -255,6 +261,9 @@ Public functions
.. versionchanged:: 3.7 .. versionchanged:: 3.7
The *invalidation_mode* parameter was added. 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/` To force a recompile of all the :file:`.py` files in the :file:`Lib/`
subdirectory and all its subdirectories:: subdirectory and all its subdirectories::