Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-37775: update docs of compileall #15148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 14, 2019
Merged

bpo-37775: update docs of compileall #15148

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36434c1
update doc of compileall
shihai1991 Aug 6, 2019
e190013
add versionchanged
shihai1991 Aug 11, 2019
c22afa5
update docs of compileall
shihai1991 Aug 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions Doc/library/compileall.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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::

Expand Down