tabs: add TabStop.position

Author: DKWoods

docx/oxml/__init__.py

@@ -181,7 +181,9 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 from .text.paragraph import CT_P
 register_element_cls('w:p', CT_P)
 
-from .text.parfmt import CT_Ind, CT_Jc, CT_PPr, CT_Spacing, CT_TabStops
+from .text.parfmt import (
+    CT_Ind, CT_Jc, CT_PPr, CT_Spacing, CT_TabStop, CT_TabStops
+)
 register_element_cls('w:ind',             CT_Ind)
 register_element_cls('w:jc',              CT_Jc)
 register_element_cls('w:keepLines',       CT_OnOff)
@@ -190,6 +192,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:pPr',             CT_PPr)
 register_element_cls('w:pStyle',          CT_String)
 register_element_cls('w:spacing',         CT_Spacing)
+register_element_cls('w:tab',             CT_TabStop)
 register_element_cls('w:tabs',            CT_TabStops)
 register_element_cls('w:widowControl',    CT_OnOff)
 

docx/oxml/text/parfmt.py

@@ -315,6 +315,13 @@ class CT_Spacing(BaseOxmlElement):
     lineRule = OptionalAttribute('w:lineRule', WD_LINE_SPACING)
 
 
+class CT_TabStop(BaseOxmlElement):
+    """
+    ``<w:tab>`` element, representing an individual tab stop.
+    """
+    pos = RequiredAttribute('w:pos', ST_SignedTwipsMeasure)
+
+
 class CT_TabStops(BaseOxmlElement):
     """
     ``<w:tabs>`` element, container for a sorted sequence of tab stops.

docx/text/tabstops.py

@@ -63,3 +63,11 @@ class TabStop(ElementProxy):
     def __init__(self, element):
         super(TabStop, self).__init__(element, None)
         self._tab = element
+
+    @property
+    def position(self):
+        """
+        The distance (in EMU) of this tab stop from the inside edge of the
+        paragraph. May be positive or negative.
+        """
+        return self._tab.pos

features/tab-tabstop-props.feature

@@ -4,7 +4,6 @@ Feature: Tab stop properties
   I need a set of read/write properties on TabStop
 
 
-  @wip
   Scenario Outline: Get TabStop.position
     Given a tab stop 0.5 inches <in-or-out> from the paragraph left edge
      Then tab_stop.position is <position>

tests/text/test_tabstops.py

@@ -9,6 +9,7 @@
     absolute_import, division, print_function, unicode_literals
 )
 
+from docx.shared import Twips
 from docx.text.tabstops import TabStop, TabStops
 
 import pytest
@@ -17,6 +18,20 @@
 from ..unitutil.mock import call, class_mock, instance_mock
 
 
+class DescribeTabStop(object):
+
+    def it_knows_its_position(self, position_get_fixture):
+        tab_stop, expected_value = position_get_fixture
+        assert tab_stop.position == expected_value
+
+    # fixture --------------------------------------------------------
+
+    @pytest.fixture
+    def position_get_fixture(self, request):
+        tab_stop = TabStop(element('w:tab{w:pos=720}'))
+        return tab_stop, Twips(720)
+
+
 class DescribeTabStops(object):
 
     def it_knows_its_length(self, len_fixture):