acpt: add doc-access-sections.feature

Steve Canny · Steve Canny · commit 6b0014a7a098 · 2014-06-18T22:51:42.000-07:00
New version of flake8 caught some new PEP8 bits in conf.py
diff --git a/docs/conf.py b/docs/conf.py
@@ -26,7 +26,7 @@
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -45,7 +45,7 @@
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -113,6 +113,10 @@
 
 .. |Run| replace:: :class:`Run`
 
+.. |Section| replace:: :class:`.Section`
+
+.. |Sections| replace:: :class:`.Sections`
+
 .. |StylesPart| replace:: :class:`StylesPart`
 
 .. |Table| replace:: :class:`.Table`
@@ -131,24 +135,24 @@
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ------------------------------------------------
@@ -160,26 +164,26 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ['_themes']
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -188,48 +192,48 @@
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 html_sidebars = {
     '**': ['localtoc.html', 'relations.html', 'sidebarlinks.html',
            'searchbox.html']
 }
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'python-docxdoc'
@@ -239,13 +243,13 @@
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
+    # 'papersize': 'letterpaper',
 
     # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
+    # 'pointsize': '10pt',
 
     # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -261,23 +265,23 @@
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output -----------------------------------------
@@ -290,7 +294,7 @@
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ---------------------------------------------
@@ -305,13 +309,13 @@
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -214,3 +214,10 @@ def _inline_lst(self):
         body = self._body
         xpath = './w:p/w:r/w:drawing/wp:inline'
         return body.xpath(xpath)
+
+
+class Sections(object):
+    """
+    Sequence of |Section| objects corresponding to the sections in the
+    document.
+    """
diff --git a/docx/section.py b/docx/section.py
@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+"""
+The |Section| object and related proxy classes.
+"""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+
+class Section(object):
+    """
+    Document section, providing access to section and page setup settings.
+    """
diff --git a/features/doc-access-sections.feature b/features/doc-access-sections.feature
@@ -0,0 +1,18 @@
+Feature: Access document sections
+  In order to discover and apply section-level settings
+  As a developer using python-docx
+  I need a way to access document sections
+
+
+  @wip
+  Scenario: Access section collection of a document
+     Given a document having three sections
+      Then I can access the section collection of the document
+       And the length of the section collection is 3
+
+
+  @wip
+  Scenario: Access section in section collection
+     Given a section collection
+      Then I can iterate over the sections
+       And I can access a section by index
diff --git a/features/steps/document.py b/features/steps/document.py
@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+"""
+Step implementations for document-related features
+"""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+from behave import given, then
+
+from docx import Document
+from docx.parts.document import Sections
+from docx.section import Section
+
+from helpers import test_docx
+
+
+# given ===================================================
+
+@given('a document having three sections')
+def given_a_document_having_three_sections(context):
+    context.document = Document(test_docx('doc-access-sections'))
+
+
+@given('a section collection')
+def given_a_section_collection(context):
+    document = Document(test_docx('doc-access-sections'))
+    context.sections = document.sections
+
+
+# then ====================================================
+
+@then('I can access a section by index')
+def then_I_can_access_a_section_by_index(context):
+    sections = context.sections
+    for idx in range(3):
+        section = sections[idx]
+        assert isinstance(section, Section)
+
+
+@then('I can access the section collection of the document')
+def then_I_can_access_the_section_collection_of_the_document(context):
+    sections = context.document.sections
+    msg = 'document.sections not instance of Sections'
+    assert isinstance(sections, Sections), msg
+
+
+@then('I can iterate over the sections')
+def then_I_can_iterate_over_the_sections(context):
+    sections = context.sections
+    actual_count = 0
+    for section in sections:
+        actual_count += 1
+        assert isinstance(section, Section)
+    assert actual_count == 3
+
+
+@then('the length of the section collection is 3')
+def then_the_length_of_the_section_collection_is_3(context):
+    sections = context.sections
+    assert len(sections) == 3, (
+        'expected len(sections) of 2, got %s' % len(sections)
+    )
diff --git a/features/steps/test_files/doc-access-sections.docx b/features/steps/test_files/doc-access-sections.docx
