reorg: mv BaseLength Length

Author: Steve Canny

docs/conf.py

@@ -82,8 +82,6 @@
 
 .. |BaseFileSystem| replace:: :class:`BaseFileSystem`
 
-.. |BaseLength| replace:: :class:`.BaseLength`
-
 .. |BaseShape| replace:: :class:`BaseShape`
 
 .. |_Cell| replace:: :class:`_Cell`
@@ -134,18 +132,20 @@
 
 .. |KeyError| replace:: :exc:`KeyError`
 
-.. |list| replace:: :class:`list`
-
 .. |_LayoutPlaceholders| replace:: :class:`_LayoutPlaceholders`
 
 .. |_LayoutShapeTree| replace:: :class:`_LayoutShapeTree`
 
 .. |Legend| replace:: :class:`.Legend`
 
+.. |Length| replace:: :class:`.Length`
+
 .. |LineFormat| replace:: :class:`.LineFormat`
 
 .. |LineSeries| replace:: :class:`.LineSeries`
 
+.. |list| replace:: :class:`list`
+
 .. |_MasterPlaceholders| replace:: :class:`_MasterPlaceholders`
 
 .. |_MasterShapeTree| replace:: :class:`_MasterShapeTree`

features/steps/line.py

@@ -11,7 +11,7 @@
 from pptx import Presentation
 from pptx.dml.color import RGBColor
 from pptx.enum.dml import MSO_COLOR_TYPE, MSO_FILL_TYPE, MSO_THEME_COLOR
-from pptx.util import BaseLength, Pt
+from pptx.util import Length, Pt
 
 from .helpers import test_pptx
 
@@ -127,4 +127,4 @@ def then_the_reported_line_width_is_value(context, line_width):
     }[line_width]
     line_width = context.line.width
     assert line_width == expected_value
-    assert isinstance(line_width, BaseLength)
+    assert isinstance(line_width, Length)

pptx/dml/line.py

@@ -48,9 +48,9 @@ def fill(self):
     def width(self):
         """
         The width of the line expressed as an integer number of :ref:`English
-        Metric Units <EMU>`. The returned value is an instance of
-        |BaseLength|, a value class having properties such as `.inches`,
-        `.cm`, and `.pt` for converting the value into convenient units.
+        Metric Units <EMU>`. The returned value is an instance of |Length|,
+        a value class having properties such as `.inches`, `.cm`, and `.pt`
+        for converting the value into convenient units.
         """
         ln = self._ln
         if ln is None:

pptx/shapes/table.py

@@ -170,9 +170,9 @@ def fill(self):
     @property
     def margin_left(self):
         """
-        Read/write integer value of left margin of cell as a |BaseLength|
-        value object. If assigned |None|, the default value is used, 0.1
-        inches for left and right margins and 0.05 inches for top and bottom.
+        Read/write integer value of left margin of cell as a |Length| value
+        object. If assigned |None|, the default value is used, 0.1 inches for
+        left and right margins and 0.05 inches for top and bottom.
         """
         return self._tc.marL
 

pptx/text/text.py

@@ -81,10 +81,9 @@ def fit_text(self, font_family='Calibri', max_size=18, bold=False,
     @property
     def margin_bottom(self):
         """
-        |BaseLength| value representing the inset of text from the bottom
-        text frame border. :meth:`pptx.util.Inches` provides a convenient way
-        of setting the value, e.g. ``text_frame.margin_bottom
-        = Inches(0.05)``.
+        |Length| value representing the inset of text from the bottom text
+        frame border. :meth:`pptx.util.Inches` provides a convenient way of
+        setting the value, e.g. ``text_frame.margin_bottom = Inches(0.05)``.
         """
         return self._bodyPr.bIns
 
@@ -95,7 +94,7 @@ def margin_bottom(self, emu):
     @property
     def margin_left(self):
         """
-        Inset of text from left text frame border as |BaseLength| value.
+        Inset of text from left text frame border as |Length| value.
         """
         return self._bodyPr.lIns
 
@@ -106,7 +105,7 @@ def margin_left(self, emu):
     @property
     def margin_right(self):
         """
-        Inset of text from right text frame border as |BaseLength| value.
+        Inset of text from right text frame border as |Length| value.
         """
         return self._bodyPr.rIns
 
@@ -117,7 +116,7 @@ def margin_right(self, emu):
     @property
     def margin_top(self):
         """
-        Inset of text from top text frame border as |BaseLength| value.
+        Inset of text from top text frame border as |Length| value.
         """
         return self._bodyPr.tIns
 
@@ -340,13 +339,13 @@ def name(self, value):
     @property
     def size(self):
         """
-        Read/write |BaseLength| value or |None|, indicating the font height
-        in English Metric Units (EMU). |None| indicates the font size should
-        be inherited from its style hierarchy, such as a placeholder or
-        document defaults (usually 18pt). |BaseLength| is a subclass of |int|
-        having properties for convenient conversion into points or other
-        length units. Likewise, the :class:`pptx.util.Pt` class allows
-        convenient specification of point values::
+        Read/write |Length| value or |None|, indicating the font height in
+        English Metric Units (EMU). |None| indicates the font size should be
+        inherited from its style hierarchy, such as a placeholder or document
+        defaults (usually 18pt). |Length| is a subclass of |int| having
+        properties for convenient conversion into points or other length
+        units. Likewise, the :class:`pptx.util.Pt` class allows convenient
+        specification of point values::
 
             >> font.size = Pt(24)
             >> font.size

pptx/util.py

@@ -8,7 +8,7 @@
 import platform
 
 
-class BaseLength(int):
+class Length(int):
     """
     Base class for length classes Inches, Emu, Cm, Mm, Pt, and Px. Provides
     properties for converting length values to convenient units.
@@ -79,66 +79,66 @@ def px(self):
         return int(round(self / float(self._EMUS_PER_PX)) + 0.1)
 
 
-class Inches(BaseLength):
+class Inches(Length):
     """
     Convenience constructor for length in inches
     """
     def __new__(cls, inches):
-        emu = int(inches * BaseLength._EMUS_PER_INCH)
-        return BaseLength.__new__(cls, emu)
+        emu = int(inches * Length._EMUS_PER_INCH)
+        return Length.__new__(cls, emu)
 
 
-class Centipoints(BaseLength):
+class Centipoints(Length):
     """
     Convenience constructor for length in hundredths of a point
     """
     def __new__(cls, centipoints):
-        emu = int(centipoints * BaseLength._EMUS_PER_CENTIPOINT)
-        return BaseLength.__new__(cls, emu)
+        emu = int(centipoints * Length._EMUS_PER_CENTIPOINT)
+        return Length.__new__(cls, emu)
 
 
-class Cm(BaseLength):
+class Cm(Length):
     """
     Convenience constructor for length in centimeters
     """
     def __new__(cls, cm):
-        emu = int(cm * BaseLength._EMUS_PER_CM)
-        return BaseLength.__new__(cls, emu)
+        emu = int(cm * Length._EMUS_PER_CM)
+        return Length.__new__(cls, emu)
 
 
-class Emu(BaseLength):
+class Emu(Length):
     """
     Convenience constructor for length in english metric units
     """
     def __new__(cls, emu):
-        return BaseLength.__new__(cls, int(emu))
+        return Length.__new__(cls, int(emu))
 
 
-class Mm(BaseLength):
+class Mm(Length):
     """
     Convenience constructor for length in millimeters
     """
     def __new__(cls, mm):
-        emu = int(mm * BaseLength._EMUS_PER_MM)
-        return BaseLength.__new__(cls, emu)
+        emu = int(mm * Length._EMUS_PER_MM)
+        return Length.__new__(cls, emu)
 
 
-class Pt(BaseLength):
+class Pt(Length):
     """
     Convenience value class for specifying a length in points
     """
     def __new__(cls, points):
-        emu = int(points * BaseLength._EMUS_PER_PT)
-        return BaseLength.__new__(cls, emu)
+        emu = int(points * Length._EMUS_PER_PT)
+        return Length.__new__(cls, emu)
 
 
-class Px(BaseLength):
+class Px(Length):
     """
     Convenience constructor for length in pixels
     """
     def __new__(cls, px):
-        emu = int(px * BaseLength._EMUS_PER_PX)
-        return BaseLength.__new__(cls, emu)
+        emu = int(px * Length._EMUS_PER_PX)
+        return Length.__new__(cls, emu)
 
 
 def lazyproperty(f):

tests/shapes/test_table.py

@@ -16,7 +16,7 @@
     _Cell, _CellCollection, _Column, _ColumnCollection, _Row, _RowCollection,
     Table
 )
-from pptx.util import Inches, BaseLength, Pt
+from pptx.util import Inches, Length, Pt
 
 from ..unitutil.cxml import element, xml
 from ..unitutil.mock import class_mock, instance_mock
@@ -358,7 +358,7 @@ def it_knows_its_width(self, width_get_fixture):
         column, expected_value = width_get_fixture
         width = column.width
         assert width == expected_value
-        assert isinstance(width, BaseLength)
+        assert isinstance(width, Length)
 
     def it_can_change_its_width(self, width_set_fixture):
         column, new_width, expected_xml, parent_ = width_set_fixture
@@ -469,7 +469,7 @@ def it_knows_its_height(self, height_get_fixture):
         row, expected_value = height_get_fixture
         height = row.height
         assert height == expected_value
-        assert isinstance(height, BaseLength)
+        assert isinstance(height, Length)
 
     def it_can_change_its_height(self, height_set_fixture):
         row, new_height, expected_xml, parent_ = height_set_fixture

tests/test_util.py

@@ -10,7 +10,7 @@
 import pytest
 
 from pptx.util import (
-    BaseLength, Centipoints, Cm, Emu, Inches, Mm, Pt, Px, to_unicode
+    Length, Centipoints, Cm, Emu, Inches, Mm, Pt, Px, to_unicode
 )
 
 
@@ -25,19 +25,19 @@ class DescribeLength(object):
     def it_can_construct_from_convenient_units(self, construct_fixture):
         UnitCls, units_val, emu = construct_fixture
         length = UnitCls(units_val)
-        assert isinstance(length, BaseLength)
+        assert isinstance(length, Length)
         assert length == emu
 
     def it_can_self_convert_to_convenient_units(self, units_fixture):
         emu, units_prop_name, expected_length_in_units = units_fixture
-        length = BaseLength(emu)
+        length = Length(emu)
         length_in_units = getattr(length, units_prop_name)
         assert length_in_units == expected_length_in_units
 
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
-        (BaseLength,  914400,  914400),
+        (Length,      914400,  914400),
         (Inches,      1.1,    1005840),
         (Centipoints, 12.5,      1587),
         (Cm,          2.53,    910799),