test: upgrade mock helpers to autospec by default

Author: scanny

.gitignore

@@ -3,6 +3,7 @@
 /docs/.build/
 /*.egg-info
 *.pyc
+.pytest_cache/
 _scratch/
 Session.vim
 /.tox/

docx/blkcntnr.py

@@ -1,25 +1,26 @@
 # encoding: utf-8
 
-"""
-Block item container, used by body, cell, header, etc. Block level items are
-things like paragraph and table, although there are a few other specialized
-ones like structured document tags.
+"""Block item container, used by body, cell, header, etc.
+
+Block level items are things like paragraph and table, although there are a few other
+specialized ones like structured document tags.
 """
 
-from __future__ import absolute_import, print_function
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from .oxml.table import CT_Tbl
-from .shared import Parented
-from .text.paragraph import Paragraph
+from docx.oxml.table import CT_Tbl
+from docx.shared import Parented
+from docx.text.paragraph import Paragraph
 
 
 class BlockItemContainer(Parented):
+    """Base class for proxy objects that can contain block items.
+
+    These containers include _Body, _Cell, header, footer, footnote, endnote, comment,
+    and text box objects. Provides the shared functionality to add a block item like
+    a paragraph or table.
     """
-    Base class for proxy objects that can contain block items, such as _Body,
-    _Cell, header, footer, footnote, endnote, comment, and text box objects.
-    Provides the shared functionality to add a block item like a paragraph or
-    table.
-    """
+
     def __init__(self, element, parent):
         super(BlockItemContainer, self).__init__(parent)
         self._element = element

docx/document.py

@@ -1,24 +1,21 @@
 # encoding: utf-8
 
-"""
-|Document| and closely related objects
-"""
+"""|Document| and closely related objects"""
 
-from __future__ import (
-    absolute_import, division, print_function, unicode_literals
-)
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from .blkcntnr import BlockItemContainer
-from .enum.section import WD_SECTION
-from .enum.text import WD_BREAK
-from .section import Section, Sections
-from .shared import ElementProxy, Emu
+from docx.blkcntnr import BlockItemContainer
+from docx.enum.section import WD_SECTION
+from docx.enum.text import WD_BREAK
+from docx.section import Section, Sections
+from docx.shared import ElementProxy, Emu
 
 
 class Document(ElementProxy):
-    """
-    WordprocessingML (WML) document. Not intended to be constructed directly.
-    Use :func:`docx.Document` to open or create a document.
+    """WordprocessingML (WML) document.
+
+    Not intended to be constructed directly. Use :func:`docx.Document` to open or create
+    a document.
     """
 
     __slots__ = ('_part', '__body')
@@ -28,25 +25,21 @@ def __init__(self, element, part):
         self._part = part
         self.__body = None
 
-    def add_heading(self, text='', level=1):
-        """
-        Return a heading paragraph newly added to the end of the document,
-        containing *text* and having its paragraph style determined by
-        *level*. If *level* is 0, the style is set to `Title`. If *level* is
-        1 (or omitted), `Heading 1` is used. Otherwise the style is set to
-        `Heading {level}`. Raises |ValueError| if *level* is outside the
-        range 0-9.
+    def add_heading(self, text="", level=1):
+        """Return a heading paragraph newly added to the end of the document.
+
+        The heading paragraph will contain *text* and have its paragraph style
+        determined by *level*. If *level* is 0, the style is set to `Title`. If *level*
+        is 1 (or omitted), `Heading 1` is used. Otherwise the style is set to `Heading
+        {level}`. Raises |ValueError| if *level* is outside the range 0-9.
         """
         if not 0 <= level <= 9:
             raise ValueError("level must be in range 0-9, got %d" % level)
-        style = 'Title' if level == 0 else 'Heading %d' % level
+        style = "Title" if level == 0 else "Heading %d" % level
         return self.add_paragraph(text, style)
 
     def add_page_break(self):
-        """
-        Return a paragraph newly added to the end of the document and
-        containing only a page break.
-        """
+        """Return newly |Paragraph| object containing only a page break."""
         paragraph = self.add_paragraph()
         paragraph.add_run().add_break(WD_BREAK.PAGE)
         return paragraph

docx/opc/package.py

@@ -23,6 +23,7 @@ class OpcPackage(object):
     the :meth:`open` class method with a path to a package file or file-like
     object containing one.
     """
+
     def __init__(self):
         super(OpcPackage, self).__init__()
 
@@ -174,10 +175,8 @@ def _core_properties_part(self):
 
 
 class Unmarshaller(object):
-    """
-    Hosts static methods for unmarshalling a package from a |PackageReader|
-    instance.
-    """
+    """Hosts static methods for unmarshalling a package from a |PackageReader|."""
+
     @staticmethod
     def unmarshal(pkg_reader, package, part_factory):
         """

docx/oxml/table.py

@@ -367,9 +367,8 @@ def width(self, value):
 
 
 class CT_Tc(BaseOxmlElement):
-    """
-    ``<w:tc>`` table cell element
-    """
+    """`w:tc` table cell element"""
+
     tcPr = ZeroOrOne('w:tcPr')  # bunches of successors, overriding insert
     p = OneOrMore('w:p')
     tbl = OneOrMore('w:tbl')

docx/package.py

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
-"""
-WordprocessingML Package class and related objects
-"""
+"""WordprocessingML Package class and related objects"""
 
-from __future__ import absolute_import, print_function, unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from docx.image.image import Image
 from docx.opc.constants import RELATIONSHIP_TYPE as RT
@@ -47,12 +45,9 @@ def _gather_image_parts(self):
 
 
 class ImageParts(object):
-    """
-    Collection of |ImagePart| instances corresponding to each image part in
-    the package.
-    """
+    """Collection of |ImagePart| objects corresponding to images in the package"""
+
     def __init__(self):
-        super(ImageParts, self).__init__()
         self._image_parts = []
 
     def __contains__(self, item):
@@ -68,10 +63,10 @@ def append(self, item):
         self._image_parts.append(item)
 
     def get_or_add_image_part(self, image_descriptor):
-        """
-        Return an |ImagePart| instance containing the image identified by
-        *image_descriptor*, newly created if a matching one is not present in
-        the collection.
+        """Return |ImagePart| object containing image identified by *image_descriptor*.
+
+        The image-part is newly created if a matching one is not present in the
+        collection.
         """
         image = Image.from_file(image_descriptor)
         matching_image_part = self._get_by_sha1(image.sha1)

docx/parts/document.py

@@ -1,33 +1,29 @@
 # encoding: utf-8
 
-"""
-|DocumentPart| and closely related objects
-"""
+"""|DocumentPart| and closely related objects"""
 
-from __future__ import (
-    absolute_import, division, print_function, unicode_literals
-)
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-from ..document import Document
-from .numbering import NumberingPart
-from ..opc.constants import RELATIONSHIP_TYPE as RT
-from ..opc.part import XmlPart
-from ..oxml.shape import CT_Inline
-from ..shape import InlineShapes
-from ..shared import lazyproperty
-from .settings import SettingsPart
-from .styles import StylesPart
+from docx.document import Document
+from docx.opc.constants import RELATIONSHIP_TYPE as RT
+from docx.opc.part import XmlPart
+from docx.oxml.shape import CT_Inline
+from docx.parts.numbering import NumberingPart
+from docx.parts.settings import SettingsPart
+from docx.parts.styles import StylesPart
+from docx.shape import InlineShapes
+from docx.shared import lazyproperty
 
 
 class DocumentPart(XmlPart):
+    """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
+    also acts as a convenient delegate when a mid-document object needs a service
+    involving a remote ancestor. The `Parented.part` property inherited by many content
+    objects provides access to this part object for that purpose.
     """
-    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 also acts as a convenient delegate when a mid-document object
-    needs a service involving a remote ancestor. The `Parented.part` property
-    inherited by many content objects provides access to this part object for
-    that purpose.
-    """
+
     @property
     def core_properties(self):
         """
@@ -84,10 +80,10 @@ def inline_shapes(self):
         return InlineShapes(self._element.body, self)
 
     def new_pic_inline(self, image_descriptor, width, height):
-        """
-        Return a newly-created `w:inline` element containing the image
-        specified by *image_descriptor* and scaled based on the values of
-        *width* and *height*.
+        """Return a newly-created `w:inline` element.
+
+        The element contains the image specified by *image_descriptor* and is scaled
+        based on the values of *width* and *height*.
         """
         rId, image = self.get_or_add_image(image_descriptor)
         cx, cy = image.scaled_dimensions(width, height)

docx/styles/styles.py

@@ -1,26 +1,22 @@
 # encoding: utf-8
 
-"""
-Styles object, container for all objects in the styles part.
-"""
+"""Styles object, container for all objects in the styles part"""
 
-from __future__ import (
-    absolute_import, division, print_function, unicode_literals
-)
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from warnings import warn
 
-from . import BabelFish
-from .latent import LatentStyles
-from ..shared import ElementProxy
-from .style import BaseStyle, StyleFactory
+from docx.shared import ElementProxy
+from docx.styles import BabelFish
+from docx.styles.latent import LatentStyles
+from docx.styles.style import BaseStyle, StyleFactory
 
 
 class Styles(ElementProxy):
-    """
-    A collection providing access to the styles defined in a document.
-    Accessed using the :attr:`.Document.styles` property. Supports ``len()``,
-    iteration, and dictionary-style access by style name.
+    """Provides access to the styles defined in a document.
+
+    Accessed using the :attr:`.Document.styles` property. Supports ``len()``, iteration,
+    and dictionary-style access by style name.
     """
 
     __slots__ = ()
@@ -87,9 +83,9 @@ def default(self, style_type):
         return StyleFactory(style)
 
     def get_by_id(self, style_id, style_type):
-        """
-        Return the style of *style_type* matching *style_id*. Returns the
-        default for *style_type* if *style_id* is not found or is |None|, or
+        """Return the style of *style_type* matching *style_id*.
+
+        Returns the default for *style_type* if *style_id* is not found or is |None|, or
         if the style having *style_id* is not of *style_type*.
         """
         if style_id is None:

tests/image/test_bmp.py

@@ -12,15 +12,22 @@
 from docx.image.constants import MIME_TYPE
 from docx.image.bmp import Bmp
 
-from ..unitutil.mock import initializer_mock
+from ..unitutil.mock import ANY, initializer_mock
 
 
 class DescribeBmp(object):
 
-    def it_can_construct_from_a_bmp_stream(self, from_stream_fixture):
-        stream, Bmp__init__, cx, cy, horz_dpi, vert_dpi = from_stream_fixture
+    def it_can_construct_from_a_bmp_stream(self, Bmp__init__):
+        cx, cy, horz_dpi, vert_dpi = 26, 43, 200, 96
+        bytes_ = (
+            b'fillerfillerfiller\x1A\x00\x00\x00\x2B\x00\x00\x00'
+            b'fillerfiller\xB8\x1E\x00\x00\x00\x00\x00\x00'
+        )
+        stream = BytesIO(bytes_)
+
         bmp = Bmp.from_stream(stream)
-        Bmp__init__.assert_called_once_with(cx, cy, horz_dpi, vert_dpi)
+
+        Bmp__init__.assert_called_once_with(ANY, cx, cy, horz_dpi, vert_dpi)
         assert isinstance(bmp, Bmp)
 
     def it_knows_its_content_type(self):
@@ -33,16 +40,6 @@ def it_knows_its_default_ext(self):
 
     # fixtures -------------------------------------------------------
 
-    @pytest.fixture
-    def from_stream_fixture(self, Bmp__init__):
-        cx, cy, horz_dpi, vert_dpi = 26, 43, 200, 96
-        bytes_ = (
-            b'fillerfillerfiller\x1A\x00\x00\x00\x2B\x00\x00\x00'
-            b'fillerfiller\xB8\x1E\x00\x00\x00\x00\x00\x00'
-        )
-        stream = BytesIO(bytes_)
-        return stream, Bmp__init__, cx, cy, horz_dpi, vert_dpi
-
     @pytest.fixture
     def Bmp__init__(self, request):
         return initializer_mock(request, Bmp)