reorg: extract docx.parts subpackage

Steve Canny · Steve Canny · commit 6d46e862e031 · 2013-12-26T22:51:16.000-08:00
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -10,7 +10,7 @@
 from docx.opc.constants import CONTENT_TYPE as CT
 from docx.opc.package import PartFactory
 
-from docx.parts import _Document
+from docx.parts.document import _Document
 
 PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN] = _Document
 
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -32,7 +32,7 @@ class ValidationError(Exception):
 register_custom_element_class('pic:pic', CT_Picture)
 register_custom_element_class('wp:inline', CT_Inline)
 
-from docx.oxml.parts import CT_Body, CT_Document
+from docx.oxml.parts.document import CT_Body, CT_Document
 register_custom_element_class('w:body', CT_Body)
 register_custom_element_class('w:document', CT_Document)
 
diff --git a/docx/oxml/parts/__init__.py b/docx/oxml/parts/__init__.py
diff --git a/docx/oxml/parts/document.py b/docx/oxml/parts/document.py
@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 """
-Custom element classes that correspond to OPC parts like <w:document>.
+Custom element classes that correspond to the document part, e.g.
+<w:document>.
 """
 
 from docx.oxml.shared import OxmlBaseElement, qn
diff --git a/docx/parts/__init__.py b/docx/parts/__init__.py
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -119,13 +119,6 @@ def tables(self):
         return [Table(tbl) for tbl in self._body.tbl_lst]
 
 
-class Image(Part):
-    """
-    An image part. Corresponds to the target part of a relationship with type
-    RELATIONSHIP_TYPE.IMAGE.
-    """
-
-
 class InlineShape(object):
     """
     Proxy for an ``<wp:inline>`` element, representing the container for an
diff --git a/docx/parts/image.py b/docx/parts/image.py
@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+"""
+The proxy class for an image part, and related objects.
+"""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+from docx.opc.package import Part
+
+
+class Image(Part):
+    """
+    An image part. Corresponds to the target part of a relationship with type
+    RELATIONSHIP_TYPE.IMAGE.
+    """
diff --git a/features/steps/shape.py b/features/steps/shape.py
@@ -12,7 +12,7 @@
 
 from docx import Document
 from docx.enum.shape import WD_INLINE_SHAPE
-from docx.parts import InlineShape, InlineShapes
+from docx.parts.document import InlineShape, InlineShapes
 
 from .helpers import test_docx, test_file_path
 
diff --git a/tests/oxml/parts/__init__.py b/tests/oxml/parts/__init__.py
diff --git a/tests/oxml/parts/test_document.py b/tests/oxml/parts/test_document.py
@@ -4,11 +4,11 @@
 Test suite for the docx.oxml.parts module.
 """
 
-from docx.oxml.parts import CT_Body
+from docx.oxml.parts.document import CT_Body
 from docx.oxml.text import CT_P
 
-from .unitdata.parts import a_body, a_document
-from .unitdata.text import a_p, a_sectPr
+from .unitdata.document import a_body, a_document
+from ..unitdata.text import a_p, a_sectPr
 
 
 class DescribeCT_Body(object):
diff --git a/tests/oxml/parts/unitdata/__init__.py b/tests/oxml/parts/unitdata/__init__.py
diff --git a/tests/oxml/parts/unitdata/document.py b/tests/oxml/parts/unitdata/document.py
@@ -4,7 +4,7 @@
 Test data builders for parts XML.
 """
 
-from ...unitdata import BaseBuilder
+from ....unitdata import BaseBuilder
 
 
 class CT_BodyBuilder(BaseBuilder):
diff --git a/tests/parts/__init__.py b/tests/parts/__init__.py
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 """
-Test suite for the docx.parts module
+Test suite for the docx.parts.document module
 """
 
 from __future__ import absolute_import, print_function, unicode_literals
@@ -11,22 +11,23 @@
 from mock import Mock
 
 from docx.enum.shape import WD_INLINE_SHAPE
-from docx.oxml.parts import CT_Body, CT_Document
+from docx.oxml.parts.document import CT_Body, CT_Document
 from docx.oxml.shared import nsmap
 from docx.oxml.text import CT_R
-from docx.parts import _Body, _Document, Image, InlineShape, InlineShapes
+from docx.parts.document import _Body, _Document, InlineShape, InlineShapes
+from docx.parts.image import Image
 from docx.table import Table
 from docx.text import Paragraph
 
-from .oxml.unitdata.dml import (
+from ..oxml.unitdata.dml import (
     a_blip, a_blipFill, a_drawing, a_graphic, a_graphicData, a_pic, an_inline
 )
-from .oxml.unitdata.parts import a_body, a_document
-from .oxml.unitdata.table import (
+from ..oxml.parts.unitdata.document import a_body, a_document
+from ..oxml.unitdata.table import (
     a_gridCol, a_tbl, a_tblGrid, a_tblPr, a_tc, a_tr
 )
-from .oxml.unitdata.text import a_p, a_sectPr, an_r
-from .unitutil import (
+from ..oxml.unitdata.text import a_p, a_sectPr, an_r
+from ..unitutil import (
     function_mock, class_mock, initializer_mock, instance_mock, property_mock
 )
 
@@ -90,15 +91,15 @@ def document_body_fixture(self, request, _Body_):
 
     @pytest.fixture
     def _Body_(self, request):
-        return class_mock(request, 'docx.parts._Body')
+        return class_mock(request, 'docx.parts.document._Body')
 
     @pytest.fixture
     def init(self, request):
         return initializer_mock(request, _Document)
 
     @pytest.fixture
     def InlineShapes_(self, request):
-        return class_mock(request, 'docx.parts.InlineShapes')
+        return class_mock(request, 'docx.parts.document.InlineShapes')
 
     @pytest.fixture
     def inline_shapes_fixture(self, request, InlineShapes_):
@@ -112,11 +113,13 @@ def inline_shapes_fixture(self, request, InlineShapes_):
 
     @pytest.fixture
     def oxml_fromstring_(self, request):
-        return function_mock(request, 'docx.parts.oxml_fromstring')
+        return function_mock(request, 'docx.parts.document.oxml_fromstring')
 
     @pytest.fixture
     def serialize_part_xml_(self, request):
-        return function_mock(request, 'docx.parts.serialize_part_xml')
+        return function_mock(
+            request, 'docx.parts.document.serialize_part_xml'
+        )
 
 
 class Describe_Body(object):
@@ -408,7 +411,7 @@ def image_descriptor_(self, request):
 
     @pytest.fixture
     def InlineShape_(self, request, new_picture_shape_):
-        InlineShape_ = class_mock(request, 'docx.parts.InlineShape')
+        InlineShape_ = class_mock(request, 'docx.parts.document.InlineShape')
         InlineShape_.new_picture.return_value = new_picture_shape_
         return InlineShape_
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -6,11 +6,10 @@
 
 import pytest
 
-from docx import parts
 from docx.api import Document, _Document
 from docx.opc.constants import CONTENT_TYPE as CT
 from docx.opc.package import OpcPackage
-from docx.parts import InlineShapes
+from docx.parts.document import _Document as parts_Document, InlineShapes
 
 from .unitutil import class_mock, instance_mock, var_mock
 
@@ -47,7 +46,7 @@ def default_docx_(self, request):
     @pytest.fixture
     def document_part_(self, request):
         return instance_mock(
-            request, parts._Document, content_type=CT.WML_DOCUMENT_MAIN
+            request, parts_Document, content_type=CT.WML_DOCUMENT_MAIN
         )
 
     @pytest.fixture
@@ -115,7 +114,7 @@ def document(self, request, package_, document_part_):
 
     @pytest.fixture
     def document_part_(self, request):
-        return instance_mock(request, parts._Document)
+        return instance_mock(request, parts_Document)
 
     @pytest.fixture
     def package_(self, request):
