summaryrefslogtreecommitdiff
path: root/Doc/library
diff options
context:
space:
mode:
authorGregory P. Smith <greg@krypto.org>2020-02-28 17:28:37 -0800
committerGitHub <noreply@github.com>2020-02-28 17:28:37 -0800
commit02673352b5db6ca4d3dc804965facbedfe66425d (patch)
tree24ac954d0b1d8b377fd0de065778717204fe5507 /Doc/library
parent03153dd1459fab94f294a118ed1525e34d58601a (diff)
downloadcpython-git-02673352b5db6ca4d3dc804965facbedfe66425d.tar.gz
bpo-39769: Fix compileall ddir for subpkgs. (GH-18676)
Fix compileall.compile_dir() ddir= behavior on sub-packages. Fixes compileall.compile_dir's ddir parameter and compileall command line flag `-d` to no longer write the wrong pathname to the generated pyc file for submodules beneath the root of the directory tree being compiled. This fixes a regression introduced with Python 3.5. Also marks the _new_ in 3.9 from PR #16012 parameters to compile_dir as keyword only (as that is the only way they will be used) and fixes an omission of them in one place from the docs.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/compileall.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst
index 394d60634f..b1ae9d60e8 100644
--- a/Doc/library/compileall.rst
+++ b/Doc/library/compileall.rst
@@ -143,7 +143,7 @@ runtime.
Public functions
----------------
-.. function:: compile_dir(dir, maxlevels=sys.getrecursionlimit(), ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=None, stripdir=None, prependdir=None, limit_sl_dest=None)
+.. function:: compile_dir(dir, maxlevels=sys.getrecursionlimit(), ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=None, \*, stripdir=None, prependdir=None, limit_sl_dest=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,
@@ -221,7 +221,7 @@ Public functions
.. versionchanged:: 3.9
Added *stripdir*, *prependdir* and *limit_sl_dest* arguments.
-.. function:: compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None)
+.. function:: compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None, \*, stripdir=None, prependdir=None, limit_sl_dest=None)
Compile the file with path *fullname*. Return a true value if the file
compiled successfully, and a false value otherwise.