junitparser 3.1.0__tar.gz → 3.1.2__tar.gz

{junitparser-3.1.0 → junitparser-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: junitparser
-Version: 3.1.0
+Version: 3.1.2
 Summary: Manipulates JUnit/xUnit Result XML files
 Home-page: https://github.com/weiwei/junitparser
 Author: Weiwei Wang
@@ -28,21 +28,21 @@ existing Result XML files, or create new JUnit/xUnit result XMLs from scratch.
 Features
 --------
 
-* Parse or modify existing JUnit/xUnit xml files.
-* Parse or modify non-standard or customized JUnit/xUnit xml files, by monkey
+* Parse or modify existing JUnit/xUnit XML files.
+* Parse or modify non-standard or customized JUnit/xUnit XML files, by monkey
   patching existing element definitions.
 * Create JUnit/xUnit test results from scratch.
-* Merge test result xml files.
-* Specify xml parser. For example you can use lxml to speed things up.
+* Merge test result XML files.
+* Specify XML parser. For example you can use lxml to speed things up.
 * Invoke from command line, or `python -m junitparser`
-* Python 2 and 3 support (As of Nov 2020, 1/4 of the users are still on Python 
+* Python 2 and 3 support (As of Nov 2020, 1/4 of the users are still on Python
   2, so there is no plan to drop Python 2 support)
 
 Note on version 2
 -----------------
 
-Version 2 improved support for pytest result xml files by fixing a few issues, 
-notably that there could be multiple <Failure> or <Error> entries. There is a 
+Version 2 improved support for pytest result XML files by fixing a few issues,
+notably that there could be multiple <Failure> or <Error> entries. There is a
 breaking change that ``TestCase.result`` is now a list instead of a single item.
 If you are using this attribute, please update your code accordingly.
 
@@ -149,7 +149,7 @@ Schema Support
 ~~~~~~~~~~~~~~~
 
 By default junitparser supports the schema of windyroad_, which is a relatively
-simple schema. 
+simple schema.
 
 .. _windyroad: https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd
 
@@ -248,7 +248,7 @@ read them out:
 Command Line
 ------------
 
-.. code-block:: shell
+.. code-block:: console
 
     $ junitparser --help
     usage: junitparser [-h] [-v] {merge} ...
@@ -265,7 +265,7 @@ Command Line
     -v, --version  show program's version number and exit
 
 
-.. code-block:: shell
+.. code-block:: console
 
     $ junitparser merge --help
     usage: junitparser merge [-h] [--glob] paths [paths ...] output
@@ -280,7 +280,7 @@ Command Line
       --suite-name SUITE_NAME
                   Name added to <testsuites>.
 
-.. code-block:: shell
+.. code-block:: console
 
     $ junitparser verify --help
     usage: junitparser verify [-h] [--glob] paths [paths ...]
@@ -295,7 +295,7 @@ Command Line
 Test
 ----
 
-The tests are written with python `unittest`, to run them, use pytest::
+The tests are written with python ``unittest``, to run them, use pytest::
 
     pytest test.py
 

{junitparser-3.1.0 → junitparser-3.1.2}/README.rst

@@ -12,21 +12,21 @@ existing Result XML files, or create new JUnit/xUnit result XMLs from scratch.
 Features
 --------
 
-* Parse or modify existing JUnit/xUnit xml files.
-* Parse or modify non-standard or customized JUnit/xUnit xml files, by monkey
+* Parse or modify existing JUnit/xUnit XML files.
+* Parse or modify non-standard or customized JUnit/xUnit XML files, by monkey
   patching existing element definitions.
 * Create JUnit/xUnit test results from scratch.
-* Merge test result xml files.
-* Specify xml parser. For example you can use lxml to speed things up.
+* Merge test result XML files.
+* Specify XML parser. For example you can use lxml to speed things up.
 * Invoke from command line, or `python -m junitparser`
-* Python 2 and 3 support (As of Nov 2020, 1/4 of the users are still on Python 
+* Python 2 and 3 support (As of Nov 2020, 1/4 of the users are still on Python
   2, so there is no plan to drop Python 2 support)
 
 Note on version 2
 -----------------
 
-Version 2 improved support for pytest result xml files by fixing a few issues, 
-notably that there could be multiple <Failure> or <Error> entries. There is a 
+Version 2 improved support for pytest result XML files by fixing a few issues,
+notably that there could be multiple <Failure> or <Error> entries. There is a
 breaking change that ``TestCase.result`` is now a list instead of a single item.
 If you are using this attribute, please update your code accordingly.
 
@@ -133,7 +133,7 @@ Schema Support
 ~~~~~~~~~~~~~~~
 
 By default junitparser supports the schema of windyroad_, which is a relatively
-simple schema. 
+simple schema.
 
 .. _windyroad: https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd
 
@@ -232,7 +232,7 @@ read them out:
 Command Line
 ------------
 
-.. code-block:: shell
+.. code-block:: console
 
     $ junitparser --help
     usage: junitparser [-h] [-v] {merge} ...
@@ -249,7 +249,7 @@ Command Line
     -v, --version  show program's version number and exit
 
 
-.. code-block:: shell
+.. code-block:: console
 
     $ junitparser merge --help
     usage: junitparser merge [-h] [--glob] paths [paths ...] output
@@ -264,7 +264,7 @@ Command Line
       --suite-name SUITE_NAME
                   Name added to <testsuites>.
 
-.. code-block:: shell
+.. code-block:: console
 
     $ junitparser verify --help
     usage: junitparser verify [-h] [--glob] paths [paths ...]
@@ -279,7 +279,7 @@ Command Line
 Test
 ----
 
-The tests are written with python `unittest`, to run them, use pytest::
+The tests are written with python ``unittest``, to run them, use pytest::
 
     pytest test.py
 

{junitparser-3.1.0 → junitparser-3.1.2}/junitparser/__init__.py

@@ -14,4 +14,4 @@ from .junitparser import (
     FloatAttr,
 )
 
-version = "3.1.0"
+version = "3.1.2"

{junitparser-3.1.0 → junitparser-3.1.2}/junitparser/cli.py

@@ -6,7 +6,7 @@ from . import JUnitXml, version
 
 
 def merge(paths, output, suite_name):
-    """Merge xml report."""
+    """Merge XML report."""
     result = JUnitXml()
     for path in paths:
         result += JUnitXml.fromfile(path)
@@ -45,7 +45,7 @@ def _parser(prog_name=None):  # pragma: no cover
 
     # command: merge
     merge_parser = command_parser.add_parser(
-        "merge", help="Merge Junit XML format reports with junitparser."
+        "merge", help="Merge JUnit XML format reports with junitparser."
     )
     merge_parser.add_argument(
         "--glob",
@@ -56,7 +56,7 @@ def _parser(prog_name=None):  # pragma: no cover
     )
     merge_parser.add_argument("paths", nargs="+", help="Original XML path(s).")
     merge_parser.add_argument(
-        "output", help='Merged XML Path, setting to "-" will output console'
+        "output", help='Merged XML Path, setting to "-" will output to the console'
     )
     merge_parser.add_argument(
         "--suite-name",

{junitparser-3.1.0 → junitparser-3.1.2}/junitparser/junitparser.py

@@ -3,13 +3,15 @@ junitparser is a JUnit/xUnit Result XML Parser. Use it to parse and manipulate
 existing Result XML files, or create new JUnit/xUnit result XMLs from scratch.
 
 Reference schema: https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd
-This according to the document is Apache Ant's JUnit output.
 
-See documentation for other supported schemas.
+This, according to the document, is Apache Ant's JUnit output.
+
+See the documentation for other supported schemas.
 """
 
 import itertools
 from copy import deepcopy
+from typing import List
 
 try:
     from lxml import etree
@@ -56,14 +58,14 @@ class Attr(object):
     By default they are all string values. To support different value types,
     inherit this class and define your own methods.
 
-    Also see: :class:`InitAttr`, :class:`FloatAttr`.
+    Also see: :class:`IntAttr`, :class:`FloatAttr`.
     """
 
     def __init__(self, name: str = None):
         self.name = name
 
     def __get__(self, instance, cls):
-        """Gets value from attribute, return None if attribute doesn't exist."""
+        """Get value from attribute, return ``None`` if attribute doesn't exist."""
         return instance._elem.attrib.get(self.name)
 
     def __set__(self, instance, value: str):
@@ -75,7 +77,7 @@ class Attr(object):
 class IntAttr(Attr):
     """An integer attribute for an XML element.
 
-    This class is used internally for counting test cases, but you could use
+    This class is used internally for counting testcases, but you could use
     it for any specific purpose.
     """
 
@@ -121,7 +123,7 @@ def attributed(cls):
 
 
 class junitxml(type):
-    """Metaclass to decorate the xml class"""
+    """Metaclass to decorate the XML class."""
 
     def __new__(meta, name, bases, methods):
         cls = super(junitxml, meta).__new__(meta, name, bases, methods)
@@ -130,7 +132,7 @@ class junitxml(type):
 
 
 class Element(metaclass=junitxml):
-    """Base class for all Junit XML elements."""
+    """Base class for all JUnit XML elements."""
 
     def __init__(self, name: str = None):
         if not name:
@@ -152,27 +154,27 @@ class Element(metaclass=junitxml):
         return """<Element '%s'>""" % tag
 
     def append(self, sub_elem):
-        """Adds the element subelement to the end of this elements internal
+        """Add the element subelement to the end of this elements internal
         list of subelements.
         """
         self._elem.append(sub_elem._elem)
 
     def extend(self, sub_elems):
-        """Adds elements subelement to the end of this elements internal
+        """Add elements subelement to the end of this elements internal
         list of subelements.
         """
         self._elem.extend((sub_elem._elem for sub_elem in sub_elems))
 
     @classmethod
     def fromstring(cls, text: str):
-        """Construct Junit objects from a XML string."""
+        """Construct JUnit object *cls* from XML string *test*."""
         instance = cls()
         instance._elem = etree.fromstring(text)  # nosec
         return instance
 
     @classmethod
     def fromelem(cls, elem):
-        """Constructs Junit objects from an elementTree element."""
+        """Construct JUnit objects from an ElementTree element *elem*."""
         if elem is None:
             return
         instance = cls()
@@ -183,25 +185,25 @@ class Element(metaclass=junitxml):
         return instance
 
     def iterchildren(self, Child):
-        """Iterate through specified Child type elements."""
+        """Iterate through specified *Child* type elements."""
         elems = self._elem.iterfind(Child._tag)
         for elem in elems:
             yield Child.fromelem(elem)
 
     def child(self, Child):
-        """Find a single child of specified Child type."""
+        """Find a single child of specified *Child* type."""
         elem = self._elem.find(Child._tag)
         return Child.fromelem(elem)
 
     def remove(self, sub_elem):
-        """Remove a sub element."""
+        """Remove subelement *sub_elem*."""
         for elem in self._elem.iterfind(sub_elem._tag):
             child = sub_elem.__class__.fromelem(elem)
             if child == sub_elem:
                 self._elem.remove(child._elem)
 
     def tostring(self):
-        """Converts element to XML string."""
+        """Convert element to XML string."""
         return etree.tostring(self._elem, encoding="utf-8")
 
 
@@ -209,8 +211,8 @@ class Result(Element):
     """Base class for test result.
 
     Attributes:
-        message: result as message string
-        type: message type
+        message: Result as message string.
+        type: Message type.
     """
 
     _tag = None
@@ -271,10 +273,10 @@ POSSIBLE_RESULTS = {Failure, Error, Skipped}
 
 
 class System(Element):
-    """Parent class for SystemOut and SystemErr.
+    """Parent class for :class:`SystemOut` and :class:`SystemErr`.
 
     Attributes:
-        text: the output message
+        text: The output message.
     """
 
     _tag = ""
@@ -304,20 +306,16 @@ class TestCase(Element):
     """Object to store a testcase and its result.
 
     Attributes:
-        name: case name
-        classname: the parent class of the case
-        time: how much time is consumed by the test
-
-    Properties:
-        result: Failure, Skipped, or Error
-        system_out: stdout
-        system_err: stderr
+        name: Name of the testcase.
+        classname: The parent class of the testcase.
+        time: The time consumed by the testcase.
     """
 
     _tag = "testcase"
     name = Attr()
     classname = Attr()
     time = FloatAttr()
+    __test__ = False
 
     def __init__(self, name: str = None, classname: str = None, time: float = None):
         super().__init__(self._tag)
@@ -357,7 +355,7 @@ class TestCase(Element):
 
     @property
     def result(self):
-        """A list of Failure, Skipped, or Error objects."""
+        """A list of :class:`Failure`, :class:`Skipped`, or :class:`Error` objects."""
         results = []
         for entry in self:
             if isinstance(entry, tuple(POSSIBLE_RESULTS)):
@@ -411,13 +409,13 @@ class TestCase(Element):
 
 
 class Property(Element):
-    """A key/value pare that's stored in the test suite.
+    """A key/value pare that's stored in the testsuite.
 
     Use it to store anything you find interesting or useful.
 
     Attributes:
-        name: the property name
-        value: the property value
+        name: The property name.
+        value: The property value.
     """
 
     _tag = "property"
@@ -441,7 +439,7 @@ class Property(Element):
 
 
 class Properties(Element):
-    """A list of properties inside a test suite.
+    """A list of properties inside a testsuite.
 
     See :class:`Property`
     """
@@ -474,14 +472,14 @@ class TestSuite(Element):
     """The <testsuite> object.
 
     Attributes:
-        name: test suite name
-        hostname: name of the test machine
-        time: time concumed by the test suite
-        timestamp: when the test was run
-        tests: total number of tests
-        failures: number of failed tests
-        errors: number of cases with errors
-        skipped: number of skipped cases
+        name: The name of the testsuite.
+        hostname: Name of the test machine.
+        time: Time consumed by the testsuite.
+        timestamp: When the test was run.
+        tests: Total number of tests.
+        failures: Number of failed tests.
+        errors: Number of cases with errors.
+        skipped: Number of skipped cases.
     """
 
     _tag = "testsuite"
@@ -493,6 +491,7 @@ class TestSuite(Element):
     failures = IntAttr()
     errors = IntAttr()
     skipped = IntAttr()
+    __test__ = False
 
     def __init__(self, name=None):
         super().__init__(self._tag)
@@ -527,7 +526,7 @@ class TestSuite(Element):
 
     def __add__(self, other):
         if self == other:
-            # Merge the two suites
+            # Merge the two testsuites
             result = deepcopy(self)
             for case in other:
                 result._add_testcase_no_update_stats(case)
@@ -535,7 +534,7 @@ class TestSuite(Element):
                 result.add_testsuite(suite)
             result.update_statistics()
         else:
-            # Create a new test result containing two suites
+            # Create a new test result containing two testsuites
             result = JUnitXml()
             result.add_testsuite(self)
             result.add_testsuite(other)
@@ -557,14 +556,14 @@ class TestSuite(Element):
         return result
 
     def remove_testcase(self, testcase: TestCase):
-        """Removes a test case from the suite."""
+        """Remove testcase *testcase* from the testsuite."""
         for case in self:
             if case == testcase:
                 super().remove(case)
                 self.update_statistics()
 
     def update_statistics(self):
-        """Updates test count and test time."""
+        """Update test count and test time."""
         tests = errors = failures = skipped = 0
         time = 0
         for case in self:
@@ -584,10 +583,10 @@ class TestSuite(Element):
         self.skipped = skipped
         self.time = round(time, 3)
 
-    def add_property(self, name, value):
-        """Adds a property to the testsuite.
+    def add_property(self, name: str, value: str):
+        """Add a property *name* = *value* to the testsuite.
 
-        See :class:`Property` and :class:`Properties`
+        See :class:`Property` and :class:`Properties`.
         """
 
         props = self.child(Properties)
@@ -597,29 +596,29 @@ class TestSuite(Element):
         prop = Property(name, value)
         props.add_property(prop)
 
-    def add_testcase(self, testcase):
-        """Adds a testcase to the suite."""
+    def add_testcase(self, testcase: TestCase):
+        """Add a testcase *testcase* to the testsuite."""
         self.append(testcase)
         self.update_statistics()
 
-    def add_testcases(self, testcases):
-        """Adds test cases to the suite."""
+    def add_testcases(self, testcases: List[TestCase]):
+        """Add testcases *testcases* to the testsuite."""
         self.extend(testcases)
         self.update_statistics()
 
-    def _add_testcase_no_update_stats(self, testcase):
-        """
-        Adds a testcase to the suite (without updating stats).
+    def _add_testcase_no_update_stats(self, testcase: TestCase):
+        """Add *testcase* to the testsuite (without updating statistics).
+
         For internal use only to avoid quadratic behaviour in merge.
         """
         self.append(testcase)
 
     def add_testsuite(self, suite):
-        """Adds a testsuite inside current testsuite."""
+        """Add a testsuite *suite* to the testsuite."""
         self.append(suite)
 
     def properties(self):
-        """Iterates through all properties."""
+        """Iterate through all :class:`Property` elements in the testsuite."""
         props = self.child(Properties)
         if props is None:
             return
@@ -627,7 +626,7 @@ class TestSuite(Element):
             yield prop
 
     def remove_property(self, property_: Property):
-        """Removes a property."""
+        """Remove property *property_* from the testsuite."""
         props = self.child(Properties)
         if props is None:
             return
@@ -636,7 +635,7 @@ class TestSuite(Element):
                 props.remove(property_)
 
     def testsuites(self):
-        """Iterates through all testsuites."""
+        """Iterate through all testsuites."""
         for suite in self.iterchildren(TestSuite):
             yield suite
 
@@ -647,15 +646,15 @@ class TestSuite(Element):
 class JUnitXml(Element):
     """The JUnitXml root object.
 
-    It may contains a :class:`TestSuites` or a :class:`TestSuite`.
+    It may contain ``<TestSuites>`` or a ``<TestSuite>``.
 
     Attributes:
-        name: test suite name if it only contains one test suite
-        time: time consumed by the test suites
-        tests: total number of tests
-        failures: number of failed cases
-        errors: number of cases with errors
-        skipped: number of skipped cases
+        name: Name of the testsuite if it only contains one testsuite.
+        time: Time consumed by the testsuites.
+        tests: Total number of tests.
+        failures: Number of failed cases.
+        errors: Number of cases with errors.
+        skipped: Number of skipped cases.
     """
 
     _tag = "testsuites"
@@ -699,7 +698,7 @@ class JUnitXml(Element):
         return self
 
     def add_testsuite(self, suite: TestSuite):
-        """Add a test suite."""
+        """Add a testsuite."""
         for existing_suite in self:
             if existing_suite == suite:
                 for case in suite:
@@ -726,7 +725,7 @@ class JUnitXml(Element):
 
     @classmethod
     def fromroot(cls, root_elem: Element):
-        """Constructs Junit objects from an elementTree root element."""
+        """Construct JUnit objects from an elementTree root element."""
         if root_elem.tag == "testsuites":
             instance = cls()
         elif root_elem.tag == "testsuite":
@@ -738,7 +737,7 @@ class JUnitXml(Element):
 
     @classmethod
     def fromstring(cls, text: str):
-        """Construct Junit objects from a XML string."""
+        """Construct JUnit objects from an XML string."""
         root_elem = etree.fromstring(text)  # nosec
         return cls.fromroot(root_elem)
 
@@ -755,7 +754,7 @@ class JUnitXml(Element):
         return instance
 
     def write(self, filepath: str = None, pretty=False, to_console=False):
-        """Write the object into a junit xml file.
+        """Write the object into a JUnit XML file.
 
         If `file_path` is not specified, it will write to the original file.
         If `pretty` is True, the result file will be more human friendly.

{junitparser-3.1.0 → junitparser-3.1.2}/junitparser/xunit2.py

@@ -2,9 +2,9 @@
 The flavor based on Jenkins xunit plugin:
 https://github.com/jenkinsci/xunit-plugin/blob/xunit-2.3.2/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd
 
-According to the internet, The schema is compatible with:
+According to the internet, the schema is compatible with:
 
-- pytest (as default, though it also supports a "legacy" xunit1 flavor)
+- Pytest (as default, though it also supports a "legacy" xunit1 flavor)
 - Erlang/OTP
 - Maven Surefire
 - CppTest
@@ -20,7 +20,7 @@ T = TypeVar("T")
 
 
 class JUnitXml(junitparser.JUnitXml):
-    # Pytest and xunit schema doesn't have skipped in testsuites
+    # Pytest and xunit schema doesn't have "skipped" in testsuites
     skipped = None
 
     def update_statistics(self):
@@ -40,7 +40,7 @@ class JUnitXml(junitparser.JUnitXml):
 
 
 class TestSuite(junitparser.TestSuite):
-    """TestSuit for Pytest, with some different attributes."""
+    """TestSuite for Pytest, with some different attributes."""
 
     group = junitparser.Attr()
     id = junitparser.Attr()
@@ -194,9 +194,9 @@ class TestCase(junitparser.TestCase):
         return self._rerun_results(FlakyFailure)
 
     def flaky_errors(self):
-        """<flakyFailure>"""
+        """<flakyError>"""
         return self._rerun_results(FlakyError)
 
     def add_rerun_result(self, result: RerunType):
-        """Append a rerun result to the test case. A case can have multiple rerun results"""
+        """Append a rerun result to the testcase. A testcase can have multiple rerun results."""
         self.append(result)