Title: Add revision management capability + tests + docs by amithkk · Pull Request #1534 · python-openxml/python-docx · GitHub
Open Graph Title: Add revision management capability + tests + docs by amithkk · Pull Request #1534 · python-openxml/python-docx
X Title: Add revision management capability + tests + docs by amithkk · Pull Request #1534 · python-openxml/python-docx
Description: This PR adds comprehensive support for creating and managing tracked changes (revisions) in Word documents, enabling programmatic document editing with full revision history visible in Microsoft Word. Tests have been added for new functionality, and existing tests have been run to ensure that backwards compatibility is maintained. Why? Users need to make programmatic changes to Word documents while preserving some sort of an audit trail. Solves #930 and #340 Features Paragraph.add_run_tracked() - Add text as a tracked insertion Run.delete_tracked() - Mark existing text as a tracked deletion Paragraph.replace_tracked() - Replace specific text with revision tracking Document.find_and_replace_tracked() - Bulk find-and-replace across entire document document.settings.track_revisions - Enable/disable track changes mode TrackedInsertion and TrackedDeletion proxy classes with accept() and reject() methods Author and date metadata on all tracked changes Optional comment attachment to replacements Example Usage from docx import Document doc = Document('contract.docx') doc.settings.track_revisions = True count = doc.find_and_replace_tracked( "ACME Corp", "NewCo Inc", author="Legal Bot", comment="Company name updated per merger" ) doc.save('contract_revised.docx') This is just barebones, and this capability can be extended by later additions to possibly build out a context manager (eg. with document.track_all_changes() as doc:) to make it function similar to how "Track Changes" works in word. However there are a fair number of edge cases you'd have to deal with in that situation. Some of this work draws on the exhaustive code written in OpenXmlPowerTools WmlComparer and the underlying .NET library.
Open Graph Description: This PR adds comprehensive support for creating and managing tracked changes (revisions) in Word documents, enabling programmatic document editing with full revision history visible in Microsoft Wo...
X Description: This PR adds comprehensive support for creating and managing tracked changes (revisions) in Word documents, enabling programmatic document editing with full revision history visible in Microsoft Wo...
Opengraph URL: https://github.com/python-openxml/python-docx/pull/1534
X: @github
Domain: patch-diff.githubusercontent.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:f9fb004e-1e23-bfb1-0b48-6bd54decf1d5 |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | B954:23699C:9170DA:C3A124:6973DF43 |
| html-safe-nonce | 1d7c3f5f4d2ad88e6bd84123b99af6a1efeb0e90691c25292f5fc679c4274566 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCOTU0OjIzNjk5Qzo5MTcwREE6QzNBMTI0OjY5NzNERjQzIiwidmlzaXRvcl9pZCI6IjUyMzgzMDE0NTkyNTc0ODMwNzYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 46ce0c86c88729d6792893789affc380ab64fd52a0372f1a25bb6578785c6960 |
| hovercard-subject-tag | pull_request:3152257580 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,checks,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python-openxml/python-docx/pull/1534/checks |
| twitter:image | https://avatars.githubusercontent.com/u/1029727?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1029727?s=400&v=4 |
| og:image:alt | This PR adds comprehensive support for creating and managing tracked changes (revisions) in Word documents, enabling programmatic document editing with full revision history visible in Microsoft Wo... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | bcae444bf5f475d712cb2ad536c10eaebd406c84ae2d3a77c5f05aee5010c786 |
| turbo-cache-control | no-preview |
| go-import | github.com/python-openxml/python-docx git https://github.com/python-openxml/python-docx.git |
| octolytics-dimension-user_id | 3403760 |
| octolytics-dimension-user_login | python-openxml |
| octolytics-dimension-repository_id | 13592924 |
| octolytics-dimension-repository_nwo | python-openxml/python-docx |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 13592924 |
| octolytics-dimension-repository_network_root_nwo | python-openxml/python-docx |
| turbo-body-classes | logged-out env-production page-responsive full-width full-width-p-0 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 7da815895d8ce3ba55f0017efb5a34bac921756a |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width