argparse::HelpFormatter::_Section Class Reference

List of all members.

Public Member Functions
def	__init__
def	__init__
def	format_help
def	format_help
Public Attributes
	formatter
	heading
	items
	parent

---

Detailed Description

Definition at line 194 of file argparse.py.

---

Constructor & Destructor Documentation

def argparse::HelpFormatter::_Section::__init__	(		self,
			formatter,
			parent,
			heading = None
	)

Definition at line 196 of file argparse.py.

                                                           :
            self.formatter = formatter
            self.parent = parent
            self.heading = heading
            self.items = []

def argparse::HelpFormatter::_Section::__init__	(		self,
			formatter,
			parent,
			heading = None
	)

Definition at line 227 of file argparse.py.

                                                           :
            self.formatter = formatter
            self.parent = parent
            self.heading = heading
            self.items = []

---

Member Function Documentation

def argparse::HelpFormatter::_Section::format_help

(

self

)

Definition at line 202 of file argparse.py.

00203                              :
00204             # format the indented section
00205             if self.parent is not None:
00206                 self.formatter._indent()
00207             join = self.formatter._join_parts
00208             for func, args in self.items:
00209                 func(*args)
00210             item_help = join([func(*args) for func, args in self.items])
00211             if self.parent is not None:
00212                 self.formatter._dedent()
00213 
00214             # return nothing if the section was empty
00215             if not item_help:
00216                 return ''
00217 
00218             # add the heading if the section was non-empty
00219             if self.heading is not SUPPRESS and self.heading is not None:
00220                 current_indent = self.formatter._current_indent
00221                 heading = '%*s%s:\n' % (current_indent, '', self.heading)
00222             else:
00223                 heading = ''
00224 
00225             # join the section-initial newline, the heading and the help
00226             return join(['\n', heading, item_help, '\n'])
00227 
    def _add_item(self, func, args):

def argparse::HelpFormatter::_Section::format_help

(

self

)

Definition at line 233 of file argparse.py.

                             :
            # format the indented section
            if self.parent is not None:
                self.formatter._indent()
            join = self.formatter._join_parts
            for func, args in self.items:
                func(*args)
            item_help = join([func(*args) for func, args in self.items])
            if self.parent is not None:
                self.formatter._dedent()

            # return nothing if the section was empty
            if not item_help:
                return ''

            # add the heading if the section was non-empty
            if self.heading is not SUPPRESS and self.heading is not None:
                current_indent = self.formatter._current_indent
                heading = '%*s%s:\n' % (current_indent, '', self.heading)
            else:
                heading = ''

            # join the section-initial newline, the heading and the help
            return join(['\n', heading, item_help, '\n'])

    def _add_item(self, func, args):

---

Member Data Documentation

argparse::HelpFormatter::_Section::formatter

Definition at line 196 of file argparse.py.

argparse::HelpFormatter::_Section::heading

Definition at line 196 of file argparse.py.

argparse::HelpFormatter::_Section::items

Definition at line 196 of file argparse.py.

argparse::HelpFormatter::_Section::parent

Definition at line 196 of file argparse.py.