rfctr: rename private classes now used for typing

Also for example `BaseStoryPart` -> `StoryPart` for the same reason.

Author: scanny

src/docx/parts/document.py

@@ -5,13 +5,13 @@
 from docx.parts.hdrftr import FooterPart, HeaderPart
 from docx.parts.numbering import NumberingPart
 from docx.parts.settings import SettingsPart
-from docx.parts.story import BaseStoryPart
+from docx.parts.story import StoryPart
 from docx.parts.styles import StylesPart
 from docx.shape import InlineShapes
 from docx.shared import lazyproperty
 
 
-class DocumentPart(BaseStoryPart):
+class DocumentPart(StoryPart):
     """Main document part of a WordprocessingML (WML) package, aka a .docx file.
 
     Acts as broker to other parts such as image, core properties, and style parts. It

src/docx/parts/hdrftr.py

@@ -4,10 +4,10 @@
 
 from docx.opc.constants import CONTENT_TYPE as CT
 from docx.oxml import parse_xml
-from docx.parts.story import BaseStoryPart
+from docx.parts.story import StoryPart
 
 
-class FooterPart(BaseStoryPart):
+class FooterPart(StoryPart):
     """Definition of a section footer."""
 
     @classmethod
@@ -29,7 +29,7 @@ def _default_footer_xml(cls):
         return xml_bytes
 
 
-class HeaderPart(BaseStoryPart):
+class HeaderPart(StoryPart):
     """Definition of a section header."""
 
     @classmethod

src/docx/parts/story.py

@@ -1,12 +1,12 @@
-"""|BaseStoryPart| and related objects."""
+"""|StoryPart| and related objects."""
 
 from docx.opc.constants import RELATIONSHIP_TYPE as RT
 from docx.opc.part import XmlPart
 from docx.oxml.shape import CT_Inline
 from docx.shared import lazyproperty
 
 
-class BaseStoryPart(XmlPart):
+class StoryPart(XmlPart):
     """Base class for story parts.
 
     A story part is one that can contain textual content, such as the document-part and

src/docx/styles/style.py

@@ -11,8 +11,8 @@ def StyleFactory(style_elm):
     """Return a style object of the appropriate |BaseStyle| subclass, according to the
     type of `style_elm`."""
     style_cls = {
-        WD_STYLE_TYPE.PARAGRAPH: _ParagraphStyle,
-        WD_STYLE_TYPE.CHARACTER: _CharacterStyle,
+        WD_STYLE_TYPE.PARAGRAPH: ParagraphStyle,
+        WD_STYLE_TYPE.CHARACTER: CharacterStyle,
         WD_STYLE_TYPE.TABLE: _TableStyle,
         WD_STYLE_TYPE.LIST: _NumberingStyle,
     }[style_elm.type]
@@ -153,7 +153,7 @@ def unhide_when_used(self, value):
         self._element.unhideWhenUsed_val = value
 
 
-class _CharacterStyle(BaseStyle):
+class CharacterStyle(BaseStyle):
     """A character style.
 
     A character style is applied to a |Run| object and primarily provides character-
@@ -181,7 +181,11 @@ def font(self):
         return Font(self._element)
 
 
-class _ParagraphStyle(_CharacterStyle):
+# -- just in case someone uses the old name in an extension function --
+_CharacterStyle = CharacterStyle
+
+
+class ParagraphStyle(CharacterStyle):
     """A paragraph style.
 
     A paragraph style provides both character formatting and paragraph formatting such
@@ -220,7 +224,11 @@ def paragraph_format(self):
         return ParagraphFormat(self._element)
 
 
-class _TableStyle(_ParagraphStyle):
+# -- just in case someone uses the old name in an extension function --
+_ParagraphStyle = ParagraphStyle
+
+
+class _TableStyle(ParagraphStyle):
     """A table style.
 
     A table style provides character and paragraph formatting for its contents as well

tests/parts/test_story.py

@@ -8,20 +8,20 @@
 from docx.package import Package
 from docx.parts.document import DocumentPart
 from docx.parts.image import ImagePart
-from docx.parts.story import BaseStoryPart
+from docx.parts.story import StoryPart
 from docx.styles.style import BaseStyle
 
 from ..unitutil.cxml import element
 from ..unitutil.file import snippet_text
 from ..unitutil.mock import instance_mock, method_mock, property_mock
 
 
-class DescribeBaseStoryPart(object):
+class DescribeStoryPart(object):
     def it_can_get_or_add_an_image(self, package_, image_part_, image_, relate_to_):
         package_.get_or_add_image_part.return_value = image_part_
         relate_to_.return_value = "rId42"
         image_part_.image = image_
-        story_part = BaseStoryPart(None, None, None, package_)
+        story_part = StoryPart(None, None, None, package_)
 
         rId, image = story_part.get_or_add_image("image.png")
 
@@ -37,7 +37,7 @@ def it_can_get_a_style_by_id_and_type(
         style_type = WD_STYLE_TYPE.PARAGRAPH
         _document_part_prop_.return_value = document_part_
         document_part_.get_style.return_value = style_
-        story_part = BaseStoryPart(None, None, None, None)
+        story_part = StoryPart(None, None, None, None)
 
         style = story_part.get_style(style_id, style_type)
 
@@ -50,7 +50,7 @@ def it_can_get_a_style_id_by_style_or_name_and_type(
         style_type = WD_STYLE_TYPE.PARAGRAPH
         _document_part_prop_.return_value = document_part_
         document_part_.get_style_id.return_value = "BodyText"
-        story_part = BaseStoryPart(None, None, None, None)
+        story_part = StoryPart(None, None, None, None)
 
         style_id = story_part.get_style_id(style_, style_type)
 
@@ -63,7 +63,7 @@ def it_can_create_a_new_pic_inline(self, get_or_add_image_, image_, next_id_prop
         image_.filename = "bar.png"
         next_id_prop_.return_value = 24
         expected_xml = snippet_text("inline")
-        story_part = BaseStoryPart(None, None, None, None)
+        story_part = StoryPart(None, None, None, None)
 
         inline = story_part.new_pic_inline("foo/bar.png", width=100, height=200)
 
@@ -73,15 +73,15 @@ def it_can_create_a_new_pic_inline(self, get_or_add_image_, image_, next_id_prop
 
     def it_knows_the_next_available_xml_id(self, next_id_fixture):
         story_element, expected_value = next_id_fixture
-        story_part = BaseStoryPart(None, None, story_element, None)
+        story_part = StoryPart(None, None, story_element, None)
 
         next_id = story_part.next_id
 
         assert next_id == expected_value
 
     def it_knows_the_main_document_part_to_help(self, package_, document_part_):
         package_.main_document_part = document_part_
-        story_part = BaseStoryPart(None, None, None, package_)
+        story_part = StoryPart(None, None, None, package_)
 
         document_part = story_part._document_part
 
@@ -115,11 +115,11 @@ def document_part_(self, request):
 
     @pytest.fixture
     def _document_part_prop_(self, request):
-        return property_mock(request, BaseStoryPart, "_document_part")
+        return property_mock(request, StoryPart, "_document_part")
 
     @pytest.fixture
     def get_or_add_image_(self, request):
-        return method_mock(request, BaseStoryPart, "get_or_add_image")
+        return method_mock(request, StoryPart, "get_or_add_image")
 
     @pytest.fixture
     def image_(self, request):
@@ -131,15 +131,15 @@ def image_part_(self, request):
 
     @pytest.fixture
     def next_id_prop_(self, request):
-        return property_mock(request, BaseStoryPart, "next_id")
+        return property_mock(request, StoryPart, "next_id")
 
     @pytest.fixture
     def package_(self, request):
         return instance_mock(request, Package)
 
     @pytest.fixture
     def relate_to_(self, request):
-        return method_mock(request, BaseStoryPart, "relate_to")
+        return method_mock(request, StoryPart, "relate_to")
 
     @pytest.fixture
     def style_(self, request):

tests/styles/test_style.py

@@ -5,10 +5,10 @@
 from docx.enum.style import WD_STYLE_TYPE
 from docx.styles.style import (
     BaseStyle,
+    CharacterStyle,
+    ParagraphStyle,
     StyleFactory,
-    _CharacterStyle,
     _NumberingStyle,
-    _ParagraphStyle,
     _TableStyle,
 )
 from docx.text.font import Font
@@ -32,18 +32,18 @@ def factory_fixture(
         self,
         request,
         paragraph_style_,
-        _ParagraphStyle_,
+        ParagraphStyle_,
         character_style_,
-        _CharacterStyle_,
+        CharacterStyle_,
         table_style_,
         _TableStyle_,
         numbering_style_,
         _NumberingStyle_,
     ):
         type_attr_val = request.param
         StyleCls_, style_mock = {
-            "paragraph": (_ParagraphStyle_, paragraph_style_),
-            "character": (_CharacterStyle_, character_style_),
+            "paragraph": (ParagraphStyle_, paragraph_style_),
+            "character": (CharacterStyle_, character_style_),
             "table": (_TableStyle_, table_style_),
             "numbering": (_NumberingStyle_, numbering_style_),
         }[request.param]
@@ -54,24 +54,24 @@ def factory_fixture(
     # fixture components -----------------------------------
 
     @pytest.fixture
-    def _ParagraphStyle_(self, request, paragraph_style_):
+    def ParagraphStyle_(self, request, paragraph_style_):
         return class_mock(
-            request, "docx.styles.style._ParagraphStyle", return_value=paragraph_style_
+            request, "docx.styles.style.ParagraphStyle", return_value=paragraph_style_
         )
 
     @pytest.fixture
     def paragraph_style_(self, request):
-        return instance_mock(request, _ParagraphStyle)
+        return instance_mock(request, ParagraphStyle)
 
     @pytest.fixture
-    def _CharacterStyle_(self, request, character_style_):
+    def CharacterStyle_(self, request, character_style_):
         return class_mock(
-            request, "docx.styles.style._CharacterStyle", return_value=character_style_
+            request, "docx.styles.style.CharacterStyle", return_value=character_style_
         )
 
     @pytest.fixture
     def character_style_(self, request):
-        return instance_mock(request, _CharacterStyle)
+        return instance_mock(request, CharacterStyle)
 
     @pytest.fixture
     def _TableStyle_(self, request, table_style_):
@@ -396,7 +396,7 @@ def unhide_set_fixture(self, request):
         return style, value, expected_xml
 
 
-class Describe_CharacterStyle(object):
+class DescribeCharacterStyle(object):
     def it_knows_which_style_it_is_based_on(self, base_get_fixture):
         style, StyleFactory_, StyleFactory_calls, base_style_ = base_get_fixture
         base_style = style.base_style
@@ -427,7 +427,7 @@ def it_provides_access_to_its_font(self, font_fixture):
     def base_get_fixture(self, request, StyleFactory_):
         styles_cxml, style_idx, base_style_idx = request.param
         styles = element(styles_cxml)
-        style = _CharacterStyle(styles[style_idx])
+        style = CharacterStyle(styles[style_idx])
         if base_style_idx >= 0:
             base_style = styles[base_style_idx]
             StyleFactory_calls = [call(base_style)]
@@ -446,15 +446,15 @@ def base_get_fixture(self, request, StyleFactory_):
     )
     def base_set_fixture(self, request, style_):
         style_cxml, base_style_id, expected_style_cxml = request.param
-        style = _CharacterStyle(element(style_cxml))
+        style = CharacterStyle(element(style_cxml))
         style_.style_id = base_style_id
         base_style = style_ if base_style_id is not None else None
         expected_xml = xml(expected_style_cxml)
         return style, base_style, expected_xml
 
     @pytest.fixture
     def font_fixture(self, Font_, font_):
-        style = _CharacterStyle(element("w:style"))
+        style = CharacterStyle(element("w:style"))
         return style, Font_, font_
 
     # fixture components ---------------------------------------------
@@ -476,7 +476,7 @@ def StyleFactory_(self, request):
         return function_mock(request, "docx.styles.style.StyleFactory")
 
 
-class Describe_ParagraphStyle(object):
+class DescribeParagraphStyle(object):
     def it_knows_its_next_paragraph_style(self, next_get_fixture):
         style, expected_value = next_get_fixture
         assert style.next_paragraph_style == expected_value
@@ -515,8 +515,8 @@ def next_get_fixture(self, request):
         style_names = ["H1", "H2", "Body", "Foo", "Char"]
         style_elm = styles[style_names.index(style_name)]
         next_style_elm = styles[style_names.index(next_style_name)]
-        style = _ParagraphStyle(style_elm)
-        next_style = _ParagraphStyle(next_style_elm) if style_name == "H1" else style
+        style = ParagraphStyle(style_elm)
+        next_style = ParagraphStyle(next_style_elm) if style_name == "H1" else style
         return style, next_style
 
     @pytest.fixture(
@@ -534,18 +534,18 @@ def next_set_fixture(self, request):
             "w:style{w:type=paragraph,w:styleId=B})"
         )
         style_elms = {"H": styles[0], "B": styles[1]}
-        style = _ParagraphStyle(style_elms[style_name])
+        style = ParagraphStyle(style_elms[style_name])
         next_style = (
             None
             if next_style_name is None
-            else _ParagraphStyle(style_elms[next_style_name])
+            else ParagraphStyle(style_elms[next_style_name])
         )
         expected_xml = xml(style_cxml)
         return style, next_style, expected_xml
 
     @pytest.fixture
     def parfmt_fixture(self, ParagraphFormat_, paragraph_format_):
-        style = _ParagraphStyle(element("w:style"))
+        style = ParagraphStyle(element("w:style"))
         return style, ParagraphFormat_, paragraph_format_
 
     # fixture components ---------------------------------------------