rfctr: modernize formatting

Author: scanny

docs/conf.py

@@ -109,6 +109,8 @@
 
 .. |_Header| replace:: :class:`._Header`
 
+.. |ImageParts| replace:: :class:`.ImageParts`
+
 .. |Inches| replace:: :class:`.Inches`
 
 .. |InlineShape| replace:: :class:`.InlineShape`

docx/document.py

@@ -136,10 +136,7 @@ def save(self, path_or_stream):
 
     @property
     def sections(self):
-        """
-        A |Sections| object providing access to each section in this
-        document.
-        """
+        """|Sections| object providing access to each section in this document."""
         return Sections(self._element)
 
     @property

docx/oxml/section.py

@@ -1,16 +1,14 @@
 # encoding: utf-8
 
-"""
-Section-related custom element classes.
-"""
+"""Section-related custom element classes"""
 
-from __future__ import absolute_import, print_function
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from copy import deepcopy
 
-from ..enum.section import WD_ORIENTATION, WD_SECTION_START
-from .simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure
-from .xmlchemy import BaseOxmlElement, OptionalAttribute, ZeroOrOne
+from docx.enum.section import WD_ORIENTATION, WD_SECTION_START
+from docx.oxml.simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure
+from docx.oxml.xmlchemy import BaseOxmlElement, OptionalAttribute, ZeroOrOne
 
 
 class CT_PageMar(BaseOxmlElement):
@@ -38,25 +36,18 @@ class CT_PageSz(BaseOxmlElement):
 
 
 class CT_SectPr(BaseOxmlElement):
-    """
-    ``<w:sectPr>`` element, the container element for section properties.
-    """
-    __child_sequence__ = (
-        'w:footnotePr', 'w:endnotePr', 'w:type', 'w:pgSz', 'w:pgMar',
-        'w:paperSrc', 'w:pgBorders', 'w:lnNumType', 'w:pgNumType', 'w:cols',
-        'w:formProt', 'w:vAlign', 'w:noEndnote', 'w:titlePg',
-        'w:textDirection', 'w:bidi', 'w:rtlGutter', 'w:docGrid',
-        'w:printerSettings', 'w:sectPrChange',
+    """`w:sectPr` element, the container element for section properties"""
+
+    _tag_seq = (
+        'w:footnotePr', 'w:endnotePr', 'w:type', 'w:pgSz', 'w:pgMar', 'w:paperSrc',
+        'w:pgBorders', 'w:lnNumType', 'w:pgNumType', 'w:cols', 'w:formProt', 'w:vAlign',
+        'w:noEndnote', 'w:titlePg', 'w:textDirection', 'w:bidi', 'w:rtlGutter',
+        'w:docGrid', 'w:printerSettings', 'w:sectPrChange',
     )
-    type = ZeroOrOne('w:type', successors=(
-        __child_sequence__[__child_sequence__.index('w:type')+1:]
-    ))
-    pgSz = ZeroOrOne('w:pgSz', successors=(
-        __child_sequence__[__child_sequence__.index('w:pgSz')+1:]
-    ))
-    pgMar = ZeroOrOne('w:pgMar', successors=(
-        __child_sequence__[__child_sequence__.index('w:pgMar')+1:]
-    ))
+    type = ZeroOrOne("w:type", successors=_tag_seq[3:])
+    pgSz = ZeroOrOne("w:pgSz", successors=_tag_seq[4:])
+    pgMar = ZeroOrOne("w:pgMar", successors=_tag_seq[5:])
+    del _tag_seq
 
     @property
     def bottom_margin(self):

docx/package.py

@@ -13,27 +13,22 @@
 
 
 class Package(OpcPackage):
-    """
-    Customizations specific to a WordprocessingML package.
-    """
+    """Customizations specific to a WordprocessingML package"""
+
     def after_unmarshal(self):
-        """
-        Called by loading code after all parts and relationships have been
-        loaded, to afford the opportunity for any required post-processing.
+        """Called by loading code after all parts and relationships have been loaded.
+
+        This method affords the opportunity for any required post-processing.
         """
         self._gather_image_parts()
 
     @lazyproperty
     def image_parts(self):
-        """
-        Collection of all image parts in this package.
-        """
+        """|ImageParts| collection object for this package."""
         return ImageParts()
 
     def _gather_image_parts(self):
-        """
-        Load the image part collection with all the image parts in package.
-        """
+        """Load the image part collection with all the image parts in package."""
         for rel in self.iter_rels():
             if rel.is_external:
                 continue

docx/section.py

@@ -1,19 +1,18 @@
 # encoding: utf-8
 
-"""
-The |Section| object and related proxy classes.
-"""
+"""The |Section| object and related proxy classes"""
 
-from __future__ import absolute_import, print_function, unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from collections import Sequence
 
 
 class Sections(Sequence):
+    """Sequence of |Section| objects corresponding to the sections in the document.
+
+    Supports ``len()``, iteration, and indexed access.
     """
-    Sequence of |Section| objects corresponding to the sections in the
-    document. Supports ``len()``, iteration, and indexed access.
-    """
+
     def __init__(self, document_elm):
         super(Sections, self).__init__()
         self._document_elm = document_elm
@@ -34,9 +33,8 @@ def __len__(self):
 
 
 class Section(object):
-    """
-    Document section, providing access to section and page setup settings.
-    """
+    """Document section, providing access to section and page-setup settings."""
+
     def __init__(self, sectPr):
         super(Section, self).__init__()
         self._sectPr = sectPr

docx/settings.py

@@ -1,20 +1,16 @@
 # encoding: utf-8
 
-"""
-Settings object, providing access to document-level settings.
-"""
+"""Settings object, providing access to document-level settings"""
 
-from __future__ import (
-    absolute_import, division, print_function, unicode_literals
-)
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from .shared import ElementProxy
+from docx.shared import ElementProxy
 
 
 class Settings(ElementProxy):
-    """
-    Provides access to document-level settings for a document. Accessed using
-    the :attr:`.Document.settings` property.
+    """Provides access to document-level settings for a document.
+
+    Accessed using the :attr:`.Document.settings` property.
     """
 
     __slots__ = ()

tests/test_section.py

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
-"""
-Test suite for the docx.section module
-"""
+"""Unit test suite for the docx.section module"""
 
-from __future__ import absolute_import, print_function, unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 import pytest