summaryrefslogtreecommitdiffstats
path: root/Doc/library/compileall.rst
diff options
context:
space:
mode:
authorJean-Abou-Samra <37271310+Jean-Abou-Samra@users.noreply.github.com>2021-05-04 19:37:39 (GMT)
committerGitHub <noreply@github.com>2021-05-04 19:37:39 (GMT)
commit09490298d4485e9322edc6e1e8e15eb66c586164 (patch)
tree1b8fa9469fb04f3056e7d61c2d35e6ed76c39674 /Doc/library/compileall.rst
parent1add719516f49aacd260c44f9dcbd6af269fdb21 (diff)
downloadcpython-09490298d4485e9322edc6e1e8e15eb66c586164.zip
cpython-09490298d4485e9322edc6e1e8e15eb66c586164.tar.gz
cpython-09490298d4485e9322edc6e1e8e15eb66c586164.tar.bz2
Clarify rx parameter of compileall functions (#25857)
Diffstat (limited to 'Doc/library/compileall.rst')
-rw-r--r--Doc/library/compileall.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst
index 5c6e68f..de34664 100644
--- a/Doc/library/compileall.rst
+++ b/Doc/library/compileall.rst
@@ -166,9 +166,10 @@ Public functions
If *force* is true, modules are re-compiled even if the timestamps are up to
date.
- If *rx* is given, its search method is called on the complete path to each
+ If *rx* is given, its ``search`` method is called on the complete path to each
file considered for compilation, and if it returns a true value, the file
- is skipped.
+ is skipped. This can be used to exclude files matching a regular expression,
+ given as a :ref:`re.Pattern <re-objects>` object.
If *quiet* is ``False`` or ``0`` (the default), the filenames and other
information are printed to standard out. Set to ``1``, only errors are
@@ -242,9 +243,10 @@ Public functions
cases where the source file does not exist at the time the byte-code file is
executed.
- If *rx* is given, its search method is passed the full path name to the
+ If *rx* is given, its ``search`` method is passed the full path name to the
file being compiled, and if it returns a true value, the file is not
- compiled and ``True`` is returned.
+ compiled and ``True`` is returned. This can be used to exclude files matching
+ a regular expression, given as a :ref:`re.Pattern <re-objects>` object.
If *quiet* is ``False`` or ``0`` (the default), the filenames and other
information are printed to standard out. Set to ``1``, only errors are