.. _trace-cli:
-Command Line Usage
+Command-Line Usage
------------------
The :mod:`trace` module can be invoked from the command line. It can be as
simple as ::
- python -m trace --count somefile.py ...
+ python -m trace --count -C . somefile.py ...
-The above will generate annotated listings of all Python modules imported during
-the execution of :file:`somefile.py`.
+The above will execute :file:`somefile.py` and generate annotated listings of
+all Python modules imported during the execution into the current directory.
-The following command-line arguments are supported:
+.. program:: trace
+
+.. cmdoption:: --help
+
+ Display usage and exit.
+
+.. cmdoption:: --version
+
+ Display the version of the module and exit.
+
+Main options
+^^^^^^^^^^^^
+
+At least one of the following options must be specified when invoking
+:mod:`trace`. The :option:`--listfuncs <-l>` option is mutually exclusive with
+the :option:`--trace <-t>` and :option:`--counts <-c>` options . When
+:option:`--listfuncs <-l>` is provided, neither :option:`--counts <-c>` nor
+:option:`--trace <-t>` are accepted, and vice versa.
+
+.. program:: trace
+
+.. cmdoption:: -c, --count
+
+ Produce a set of annotated listing files upon program completion that shows
+ how many times each statement was executed. See also
+ :option:`--coverdir <-C>`, :option:`--file <-f>` and
+ :option:`--no-report <-R>` below.
+
+.. cmdoption:: -t, --trace
-:option:`--trace`, :option:`-t`
Display lines as they are executed.
-:option:`--count`, :option:`-c`
- Produce a set of annotated listing files upon program completion that shows how
- many times each statement was executed.
+.. cmdoption:: -l, --listfuncs
+
+ Display the functions executed by running the program.
+
+.. cmdoption:: -r, --report
-:option:`--report`, :option:`-r`
Produce an annotated list from an earlier program run that used the
- :option:`--count` and :option:`--file` arguments.
+ :option:`--count <-c>` and :option:`--file <-f>` option. This does not
+ execute any code.
-:option:`--no-report`, :option:`-R`
- Do not generate annotated listings. This is useful if you intend to make
- several runs with :option:`--count` then produce a single set of annotated
- listings at the end.
+.. cmdoption:: -T, --trackcalls
+
+ Display the calling relationships exposed by running the program.
+
+Modifiers
+^^^^^^^^^
+
+.. program:: trace
-:option:`--listfuncs`, :option:`-l`
- List the functions executed by running the program.
+.. cmdoption:: -f, --file=<file>
-:option:`--trackcalls`, :option:`-T`
- Generate calling relationships exposed by running the program.
+ Name of a file to accumulate counts over several tracing runs. Should be
+ used with the :option:`--count <-c>` option.
-:option:`--file`, :option:`-f`
- Name a file containing (or to contain) counts.
+.. cmdoption:: -C, --coverdir=<dir>
-:option:`--coverdir`, :option:`-C`
- Name a directory in which to save annotated listing files.
+ Directory where the report files go. The coverage report for
+ ``package.module`` is written to file :file:`{dir}/{package}/{module}.cover`.
+
+.. cmdoption:: -m, --missing
-:option:`--missing`, :option:`-m`
When generating annotated listings, mark lines which were not executed with
- '``>>>>>>``'.
+ ``>>>>>>``.
+
+.. cmdoption:: -s, --summary
+
+ When using :option:`--count <-c>` or :option:`--report <-r>`, write a brief
+ summary to stdout for each file processed.
+
+.. cmdoption:: -R, --no-report
+
+ Do not generate annotated listings. This is useful if you intend to make
+ several runs with :option:`--count <-c>`, and then produce a single set of
+ annotated listings at the end.
+
+.. cmdoption:: -g, --timing
+
+ Prefix each line with the time since the program started. Only used while
+ tracing.
-:option:`--summary`, :option:`-s`
- When using :option:`--count` or :option:`--report`, write a brief summary to
- stdout for each file processed.
+Filters
+^^^^^^^
-:option:`--ignore-module`
- Accepts comma separated list of module names. Ignore each of the named
- module and its submodules (if it is a package). May be given
- multiple times.
+These options may be repeated multiple times.
-:option:`--ignore-dir`
- Ignore all modules and packages in the named directory and subdirectories
- (multiple directories can be joined by os.pathsep). May be given multiple
- times.
+.. program:: trace
+.. cmdoption:: --ignore-module=<mod>
+
+ Ignore each of the given module names and its submodules (if it is a
+ package). The argument can be a list of names separated by a comma.
+
+.. cmdoption:: --ignore-dir=<dir>
+
+ Ignore all modules and packages in the named directory and subdirectories.
+ The argument can be a list of directories separated by :data:`os.pathsep`.
.. _trace-api:
-Programming Interface
----------------------
+Programmatic Interface
+----------------------
+
+.. class:: Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(),\
+ ignoredirs=(), infile=None, outfile=None, timing=False)
+
+ Create an object to trace execution of a single statement or expression. All
+ parameters are optional. *count* enables counting of line numbers. *trace*
+ enables line execution tracing. *countfuncs* enables listing of the
+ functions called during the run. *countcallers* enables call relationship
+ tracking. *ignoremods* is a list of modules or packages to ignore.
+ *ignoredirs* is a list of directories whose modules or packages should be
+ ignored. *infile* is the name of the file from which to read stored count
+ information. *outfile* is the name of the file in which to write updated
+ count information. *timing* enables a timestamp relative to when tracing was
+ started to be displayed.
+
+ .. method:: run(cmd)
+
+ Execute the command and gather statistics from the execution with
+ the current tracing parameters. *cmd* must be a string or code object,
+ suitable for passing into :func:`exec`.
+ .. method:: runctx(cmd, globals=None, locals=None)
-.. class:: Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)
+ Execute the command and gather statistics from the execution with the
+ current tracing parameters, in the defined global and local
+ environments. If not defined, *globals* and *locals* default to empty
+ dictionaries.
- Create an object to trace execution of a single statement or expression. All
- parameters are optional. *count* enables counting of line numbers. *trace*
- enables line execution tracing. *countfuncs* enables listing of the functions
- called during the run. *countcallers* enables call relationship tracking.
- *ignoremods* is a list of modules or packages to ignore. *ignoredirs* is a list
- of directories whose modules or packages should be ignored. *infile* is the
- file from which to read stored count information. *outfile* is a file in which
- to write updated count information. *timing* enables a timestamp relative
- to when tracing was started to be displayed.
+ .. method:: runfunc(func, *args, **kwds)
+ Call *func* with the given arguments under control of the :class:`Trace`
+ object with the current tracing parameters.
-.. method:: Trace.run(cmd)
+ .. method:: results()
- Run *cmd* under control of the Trace object with the current tracing parameters.
+ Return a :class:`CoverageResults` object that contains the cumulative
+ results of all previous calls to ``run``, ``runctx`` and ``runfunc``
+ for the given :class:`Trace` instance. Does not reset the accumulated
+ trace results.
+.. class:: CoverageResults
-.. method:: Trace.runctx(cmd, globals=None, locals=None)
+ A container for coverage results, created by :meth:`Trace.results`. Should
+ not be created directly by the user.
- Run *cmd* under control of the Trace object with the current tracing parameters
- in the defined global and local environments. If not defined, *globals* and
- *locals* default to empty dictionaries.
+ .. method:: update(other)
+ Merge in data from another :class:`CoverageResults` object.
-.. method:: Trace.runfunc(func, *args, **kwds)
+ .. method:: write_results(show_missing=True, summary=False, coverdir=None)
- Call *func* with the given arguments under control of the :class:`Trace` object
- with the current tracing parameters.
+ Write coverage results. Set *show_missing* to show lines that had no
+ hits. Set *summary* to include in the output the coverage summary per
+ module. *coverdir* specifies the directory into which the coverage
+ result files will be output. If ``None``, the results for each source
+ file are placed in its directory.
-This is a simple example showing the use of this module::
+A simple example demonstrating the use of the programmatic interface::
import sys
import trace
import os
import sys
import unittest
+from test.support import run_unittest
-here = os.path.dirname(__file__)
+here = os.path.dirname(__file__) or os.curdir
def test_suite():
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
ARCHIVE_FORMATS)
from distutils.spawn import find_executable, spawn
from distutils.tests import support
-from test.support import check_warnings
+from test.support import check_warnings, run_unittest
try:
import zipfile
return unittest.makeSuite(ArchiveUtilTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import os
import tempfile
import shutil
+from test.support import run_unittest
from distutils.core import Distribution
from distutils.command.bdist import bdist
return unittest.makeSuite(BuildTestCase)
if __name__ == '__main__':
- test_support.run_unittest(test_suite())
+ run_unittest(test_suite())
import unittest
import sys
import os
+from test.support import run_unittest
from distutils.core import Distribution
from distutils.command.bdist_dumb import bdist_dumb
return unittest.makeSuite(BuildDumbTestCase)
if __name__ == '__main__':
- test_support.run_unittest(test_suite())
+ run_unittest(test_suite())
import os
import tempfile
import shutil
+from test.support import run_unittest
from distutils.core import Distribution
from distutils.command.bdist_rpm import bdist_rpm
return unittest.makeSuite(BuildRpmTestCase)
if __name__ == '__main__':
- test_support.run_unittest(test_suite())
+ run_unittest(test_suite())
"""Tests for distutils.command.bdist_wininst."""
import unittest
+from test.support import run_unittest
from distutils.command.bdist_wininst import bdist_wininst
from distutils.tests import support
return unittest.makeSuite(BuildWinInstTestCase)
if __name__ == '__main__':
- test_support.run_unittest(test_suite())
+ run_unittest(test_suite())
import os
import sys
+from test.support import run_unittest
+
from distutils.command.build_clib import build_clib
from distutils.errors import DistutilsSetupError
from distutils.tests import support
return unittest.makeSuite(BuildCLibTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import unittest
from test import support
+from test.support import run_unittest
# http://bugs.python.org/issue4373
# Don't load the xx module more than once.
from distutils.errors import DistutilsFileError
from distutils.tests import support
+from test.support import run_unittest
class BuildPyTestCase(support.TempdirManager,
return unittest.makeSuite(BuildPyTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils import sysconfig
from distutils.tests import support
+from test.support import run_unittest
class BuildScriptsTestCase(support.TempdirManager,
return unittest.makeSuite(BuildScriptsTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
"""Tests for distutils.command.check."""
import unittest
+from test.support import run_unittest
from distutils.command.check import check, HAS_DOCUTILS
from distutils.tests import support
return unittest.makeSuite(CheckTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.command.clean import clean
from distutils.tests import support
+from test.support import run_unittest
class cleanTestCase(support.TempdirManager,
support.LoggingSilencer,
return unittest.makeSuite(cleanTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
"""Tests for distutils.cmd."""
import unittest
import os
-from test.support import captured_stdout
+from test.support import captured_stdout, run_unittest
from distutils.cmd import Command
from distutils.dist import Distribution
def test_ensure_dirname(self):
cmd = self.cmd
- cmd.option1 = os.path.dirname(__file__)
+ cmd.option1 = os.path.dirname(__file__) or os.curdir
cmd.ensure_dirname('option1')
cmd.option2 = 'xxx'
self.assertRaises(DistutilsOptionError, cmd.ensure_dirname, 'option2')
return unittest.makeSuite(CommandTestCase)
if __name__ == '__main__':
- test_support.run_unittest(test_suite())
+ run_unittest(test_suite())
from distutils.log import WARN
from distutils.tests import support
+from test.support import run_unittest
PYPIRC = """\
[distutils]
return unittest.makeSuite(PyPIRCCommandTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import unittest
import os
import sys
+from test.support import run_unittest
from distutils.command.config import dump_file, config
from distutils.tests import support
return unittest.makeSuite(ConfigTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import shutil
import sys
import test.support
-from test.support import captured_stdout
+from test.support import captured_stdout, run_unittest
import unittest
from distutils.tests import support
return unittest.makeSuite(CoreTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import os
from io import BytesIO
import subprocess
+from test.support import run_unittest
from distutils import cygwinccompiler
from distutils.cygwinccompiler import (CygwinCCompiler, check_config_h,
return unittest.makeSuite(CygwinCCompilerTestCase)
if __name__ == '__main__':
- test_support.run_unittest(test_suite())
+ run_unittest(test_suite())
from distutils import log
from distutils.tests import support
+from test.support import run_unittest
class DirUtilTestCase(support.TempdirManager, unittest.TestCase):
return unittest.makeSuite(DirUtilTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.dist import Distribution, fix_help_options
from distutils.cmd import Command
-from test.support import TESTFN, captured_stdout
+from test.support import TESTFN, captured_stdout, run_unittest
from distutils.tests import support
return suite
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import os
import warnings
-from test.support import check_warnings
+from test.support import check_warnings, run_unittest
from distutils.extension import read_setup_file, Extension
class ExtensionTestCase(unittest.TestCase):
return unittest.makeSuite(ExtensionTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.file_util import move_file
from distutils import log
from distutils.tests import support
+from test.support import run_unittest
class FileUtilTestCase(support.TempdirManager, unittest.TestCase):
return unittest.makeSuite(FileUtilTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import unittest
from distutils.filelist import glob_to_re, FileList
-from test.support import captured_stdout
+from test.support import captured_stdout, run_unittest
from distutils import debug
class FileListTestCase(unittest.TestCase):
return unittest.makeSuite(FileListTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import unittest
import site
-from test.support import captured_stdout
+from test.support import captured_stdout, run_unittest
from distutils.command.install import install
from distutils.command import install as install_module
return unittest.makeSuite(InstallTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.command.install_data import install_data
from distutils.tests import support
+from test.support import run_unittest
class InstallDataTestCase(support.TempdirManager,
support.LoggingSilencer,
return unittest.makeSuite(InstallDataTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.command.install_headers import install_headers
from distutils.tests import support
+from test.support import run_unittest
class InstallHeadersTestCase(support.TempdirManager,
support.LoggingSilencer,
return unittest.makeSuite(InstallHeadersTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.extension import Extension
from distutils.tests import support
from distutils.errors import DistutilsOptionError
+from test.support import run_unittest
class InstallLibTestCase(support.TempdirManager,
support.LoggingSilencer,
return unittest.makeSuite(InstallLibTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.core import Distribution
from distutils.tests import support
+from test.support import run_unittest
class InstallScriptsTestCase(support.TempdirManager,
return unittest.makeSuite(InstallScriptsTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import sys
import unittest
from tempfile import NamedTemporaryFile
+from test.support import run_unittest
from distutils import log
return unittest.makeSuite(TestLog)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
from distutils.errors import DistutilsPlatformError
from distutils.tests import support
+from test.support import run_unittest
_MANIFEST = """\
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
return unittest.makeSuite(msvc9compilerTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import urllib
import warnings
-from test.support import check_warnings
+from test.support import check_warnings, run_unittest
from distutils.command import register as register_module
from distutils.command.register import register
return unittest.makeSuite(RegisterTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import tempfile
import warnings
-from test.support import check_warnings
-from test.support import captured_stdout
+from test.support import captured_stdout, check_warnings, run_unittest
-from distutils.command.sdist import sdist
-from distutils.command.sdist import show_formats
+from distutils.command.sdist import sdist, show_formats
from distutils.core import Distribution
from distutils.tests.test_config import PyPIRCCommandTestCase
from distutils.errors import DistutilsExecError, DistutilsOptionError
return unittest.makeSuite(SDistTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import unittest
import os
import time
-from test.support import captured_stdout
+from test.support import captured_stdout, run_unittest
from distutils.spawn import _nt_quote_args
from distutils.spawn import spawn, find_executable
return unittest.makeSuite(SpawnTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import unittest
from distutils.text_file import TextFile
from distutils.tests import support
+from test.support import run_unittest
TEST_DATA = """# test file
return unittest.makeSuite(TextFileTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
"""Tests for distutils.unixccompiler."""
import sys
import unittest
+from test.support import run_unittest
from distutils import sysconfig
from distutils.unixccompiler import UnixCCompiler
return unittest.makeSuite(UnixCCompilerTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
"""Tests for distutils.command.upload."""
-import sys
import os
import unittest
import http.client as httpclient
+from test.support import run_unittest
from distutils.command.upload import upload
from distutils.core import Distribution
-from distutils.tests import support
from distutils.tests.test_config import PYPIRC, PyPIRCCommandTestCase
PYPIRC_LONG_PASSWORD = """\
return unittest.makeSuite(uploadTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import sys
import unittest
from copy import copy
+from test.support import run_unittest
from distutils.errors import DistutilsPlatformError, DistutilsByteCompileError
from distutils.util import (get_platform, convert_path, change_root,
return unittest.makeSuite(UtilTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import unittest
from distutils.version import LooseVersion
from distutils.version import StrictVersion
+from test.support import run_unittest
class VersionTestCase(unittest.TestCase):
return unittest.makeSuite(VersionTestCase)
if __name__ == "__main__":
- unittest.main(defaultTest="test_suite")
+ run_unittest(test_suite())
import distutils.versionpredicate
import doctest
+from test.support import run_unittest
def test_suite():
return doctest.DocTestSuite(distutils.versionpredicate)
+
+if __name__ == '__main__':
+ run_unittest(test_suite())
def setUp(self):
if not os.path.isdir(LOCALEDIR):
os.makedirs(LOCALEDIR)
- fp = open(MOFILE, 'wb')
- fp.write(base64.decodebytes(GNU_MO_DATA))
- fp.close()
- fp = open(UMOFILE, 'wb')
- fp.write(base64.decodebytes(UMO_DATA))
- fp.close()
- fp = open(MMOFILE, 'wb')
- fp.write(base64.decodebytes(MMO_DATA))
- fp.close()
+ with open(MOFILE, 'wb') as fp:
+ fp.write(base64.decodebytes(GNU_MO_DATA))
+ with open(UMOFILE, 'wb') as fp:
+ fp.write(base64.decodebytes(UMO_DATA))
+ with open(MMOFILE, 'wb') as fp:
+ fp.write(base64.decodebytes(MMO_DATA))
self.env = support.EnvironmentVarGuard()
self.env['LANGUAGE'] = 'xx'
gettext._translations.clear()
def test_the_alternative_interface(self):
eq = self.assertEqual
# test the alternative interface
- fp = open(self.mofile, 'rb')
- t = gettext.GNUTranslations(fp)
- fp.close()
+ with open(self.mofile, 'rb') as fp:
+ t = gettext.GNUTranslations(fp)
# Install the translation object
t.install()
eq(_('nudge nudge'), 'wink wink')
def test_plural_forms2(self):
eq = self.assertEqual
- fp = open(self.mofile, 'rb')
- t = gettext.GNUTranslations(fp)
- fp.close()
+ with open(self.mofile, 'rb') as fp:
+ t = gettext.GNUTranslations(fp)
x = t.ngettext('There is %s file', 'There are %s files', 1)
eq(x, 'Hay %s fichero')
x = t.ngettext('There is %s file', 'There are %s files', 2)
class UnicodeTranslationsTest(GettextBaseTest):
def setUp(self):
GettextBaseTest.setUp(self)
- fp = open(UMOFILE, 'rb')
- try:
+ with open(UMOFILE, 'rb') as fp:
self.t = gettext.GNUTranslations(fp)
- finally:
- fp.close()
self._ = self.t.gettext
def test_unicode_msgid(self):
class WeirdMetadataTest(GettextBaseTest):
def setUp(self):
GettextBaseTest.setUp(self)
- fp = open(MMOFILE, 'rb')
- try:
+ with open(MMOFILE, 'rb') as fp:
try:
self.t = gettext.GNUTranslations(fp)
except:
self.tearDown()
raise
- finally:
- fp.close()
def test_weird_metadata(self):
info = self.t.info()
type2test = tuple
def test_constructors(self):
- super().test_len()
+ super().test_constructors()
# calling built-in types without argument must return empty
self.assertEqual(tuple(), ())
t0_3 = (0, 1, 2, 3)
Library
-------
+- Issue #2236: distutils' mkpath ignored the mode parameter.
+
+- Fix typo in one sdist option (medata-check).
+
- Issue #11089: Fix performance issue limiting the use of ConfigParser()
with large config files.
projects / python / commitdiff