style: add BaseStyle.delete()

Steve Canny · Steve Canny · commit ec9e863aee06 · 2015-02-08T00:01:39.000-08:00
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -49,6 +49,12 @@ class CT_Style(BaseOxmlElement):
     customStyle = OptionalAttribute('w:customStyle', ST_OnOff)
     del _tag_seq
 
+    def delete(self):
+        """
+        Remove this `w:style` element from its parent `w:styles` element.
+        """
+        self.getparent().remove(self)
+
     @property
     def name_val(self):
         """
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -43,6 +43,17 @@ def builtin(self):
         """
         return not self._element.customStyle
 
+    def delete(self):
+        """
+        Remove this style definition from the document. Note that calling
+        this method does not remove or change the style applied to any
+        document content. Content items having the deleted style will be
+        rendered using the default style, as is any content with a style not
+        defined in the document.
+        """
+        self._element.delete()
+        self._element = None
+
     @property
     def name(self):
         """
diff --git a/features/sty-delete-style.feature b/features/sty-delete-style.feature
@@ -4,7 +4,6 @@ Feature: Delete a style
   I need a way to delete a style
 
 
-  @wip
   Scenario: Delete a style
     Given a document having known styles
      When I delete a style
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -121,6 +121,12 @@ def it_knows_whether_its_a_builtin_style(self, builtin_get_fixture):
         style, expected_value = builtin_get_fixture
         assert style.builtin is expected_value
 
+    def it_can_delete_itself_from_the_document(self, delete_fixture):
+        style, styles, expected_xml = delete_fixture
+        style.delete()
+        assert styles.xml == expected_xml
+        assert style._element is None
+
     # fixture --------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -133,6 +139,13 @@ def builtin_get_fixture(self, request):
         style = BaseStyle(element(style_cxml))
         return style, expected_value
 
+    @pytest.fixture
+    def delete_fixture(self):
+        styles = element('w:styles/w:style')
+        style = BaseStyle(styles[0])
+        expected_xml = xml('w:styles')
+        return style, styles, expected_xml
+
     @pytest.fixture(params=[
         ('w:style',                   None),
         ('w:style{w:styleId=Foobar}', 'Foobar'),
