From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Tue, 4 May 2021 19:59:45 +0000 (-0700) Subject: Clarify rx parameter of compileall functions (GH-25857) X-Git-Tag: v3.9.6~133 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8faed45242f26e4e34009bf518c17119f103d069;p=thirdparty%2FPython%2Fcpython.git Clarify rx parameter of compileall functions (GH-25857) (cherry picked from commit 09490298d4485e9322edc6e1e8e15eb66c586164) Co-authored-by: Jean-Abou-Samra <37271310+Jean-Abou-Samra@users.noreply.github.com> --- diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst index 5c6e68f93047..de34664acb84 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 ` 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 ` 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