dexy : soups filter

← Back to Filter List

soups

Split a HTML file into nested sections based on header tags.

Aliases for this filter

soups

Converts from file formats:

.*

To file formats:

.*

Available settings:

Setting	Description	Default
add-new-files	Boolean or list of extensions/patterns to match.	False
added-in-version	Dexy version when this filter was first available.
additional-doc-filters	Filters to apply to additional documents created as side effects.	{}
additional-doc-settings	Settings to apply to additional documents created as side effects.	{}
data-type	Alias of custom data class to use to store filter output.	sectioned
examples	Templates which should be used as examples for this filter.	[]
exclude-add-new-files	List of patterns to skip even if they match add-new-files.	[]
exclude-new-files-from-dir	List of directories to skip when adding new files.	[]
ext	File extension to output.	None
extension-map	Dictionary mapping input extensions to default output extensions.	None
help	Helpstring for plugin.	Split a HTML file into nested sections based on header tags.
html-parser	Name of html parser BeautifulSoup should use.	html.parser
initial-section-name	Name to use for the initial section which currently holds all the contents.	Actual Document Contents
input-extensions	List of extensions which this filter can accept as input.	['.*']
keep-originals	Whether, if additional-doc-filters are specified, the original unmodified docs should also be added.	False
mkdir	A directory which should be created in working dir.	None
mkdirs	A list of directories which should be created in working dir.	[]
nodoc	Whether filter should be excluded from documentation.	False
output	Whether to output results of this filter by default by reporters such as 'output' or 'website'.	False
output-extensions	List of extensions which this filter can produce as output.	['.*']
override-workspace-exclude-filters	If True, document will be populated to other workspaces ignoring workspace-exclude-filters.	False
preserve-prior-data-class	Whether output data class should be set to match the input data class.	False
require-output	Should dexy raise an exception if no output is produced by this filter?	True
tags	Tags which describe the filter.	[]
variables	A dictionary of variable names and values to make available to this filter.	{}
vars	A dictionary of variable names and values to make available to this filter.	{}
workspace-exclude-filters	Filters whose output should be excluded from workspace.	['pyg']
workspace-includes	If set to a list of filenames or extensions, only these will be populated to working dir.	None

Filter Source Code

class SoupSections(DexyFilter):
    """
    Split a HTML file into nested sections based on header tags.
    """
    aliases = ['soups']

    _settings = {
            'data-type' : 'sectioned',
            'html-parser' : ("Name of html parser BeautifulSoup should use.", 'html.parser'),
            'initial-section-name' : ("Name to use for the initial section which currently holds all the contents.", "Actual Document Contents"),
            }

    def append_current_section(self):
        section_dict = {
                "name" : self.current_section_name,
                "contents" : self.current_section_text,
                "level" : self.current_section_level,
                "id" : self.current_section_anchor
                }
        self.output_data._data.append(section_dict)

    def process(self):
        soup = BeautifulSoup(str(self.input_data), self.setting('html-parser'))

        for tag in soup.find_all(re.compile("^h[0-6]")):
            name = tag.text
            m = re.match("^h([0-6])$", tag.name)

            if not 'id' in tag.attrs:
                tag.attrs['id'] = inflection.parameterize(name)

            self.current_section_anchor = tag.attrs['id']
            self.current_section_text = None
            self.current_section_name = name
            self.current_section_level = int(m.groups()[0])

            self.append_current_section()

        self.current_section_text = str(soup)
        self.current_section_name = self.setting('initial-section-name')
        self.current_section_level = 1
        self.current_section_anchor = None

        self.append_current_section()

        self.output_data.save()

soups filter

soups

Aliases for this filter

Converts from file formats:

To file formats:

Available settings:

Filter Source Code

How to

Contact Us

Quick Note

About Dexy

Dexy is a free-form literate documentation tool for writing any kind of technical document incorporating code. Dexy helps you write correct documents, and to easily maintain them over time as your code changes.

Latest News

From Twitter

Thanks To

Dexy Sponsors