Add branch coverage support for text and XML formats (#250)

* Add branch coverage support for text and XML formats (#110)

Auto-detect and display Branch/BrPart columns in the coverage table
when pytest runs with --cov-branch or branch=True. Supported for both
text coverage output and XML coverage reports. No new action inputs
required — fully backward compatible.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Refactor parseTotalLine and getTotalCoverage for improved validation and type consistency

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

Author: MishaKav

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog of the Pytest Coverage Comment
 
+## [Pytest Coverage Comment 1.4.0](https://github.com/MishaKav/pytest-coverage-comment/tree/v1.4.0)
+
+**Release Date:** 2026-02-22
+
+#### Changes
+
+- feat: auto-detect and display branch coverage columns (`Branch`, `BrPart`) in coverage table (#110)
+- supported for both text format (`pytest --cov --cov-branch`) and XML format (`coverage.xml`)
+- no new action inputs required — columns appear automatically when branch data is present
+- fully backward compatible — existing users see no change
+
 ## [Pytest Coverage Comment 1.3.0](https://github.com/MishaKav/pytest-coverage-comment/tree/v1.3.0)
 
 **Release Date:** 2026-02-21

dist/index.js

@@ -38290,6 +38290,15 @@ const isValidCoverageContent = (data) => {
   return wordsToInclude.every((w) => data.includes(w));
 };
 
+// return true if coverage data includes branch coverage columns
+const hasBranchCoverage = (data) => {
+  if (!data || !data.length) {
+    return false;
+  }
+
+  return data.includes('Branch') && data.includes('BrPart');
+};
+
 // return full html coverage report and coverage percentage
 const getCoverageReport = (options) => {
   const { covFile, covXmlFile } = options;
@@ -38351,8 +38360,9 @@ const getTotal = (data) => {
 
   const lines = data.split('\n');
   const line = lines.find((l) => l.includes('TOTAL    '));
+  const hasBranch = hasBranchCoverage(data);
 
-  return parseTotalLine(line);
+  return parseTotalLine(line, hasBranch);
 };
 
 // get number of warnings from coverage-file
@@ -38374,14 +38384,15 @@ const getWarnings = (data) => {
 };
 
 // parse one line from coverage-file
-const parseOneLine = (line) => {
+const parseOneLine = (line, hasBranch = false) => {
   if (!line) {
     return null;
   }
 
   const parsedLine = line.split('   ').filter((l) => l);
+  const minCols = hasBranch ? 6 : 4;
 
-  if (parsedLine.length < 4) {
+  if (parsedLine.length < minCols) {
     return null;
   }
 
@@ -38395,33 +38406,48 @@ const parseOneLine = (line) => {
     : parsedLine[parsedLine.length - 1] &&
       parsedLine[parsedLine.length - 1].split(', ');
 
-  return {
+  const result = {
     name: parsedLine[0],
     stmts: parsedLine[1].trim(),
     miss: parsedLine[2].trim(),
     cover,
     missing,
   };
+
+  if (hasBranch) {
+    result.branch = parsedLine[3].trim();
+    result.brpart = parsedLine[4].trim();
+  }
+
+  return result;
 };
 
 // parse total line from coverage-file
-const parseTotalLine = (line) => {
+const parseTotalLine = (line, hasBranch = false) => {
   if (!line) {
     return null;
   }
 
   const parsedLine = line.split('  ').filter((l) => l);
+  const minCols = hasBranch ? 6 : 4;
 
-  if (parsedLine.length < 4) {
+  if (parsedLine.length < minCols) {
     return null;
   }
 
-  return {
+  const result = {
     name: parsedLine[0],
     stmts: parsedLine[1].trim(),
     miss: parsedLine[2].trim(),
     cover: parsedLine[parsedLine.length - 1].trim(),
   };
+
+  if (hasBranch) {
+    result.branch = parsedLine[3].trim();
+    result.brpart = parsedLine[4].trim();
+  }
+
+  return result;
 };
 
 // parse coverage-file
@@ -38432,7 +38458,9 @@ const parse = (data) => {
     return null;
   }
 
-  return actualLines.map(parseOneLine);
+  const hasBranch = hasBranchCoverage(data);
+
+  return actualLines.map((line) => parseOneLine(line, hasBranch));
 };
 
 // collapse all lines to folders structure
@@ -38499,6 +38527,7 @@ const toTable = (data, options, dataFromXml = null) => {
   }
   const totalLine = dataFromXml ? dataFromXml.total : getTotal(data);
   options.hasMissing = coverage.some((c) => c.missing);
+  options.hasBranch = coverage.some((c) => c.branch !== undefined);
 
   core.info(`Generating coverage report`);
   const headTr = toHeadRow(options);
@@ -38545,9 +38574,11 @@ const toTable = (data, options, dataFromXml = null) => {
 
 // make html head row - th
 const toHeadRow = (options) => {
-  const lastTd = options.hasMissing ? '<th>Missing</th>' : '';
+  const branchTh = options.hasBranch ? '<th>Branch</th><th>BrPart</th>' : '';
+  const missingTh = options.hasMissing ? '<th>Missing</th>' : '';
 
-  return `<tr><th>File</th><th>Stmts</th><th>Miss</th><th>Cover</th>${lastTd}</tr>`;
+  // prettier-ignore
+  return `<tr><th>File</th><th>Stmts</th><th>Miss</th>${branchTh}<th>Cover</th>${missingTh}</tr>`;
 };
 
 // make html row - tr
@@ -38556,17 +38587,26 @@ const toRow = (item, indent = false, options) => {
 
   const name = toFileNameTd(item, indent, options);
   const missing = toMissingTd(item, options);
-  const lastTd = options.hasMissing ? `<td>${missing}</td>` : '';
+  const branchTd = options.hasBranch
+    ? `<td>${item.branch || 0}</td><td>${item.brpart || 0}</td>`
+    : '';
+  const missingTd = options.hasMissing ? `<td>${missing}</td>` : '';
 
-  return `<tr><td>${name}</td><td>${stmts}</td><td>${miss}</td><td>${cover}</td>${lastTd}</tr>`;
+  // prettier-ignore
+  return `<tr><td>${name}</td><td>${stmts}</td><td>${miss}</td>${branchTd}<td>${cover}</td>${missingTd}</tr>`;
 };
 
 // make summary row - tr
 const toTotalRow = (item, options) => {
   const { name, stmts, miss, cover } = item;
-  const emptyCell = options.hasMissing ? '<td>&nbsp;</td>' : '';
+  const branchTd = options.hasBranch
+    ? `<td><b>${item.branch || 0}</b></td>` +
+      `<td><b>${item.brpart || 0}</b></td>`
+    : '';
+  const missingTd = options.hasMissing ? '<td>&nbsp;</td>' : '';
 
-  return `<tr><td><b>${name}</b></td><td><b>${stmts}</b></td><td><b>${miss}</b></td><td><b>${cover}</b></td>${emptyCell}</tr>`;
+  // prettier-ignore
+  return `<tr><td><b>${name}</b></td><td><b>${stmts}</b></td><td><b>${miss}</b></td>${branchTd}<td><b>${cover}</b></td>${missingTd}</tr>`;
 };
 
 // make fileName cell - td
@@ -38589,7 +38629,8 @@ const toFolderTd = (path, options) => {
     return '';
   }
 
-  const colspan = options.hasMissing ? 5 : 4;
+  const colspan =
+    4 + (options.hasBranch ? 2 : 0) + (options.hasMissing ? 1 : 0);
   return `<tr><td colspan="${colspan}"><b>${path}</b></td></tr>`;
 };
 
@@ -38647,13 +38688,22 @@ const getTotalCoverage = (parsedXml) => {
   const cover = parseInt(parseFloat(coverage['line-rate']) * 100);
   const linesValid = parseInt(coverage['lines-valid']);
   const linesCovered = parseInt(coverage['lines-covered']);
+  const branchesValid = parseInt(coverage['branches-valid']) || 0;
+  const branchesCovered = parseInt(coverage['branches-covered']) || 0;
 
-  return {
+  const result = {
     name: 'TOTAL',
     stmts: linesValid,
     miss: linesValid - linesCovered,
     cover: cover !== '0' ? `${cover}%` : '0',
   };
+
+  if (branchesValid > 0) {
+    result.branch = branchesValid.toString();
+    result.brpart = (branchesValid - branchesCovered).toString();
+  }
+
+  return result;
 };
 
 // return true if "coverage file" include right structure
@@ -38750,7 +38800,13 @@ const parseClass = (classObj, xmlSkipCovered) => {
     return null;
   }
 
-  const { stmts, missing, totalMissing: miss } = parseLines(classObj.lines);
+  const {
+    stmts,
+    missing,
+    totalMissing: miss,
+    branchTotal,
+    branchMissing,
+  } = parseLines(classObj.lines);
   const { filename: name, 'line-rate': lineRate } = classObj['$'];
   const isFullCoverage = lineRate === '1';
 
@@ -38762,24 +38818,57 @@ const parseClass = (classObj, xmlSkipCovered) => {
     ? '100%'
     : `${parseInt(parseFloat(lineRate) * 100)}%`;
 
-  return { name, stmts, miss, cover, missing };
+  const result = { name, stmts, miss, cover, missing };
+
+  if (branchTotal > 0) {
+    result.branch = branchTotal.toString();
+    result.brpart = branchMissing.toString();
+  }
+
+  return result;
 };
 
 const parseLines = (lines) => {
+  const emptyResult = {
+    stmts: '0',
+    missing: '',
+    totalMissing: '0',
+    branchTotal: 0,
+    branchMissing: 0,
+  };
+
   if (!lines || !lines.length || !lines[0].line) {
-    return { stmts: '0', missing: '', totalMissing: '0' };
+    return emptyResult;
   }
 
   let stmts = 0;
   const missingLines = [];
+  let branchTotal = 0;
+  let branchMissing = 0;
 
   lines[0].line.forEach((line) => {
     stmts++;
-    const { hits, number } = line['$'];
+    const {
+      hits,
+      number,
+      branch,
+      'condition-coverage': condCoverage,
+    } = line['$'];
 
     if (hits === '0') {
       missingLines.push(parseInt(number));
     }
+
+    if (branch === 'true' && condCoverage) {
+      const match = condCoverage.match(/\((\d+)\/(\d+)\)/);
+
+      if (match) {
+        const covered = parseInt(match[1]);
+        const total = parseInt(match[2]);
+        branchTotal += total;
+        branchMissing += total - covered;
+      }
+    }
   });
 
   const missing = missingLines.reduce((arr, val, i, a) => {
@@ -38801,6 +38890,8 @@ const parseLines = (lines) => {
     stmts: stmts.toString(),
     missing: missingText,
     totalMissing: missingLines.length.toString(),
+    branchTotal,
+    branchMissing,
   };
 };
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "pytest-coverage-comment",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Comments a pull request with the pytest code coverage badge, full report and tests summary",
   "author": "Misha Kav",
   "license": "MIT",

package.json

@@ -36,7 +36,7 @@ const getPathToFile = (pathToFile) => {
 const main = async () => {
   const covFile = './../data/pytest-coverage_4.txt';
   const xmlFile = './../data/pytest_1.xml';
-  const covXmlFile = './../data/coverage_1.xml';
+  const covXmlFile = './../data/coverage_1.xml'; // use coverage_2.xml for branch coverage
   const prefix = path.dirname(path.dirname(path.resolve(covFile))) + '/';
   // eslint-disable-next-line
   const multipleFiles = [