Repository navigation
Add support for image orientation - #148
Merged
Merged
Conversation
… from Exif data then fallback to normal orientation.
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 48 minutes. View limit details
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to The change adds image orientation support through the picture APIs and the Exif parsers. No actionable merge-blocking risk was found in the supplied context. Pre-merge checks |
  |
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage |  |
Docstring coverage is 34.92% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 126 functions across 21 files. | Write docstrings for the functions missing them to satisfy the coverage threshold. |
✅ Passed checks (4 passed)
-
-
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly and concisely describes the main change: adding support for image orientation based on Exif metadata and programmatic selection. Linked Issues check Issue #540requires images added withDocument.add_picture(..., width=...)to retain the intended orientation. The PR reads Exif orientation for JPEG, PNG, and TIFF images, defaults to normal orient…Out of Scope Changes check The source changes implement image-orientation parsing, the public orientation option, DrawingML transforms, and dimension handling. The test changes verify these behaviors. The reviewed summary estab…
-
-
✨ Finishing Touches 💡 2
-
-
-
📝 Generate docstrings 💡
-
-
-
-
-
-
- Commit to this branch
- Create a new PR
-
-
-
-
-
🛠️ Fix failing CI checks 💡
-
-
-
- Commit to this branch
- Create a new PR
-
-
🧪 Generate unit tests (beta)
-
-
-
- Commit to this branch
- Create a new PR
-
-
-
-
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # tests/image/test_jpeg.py
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces #110 (head fork
TheZ3ro:image-rotationis not pushable by this repo's maintainers, so the reviewed changes land here instead).Fixes python-openxml#540
Modern image formats (PNG, JPEG, Tiff, etc) embed the orientation in Exif metadata.
When rotating or displaying an image, software like Word, PowerPoint, macOS Preview, Android Google Photo, etc do not rotate the actual pixel data but instead change the orientation metadata integer (https://exifstrip.com/guides/orientation-tag-explained)
This is governed in OpenXML with the
a:xfrm(transform) tag. This tag can contain therot,flipV, andflipHattributes. By mapping the 1-8 orientation values to the respective rot and flip attributes it's possible to display images that were rotated by merely changing the Exif metadata with the correct orientation.This PR adds support for image orientation.
By default it gets orientation from Exif metadata. If orientation metadata is not available it falls back to "Normal" orientation (like now, defined by raw pixel data).
It is also possible to force a given orientation programmatically by:
Review fixes (commit
8ac3261)Addresses the CodeRabbit review on #110:
src/docx/image/jpeg.py: bothExif/Jfifconstructors now select the EXIF-specific APP1 marker (_JfifMarkers.exif_app1) so a preceding non-EXIF APP1 segment (e.g. XMP) can no longer override EXIF orientation; regression test builds a JFIF stream with non-EXIF APP1 before EXIF APP1 and asserts the later marker's orientation survives.src/docx/parts/story.py: resolveAUTOorientation before scaling and cross-mapwidth/heightwhenorientation.swaps_axes, so aspect-ratio scaling runs in native image axes whilewp:extentis swapped exactly once.src/docx/shape.py:InlineShape.width/heightsetters apply the same crossed-axis mapping whena:xfrm/@rotis 90°/270°, keeping explicit dimensions correct afterwp:extentaxis swapping.All 1656 tests pass;
ruff check/formatunchanged from baseline.Made with Cursor
Summary by CodeRabbit