Implement support for docm (macros)

python-openxml#1407

Author: FireMasterK

src/docx/__init__.py

@@ -54,6 +54,7 @@ def part_class_selector(content_type: str, reltype: str) -> Type[Part] | None:
 PartFactory.part_type_for[CT.WML_COMMENTS_IDS] = CommentsIdsPart
 PartFactory.part_type_for[CT.WML_PEOPLE] = PeoplePart
 PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN] = DocumentPart
+PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN_WITH_MACROS] = DocumentPart
 PartFactory.part_type_for[CT.WML_FOOTER] = FooterPart
 PartFactory.part_type_for[CT.WML_HEADER] = HeaderPart
 PartFactory.part_type_for[CT.WML_NUMBERING] = NumberingPart

src/docx/api.py

@@ -25,7 +25,10 @@ def Document(docx: str | IO[bytes] | None = None) -> DocumentObject:
     """
     docx = _default_docx_path() if docx is None else docx
     document_part = cast("DocumentPart", Package.open(docx).main_document_part)
-    if document_part.content_type != CT.WML_DOCUMENT_MAIN:
+    if document_part.content_type not in (
+        CT.WML_DOCUMENT_MAIN,
+        CT.WML_DOCUMENT_MAIN_WITH_MACROS,
+    ):
         tmpl = "file '%s' is not a Word file, content type is '%s'"
         raise ValueError(tmpl % (docx, document_part.content_type))
     return document_part.document

src/docx/opc/constants.py

@@ -146,6 +146,7 @@ class CONTENT_TYPE:
     WML_DOCUMENT_MAIN = (
         "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"
     )
+    WML_DOCUMENT_MAIN_WITH_MACROS = "application/vnd.ms-word.document.macroEnabled.main+xml"
     WML_ENDNOTES = "application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml"
     WML_FONT_TABLE = "application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml"
     WML_FOOTER = "application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml"

tests/test_api.py

@@ -2,9 +2,12 @@
 
 import pytest
 
+import docx
 from docx.api import Document as DocumentFactoryFn
 from docx.document import Document as DocumentCls
 from docx.opc.constants import CONTENT_TYPE as CT
+from docx.opc.part import PartFactory
+from docx.parts.document import DocumentPart
 
 from .unitutil.mock import FixtureRequest, Mock, class_mock, function_mock, instance_mock
 
@@ -35,12 +38,26 @@ def it_opens_the_default_docx_if_none_specified(
         Package_.open.assert_called_once_with("default-document.docx")
         assert document is document_
 
+    def it_opens_a_docm_file(self, Package_: Mock, document_: Mock):
+        document_part = Package_.open.return_value.main_document_part
+        document_part.document = document_
+        document_part.content_type = CT.WML_DOCUMENT_MAIN_WITH_MACROS
+
+        document = DocumentFactoryFn("foobar.docm")
+
+        Package_.open.assert_called_once_with("foobar.docm")
+        assert document is document_
+
     def it_raises_on_not_a_Word_file(self, Package_: Mock):
         Package_.open.return_value.main_document_part.content_type = "BOGUS"
 
         with pytest.raises(ValueError, match="file 'foobar.xlsx' is not a Word file,"):
             DocumentFactoryFn("foobar.xlsx")
 
+    def it_registers_macro_enabled_main_document_parts_with_the_package_reader(self):
+        assert docx is not None
+        assert PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN_WITH_MACROS] is DocumentPart
+
     # -- fixtures --------------------------------------------------------------------------------
 
     @pytest.fixture