Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions Doc/library/py_compile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ byte-code cache files in the directory containing the source code.
is raised. This function returns the path to byte-compiled file, i.e.
whatever *cfile* value was used.

The *doraise* and *quiet* arguments determine how errors are handled while
compiling file. If *quiet* is 0 or 1, and *doraise* is false, the default
behaviour is enabled: an error string is written to ``sys.stderr``, and the
function returns ``None`` instead of a path. If *doraise* is true,
a :exc:`PyCompileError` is raised instead. However if *quiet* is 2,
no message is written, and *doraise* has no effect.

If the path that *cfile* becomes (either explicitly specified or computed)
is a symlink or non-regular file, :exc:`FileExistsError` will be raised.
This is to act as a warning that import will turn those paths into regular
Expand Down Expand Up @@ -82,6 +89,9 @@ byte-code cache files in the directory containing the source code.
overrides the value of the *invalidation_mode* argument, and determines
its default value instead.

.. versionchanged:: 3.8
The *quiet* parameter was added.


.. class:: PycInvalidationMode

Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,13 @@ NSKeyedArchiver-encoded binary plists.
(Contributed by Jon Janzen in :issue:`26707`.)


py_compile
----------

:func:`py_compile.compile` now supports silent mode.
(Contributed by Joannah Nanjekye in :issue:`22640`.)


socket
------

Expand Down
24 changes: 15 additions & 9 deletions Lib/py_compile.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def _get_default_invalidation_mode():


def compile(file, cfile=None, dfile=None, doraise=False, optimize=-1,
invalidation_mode=None):
invalidation_mode=None, quiet=0):
"""Byte-compile one Python source file to Python bytecode.

:param file: The source file name.
Expand All @@ -95,6 +95,8 @@ def compile(file, cfile=None, dfile=None, doraise=False, optimize=-1,
are -1, 0, 1 and 2. A value of -1 means to use the optimization
level of the current interpreter, as given by -O command line options.
:param invalidation_mode:
:param quiet: Return full output with False or 0, errors only with 1,
and no output with 2.

:return: Path to the resulting byte compiled file.

Expand Down Expand Up @@ -143,11 +145,12 @@ def compile(file, cfile=None, dfile=None, doraise=False, optimize=-1,
_optimize=optimize)
except Exception as err:
py_exc = PyCompileError(err.__class__, err, dfile or file)
if doraise:
raise py_exc
else:
sys.stderr.write(py_exc.msg + '\n')
return
if quiet < 2:
if doraise:
raise py_exc
else:
sys.stderr.write(py_exc.msg + '\n')
return
try:
dirname = os.path.dirname(cfile)
if dirname:
Expand Down Expand Up @@ -194,18 +197,21 @@ def main(args=None):
compile(filename, doraise=True)
except PyCompileError as error:
rv = 1
sys.stderr.write("%s\n" % error.msg)
if quiet < 2:
sys.stderr.write("%s\n" % error.msg)
except OSError as error:
rv = 1
sys.stderr.write("%s\n" % error)
if quiet < 2:
sys.stderr.write("%s\n" % error)
else:
for filename in args:
try:
compile(filename, doraise=True)
except PyCompileError as error:
# return value to indicate at least one failure
rv = 1
sys.stderr.write("%s\n" % error.msg)
if quiet < 2:
sys.stderr.write("%s\n" % error.msg)
return rv

if __name__ == "__main__":
Expand Down
9 changes: 9 additions & 0 deletions Lib/test/test_py_compile.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,15 @@ def test_invalidation_mode(self):
fp.read(), 'test', {})
self.assertEqual(flags, 0b1)

def test_quiet(self):
bad_coding = os.path.join(os.path.dirname(__file__), 'bad_coding2.py')
with support.captured_stderr() as stderr:
self.assertIsNone(py_compile.compile(bad_coding, doraise=False, quiet=2))
Comment thread
nanjekyejoannah marked this conversation as resolved.
self.assertIsNone(py_compile.compile(bad_coding, doraise=True, quiet=2))
self.assertEqual(stderr.getvalue(), '')
with self.assertRaises(py_compile.PyCompileError):
py_compile.compile(bad_coding, doraise=True, quiet=1)


class PyCompileTestsWithSourceEpoch(PyCompileTestsBase,
unittest.TestCase,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
:func:`py_compile.compile` now supports silent mode.
Patch by Joannah Nanjekye