gtextfsm-0.2.1/0000755000175000017500000000000012513400434015117 5ustar ziozzangziozzang00000000000000gtextfsm-0.2.1/textfsm/0000755000175000017500000000000012513400434016611 5ustar ziozzangziozzang00000000000000gtextfsm-0.2.1/textfsm/__init__.py0000644000175000017500000000007012513377261020732 0ustar ziozzangziozzang00000000000000from textfsm import * __version__ = textfsm.__version__ gtextfsm-0.2.1/textfsm/clitable.py0000755000175000017500000002705312513376443020770 0ustar ziozzangziozzang00000000000000#!/usr/bin/python2.6 # # Copyright 2012 Google Inc. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. See the License for the specific language governing # permissions and limitations under the License. """GCLI Table - CLI data in TextTable format. Class that reads CLI output and parses into tabular format. Supports the use of index files to map TextFSM templates to device/command output combinations and store the data in a TextTable. Is the glue between an automated command scraping program (such as RANCID) and the TextFSM output parser. """ import copy import os import re import threading import copyable_regex_object import textfsm import texttable class Error(Exception): """Base class for errors.""" class IndexTableError(Error): """General INdexTable error.""" class CliTableError(Error): """General CliTable error.""" class IndexTable(object): """Class that reads and stores comma-separated values as a TextTable. Stores a compiled regexp of the value for efficient matching. Includes functions to preprocess Columns (both compiled and uncompiled). Attributes: index: TextTable, the index file parsed into a texttable. compiled: TextTable, the table but with compiled regexp for each field. """ def __init__(self, preread=None, precompile=None, file_path=None): """Create new IndexTable object. Args: preread: func, Pre-processing, applied to each field as it is read. precompile: func, Pre-compilation, applied to each field before compiling. file_path: String, Location of file to use as input. """ self.index = None self.compiled = None if file_path: self._index_file = file_path self._index_handle = open(self._index_file, 'r') self._ParseIndex(preread, precompile) def __len__(self): """Returns number of rows in table.""" return self.index.size def _ParseIndex(self, preread, precompile): """Reads index file and stores entries in TextTable. For optimisation reasons, a second table is created with compiled entries. Args: preread: func, Pre-processing, applied to each field as it is read. precompile: func, Pre-compilation, applied to each field before compiling. Raises: IndexTableError: If the column headers has illegal column labels. """ self.index = texttable.TextTable() self.index.CsvToTable(self._index_handle) if preread: for row in self.index: for col in row.header: row[col] = preread(col, row[col]) self.compiled = copy.deepcopy(self.index) for row in self.compiled: for col in row.header: if precompile: row[col] = precompile(col, row[col]) if row[col]: row[col] = copyable_regex_object.CopyableRegexObject(row[col]) def GetRowMatch(self, attributes): """Returns the row number that matches the supplied attributes.""" for row in self.compiled: try: for key in attributes: # Silently skip attributes not present in the index file. # pylint: disable-msg=E1103 if (key in row.header and row[key] and not row[key].match(attributes[key])): # This line does not match, so break and try next row. raise StopIteration() return row.row except StopIteration: pass return 0 class CliTable(texttable.TextTable): """Class that reads CLI output and parses into tabular format. Reads an index file and uses it to map command strings to templates. It then uses TextFSM to parse the command output (raw) into a tabular format. The superkey is the set of columns that contain data that uniquely defines the row, the key is the row number otherwise. This is typically gathered from the templates 'Key' value but is extensible. Attributes: raw: String, Unparsed command string from device/command. index_file: String, file where template/command mappings reside. template_dir: String, directory where index file and templates reside. """ # Parse each template index only once across all instances. # Without this, the regexes are parsed at every call to CliTable(). _lock = threading.Lock() INDEX = {} # pylint: disable-msg=C6409 def synchronised(func): """Synchronisation decorator.""" # pylint: disable-msg=E0213 def Wrapper(main_obj, *args, **kwargs): main_obj._lock.acquire() # pylint: disable-msg=W0212 try: return func(main_obj, *args, **kwargs) # pylint: disable-msg=E1102 finally: main_obj._lock.release() # pylint: disable-msg=W0212 return Wrapper # pylint: enable-msg=C6409 @synchronised def __init__(self, index_file=None, template_dir=None): """Create new CLiTable object. Args: index_file: String, file where template/command mappings reside. template_dir: String, directory where index file and templates reside. """ # pylint: disable-msg=E1002 super(CliTable, self).__init__() self._keys = set() self.raw = None self.index_file = index_file self.template_dir = template_dir if index_file: self.ReadIndex(index_file) def ReadIndex(self, index_file=None): """Reads the IndexTable index file of commands and templates. Args: index_file: String, file where template/command mappings reside. Raises: CliTableError: A template column was not found in the table. """ self.index_file = index_file or self.index_file fullpath = os.path.join(self.template_dir, self.index_file) if self.index_file and fullpath not in self.INDEX: self.index = IndexTable(self._PreParse, self._PreCompile, fullpath) self.INDEX[fullpath] = self.index else: self.index = self.INDEX[fullpath] # Does the IndexTable have the right columns. if 'Template' not in self.index.index.header: # pylint: disable-msg=E1103 raise CliTableError("Index file does not have 'Template' column.") def _TemplateNamesToFiles(self, template_str): """Parses a string of templates into a list of file handles.""" template_list = template_str.split(':') template_files = [] for tmplt in template_list: template_files.append( open(os.path.join(self.template_dir, tmplt), 'r')) return template_files def ParseCmd(self, cmd_input, attributes=None, templates=None): """Creates a TextTable table of values from cmd_input string. Parses command output with template/s. If more than one template is found subsequent tables are merged if keys match (dropped otherwise). Args: cmd_input: String, Device/command response. attributes: Dict, attribute that further refine matching template. templates: String list of templates to parse with. If None, uses index Raises: CliTableError: A template was not found for the given command. """ # Store raw command data within the object. self.raw = cmd_input if not templates: # Find template in template index. row_idx = self.index.GetRowMatch(attributes) if row_idx: templates = self.index.index[row_idx]['Template'] else: raise CliTableError('No template found for attributes: "%s"' % attributes) template_files = self._TemplateNamesToFiles(templates) # Re-initialise the table. self.Reset() self._keys = set() self.table = self._ParseCmdItem(self.raw, template_file=template_files[0]) # Add additional columns from any additional tables. for tmplt in template_files[1:]: self.extend(self._ParseCmdItem(self.raw, template_file=tmplt), set(self._keys)) def _ParseCmdItem(self, cmd_input, template_file=None): """Creates Texttable with output of command. Args: cmd_input: String, Device response. template_file: File object, template to parse with. Returns: TextTable containing command output. Raises: CliTableError: A template was not found for the given command. """ # Build FSM machine from the template. fsm = textfsm.TextFSM(template_file) if not self._keys: self._keys = set(fsm.GetValuesByAttrib('Key')) # Pass raw data through FSM. table = texttable.TextTable() table.header = fsm.header # Fill TextTable from record entries. for record in fsm.ParseText(cmd_input): table.Append(record) return table def _PreParse(self, key, value): """Executed against each field of each row read from index table.""" if key == 'Command': return re.sub('(\[\[.+?\]\])', self._Completion, value) else: return value def _PreCompile(self, key, value): """Executed against each field of each row before compiling as regexp.""" if key == 'Template': return else: return value def _Completion(self, match): # pylint: disable-msg=C6114 """Replaces double square brackets with variable length completion. Completion cannot be mixed with regexp matching or '\' characters i.e. '[[(\n)]] would become (\(n)?)?.' Args: match: A regex Match() object. Returns: String of the format '(a(b(c(d)?)?)?)?'. """ # Strip the outer '[[' & ']]' and replace with ()? regexp pattern. word = str(match.group())[2:-2] return '(' + ('(').join(word) + ')?' * len(word) def LabelValueTable(self, keys=None): """Return LabelValue with FSM derived keys.""" keys = keys or self.superkey # pylint: disable-msg=E1002 return super(CliTable, self).LabelValueTable(keys) # pylint: disable-msg=W0622,C6409 def sort(self, cmp=None, key=None, reverse=False): """Overrides sort func to use the KeyValue for the key.""" if not key and self._keys: key = self.KeyValue super(CliTable, self).sort(cmp=cmp, key=key, reverse=reverse) # pylint: enable-msg=W0622 def AddKeys(self, key_list): """Mark additional columns as being part of the superkey. Supplements the Keys already extracted from the FSM template. Useful when adding new columns to existing tables. Note: This will impact attempts to further 'extend' the table as the superkey must be common between tables for successful extension. Args: key_list: list of header entries to be included in the superkey. Raises: KeyError: If any entry in list is not a valid header entry. """ for keyname in key_list: if keyname not in self.header: raise KeyError("'%s'" % keyname) self._keys = self._keys.union(set(key_list)) @property def superkey(self): """Returns a set of column names that together constitute the superkey.""" sorted_list = [] for header in self.header: if header in self._keys: sorted_list.append(header) return sorted_list def KeyValue(self, row=None): """Returns the super key value for the row.""" if not row: if self._iterator: # If we are inside an iterator use current row iteration. row = self[self._iterator] else: row = self.row # If no superkey then use row number. if not self.superkey: return ['%s' % row.row] sorted_list = [] for header in self.header: if header in self.superkey: sorted_list.append(row[header]) return sorted_list gtextfsm-0.2.1/textfsm/copyable_regex_object.py0000755000175000017500000000230512513376443023520 0ustar ziozzangziozzang00000000000000#!/usr/bin/python2.6 # # Copyright 2012 Google Inc. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. See the License for the specific language governing # permissions and limitations under the License. """Work around a regression in Python 2.6 that makes RegexObjects uncopyable.""" import re class CopyableRegexObject(object): """Like a re.RegexObject, but can be copied.""" # pylint: disable-msg=C6409 def __init__(self, pattern): self.pattern = pattern self.regex = re.compile(pattern) def match(self, *args, **kwargs): return self.regex.match(*args, **kwargs) def sub(self, *args, **kwargs): return self.regex.sub(*args, **kwargs) def __copy__(self): return CopyableRegexObject(self.pattern) def __deepcopy__(self, unused_memo): return self.__copy__() gtextfsm-0.2.1/textfsm/textfsm.py0000755000175000017500000007432412513376443020706 0ustar ziozzangziozzang00000000000000#!/usr/bin/python2.4 # # Copyright 2010 Google Inc. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. See the License for the specific language governing # permissions and limitations under the License. """Template based text parser. This module implements a parser, intended to be used for converting human readable text, such as command output from a router CLI, into a list of records, containing values extracted from the input text. A simple template language is used to describe a state machine to parse a specific type of text input, returning a record of values for each input entity. """ __version__ = '0.2.1' import getopt import inspect import re import string import sys class Error(Exception): """Base class for errors.""" class Usage(Exception): """Error in command line execution.""" class TextFSMError(Error): """Error in the FSM state execution.""" class TextFSMTemplateError(Error): """Errors while parsing templates.""" # The below exceptions are internal state change triggers # and not used as Errors. class FSMAction(Exception): """Base class for actions raised with the FSM.""" class SkipRecord(FSMAction): """Indicate a record is to be skipped.""" class SkipValue(FSMAction): """Indicate a value is to be skipped.""" class TextFSMOptions(object): """Class containing all valid TextFSMValue options. Each nested class here represents a TextFSM option. The format is "option". Each class may override any of the methods inside the OptionBase class. A user of this module can extend options by subclassing TextFSMOptionsBase, adding the new option class(es), then passing that new class to the TextFSM constructor with the 'option_class' argument. """ class OptionBase(object): """Factory methods for option class. Attributes: value: A TextFSMValue, the parent Value. """ def __init__(self, value): self.value = value @property def name(self): return self.__class__.__name__.replace('option', '') def OnCreateOptions(self): """Called after all options have been parsed for a Value.""" def OnClearVar(self): """Called when value has been cleared.""" def OnClearAllVar(self): """Called when a value has clearalled.""" def OnAssignVar(self): """Called when a matched value is being assigned.""" def OnGetValue(self): """Called when the value name is being requested.""" def OnSaveRecord(self): """Called just prior to a record being committed.""" @classmethod def ValidOptions(cls): """Returns a list of valid option names.""" valid_options = [] for obj_name in dir(cls): obj = getattr(cls, obj_name) if inspect.isclass(obj) and issubclass(obj, cls.OptionBase): valid_options.append(obj_name) return valid_options @classmethod def GetOption(cls, name): """Returns the class of the requested option name.""" return getattr(cls, name) class Required(OptionBase): """The Value must be non-empty for the row to be recorded.""" def OnSaveRecord(self): if not self.value.value: raise SkipRecord class Filldown(OptionBase): """Value defaults to the previous line's value.""" def OnCreateOptions(self): self._myvar = None def OnAssignVar(self): self._myvar = self.value.value def OnClearVar(self): self.value.value = self._myvar def OnClearAllVar(self): self._myvar = None class Fillup(OptionBase): """Like Filldown, but upwards until it finds a non-empty entry.""" def OnAssignVar(self): # If value is set, copy up the results table, until we # see a set item. if self.value.value: # Get index of relevant result column. value_idx = self.value.fsm.values.index(self.value) # Go up the list from the end until we see a filled value. for result in reversed(self.value.fsm._result): if result[value_idx]: # Stop when a record has this column already. break # Otherwise set the column value. result[value_idx] = self.value.value class Key(OptionBase): """Value constitutes part of the Key of the record.""" class List(OptionBase): """Value takes the form of a list.""" def OnCreateOptions(self): self.OnClearAllVar() def OnAssignVar(self): self._value.append(self.value.value) def OnClearVar(self): if 'Filldown' not in self.value.OptionNames(): self._value = [] def OnClearAllVar(self): self._value = [] def OnSaveRecord(self): self.value.value = list(self._value) class TextFSMValue(object): """A TextFSM value. A value has syntax like: 'Value Filldown,Required helloworld (.*)' Where 'Value' is a keyword. 'Filldown' and 'Required' are options. 'helloworld' is the value name. '(.*) is the regular expression to match in the input data. Attributes: max_name_len: (int), maximum character length os a variable name. name: (str), Name of the value. options: (list), A list of current Value Options. regex: (str), Regex which the value is matched on. template: (str), regexp with named groups added. fsm: A TextFSMBase(), the containing FSM. value: (str), the current value. """ # The class which contains valid options. def __init__(self, fsm=None, max_name_len=48, options_class=None): """Initialise a new TextFSMValue.""" self.max_name_len = max_name_len self.name = None self.options = [] self.regex = None self.value = None self.fsm = fsm self._options_cls = options_class def AssignVar(self, value): """Assign a value to this Value.""" self.value = value # Call OnAssignVar on options. [option.OnAssignVar() for option in self.options] def ClearVar(self): """Clear this Value.""" self.value = None # Call OnClearVar on options. [option.OnClearVar() for option in self.options] def ClearAllVar(self): """Clear this Value.""" self.value = None # Call OnClearAllVar on options. [option.OnClearAllVar() for option in self.options] def Header(self): """Fetch the header name of this Value.""" # Call OnGetValue on options. [option.OnGetValue() for option in self.options] return self.name def OptionNames(self): """Returns a list of option names for this Value.""" return [option.name for option in self.options] def Parse(self, value): """Parse a 'Value' declaration. Args: value: String line from a template file, must begin with 'Value '. Raises: TextFSMTemplateError: Value declaration contains an error. """ value_line = value.split(' ') if len(value_line) < 3: raise TextFSMTemplateError('Expect at least 3 tokens on line.') if not value_line[2].startswith('('): # Options are present options = value_line[1] for option in options.split(','): self._AddOption(option) # Call option OnCreateOptions callbacks [option.OnCreateOptions() for option in self.options] self.name = value_line[2] self.regex = ' '.join(value_line[3:]) else: # There were no valid options, so there are no options. # Treat this argument as the name. self.name = value_line[1] self.regex = ' '.join(value_line[2:]) if len(self.name) > self.max_name_len: raise TextFSMTemplateError( "Invalid Value name '%s' or name too long." % self.name) if (not re.match(r'^\(.*\)$', self.regex) or self.regex.count('(') != self.regex.count(')')): raise TextFSMTemplateError( "Value '%s' must be contained within a '()' pair." % self.regex) self.template = re.sub(r'^\(', '(?P<%s>' % self.name, self.regex) def _AddOption(self, name): """Add an option to this Value. Args: name: (str), the name of the Option to add. Raises: TextFSMTemplateError: If option is already present or the option does not exist. """ # Check for duplicate option declaration if name in [option.name for option in self.options]: raise TextFSMTemplateError('Duplicate option "%s"' % name) # Create the option object try: option = self._options_cls.GetOption(name)(self) except AttributeError: raise TextFSMTemplateError('Unknown option "%s"' % name) self.options.append(option) def OnSaveRecord(self): """Called just prior to a record being committed.""" [option.OnSaveRecord() for option in self.options] def __str__(self): """Prints out the FSM Value, mimic the input file.""" if self.options: return 'Value %s %s %s' % ( ','.join(self.OptionNames()), self.name, self.regex) else: return 'Value %s %s' % (self.name, self.regex) class CopyableRegexObject(object): """Like a re.RegexObject, but can be copied.""" # pylint: disable-msg=C6409 def __init__(self, pattern): self.pattern = pattern self.regex = re.compile(pattern) def match(self, *args, **kwargs): return self.regex.match(*args, **kwargs) def sub(self, *args, **kwargs): return self.regex.sub(*args, **kwargs) def __copy__(self): return CopyableRegexObject(self.pattern) def __deepcopy__(self, unused_memo): return self.__copy__() class TextFSMRule(object): """A rule in each FSM state. A value has syntax like: ^ -> Next.Record State2 Where '' is a regular expression. 'Next' is a Line operator. 'Record' is a Record operator. 'State2' is the next State. Attributes: match: Regex to match this rule. regex: match after template substitution. line_op: Operator on input line on match. record_op: Operator on output record on match. new_state: Label to jump to on action regex_obj: Compiled regex for which the rule matches. line_num: Integer row number of Value. """ # Implicit default is '(regexp) -> Next.NoRecord' MATCH_ACTION = re.compile('(?P.*)(\s->(?P.*))') # The structure to the right of the '->'. LINE_OP = ('Continue', 'Next', 'Error') RECORD_OP = ('Clear', 'Clearall', 'Record', 'NoRecord') # Line operators. LINE_OP_RE = '(?P%s)' % '|'.join(LINE_OP) # Record operators. RECORD_OP_RE = '(?P%s)' % '|'.join(RECORD_OP) # Line operator with optional record operator. OPERATOR_RE = '(%s(\.%s)?)' % (LINE_OP_RE, RECORD_OP_RE) # New State or 'Error' string. NEWSTATE_RE = '(?P\w+|\".*\")' # Compound operator (line and record) with optional new state. ACTION_RE = re.compile('\s+%s(\s+%s)?$' % (OPERATOR_RE, NEWSTATE_RE)) # Record operator with optional new state. ACTION2_RE = re.compile('\s+%s(\s+%s)?$' % (RECORD_OP_RE, NEWSTATE_RE)) # Default operators with optional new state. ACTION3_RE = re.compile('(\s+%s)?$' % (NEWSTATE_RE)) def __init__(self, line, line_num=-1, var_map=None): """Initialise a new rule object. Args: line: (str), a template rule line to parse. line_num: (int), Optional line reference included in error reporting. var_map: Map for template (${var}) substitutions. Raises: TextFSMTemplateError: If 'line' is not a valid format for a Value entry. """ self.match = '' self.regex = '' self.regex_obj = None self.line_op = '' # Equivalent to 'Next'. self.record_op = '' # Equivalent to 'NoRecord'. self.new_state = '' # Equivalent to current state. self.line_num = line_num line = line.strip() if not line: raise TextFSMTemplateError('Null data in FSMRule. Line: %s' % self.line_num) # Is there '->' action present. match_action = self.MATCH_ACTION.match(line) if match_action: self.match = match_action.group('match') else: self.match = line # Replace ${varname} entries. self.regex = self.match if var_map: try: self.regex = string.Template(self.match).substitute(var_map) except (ValueError, KeyError): raise TextFSMTemplateError( "Duplicate or invalid variable substitution: '%s'. Line: %s." % (self.match, self.line_num)) try: # Work around a regression in Python 2.6 that makes RE Objects uncopyable. self.regex_obj = CopyableRegexObject(self.regex) except re.error: raise TextFSMTemplateError( "Invalid regular expression: '%s'. Line: %s." % (self.regex, self.line_num)) # No '->' present, so done. if not match_action: return # Attempt to match line.record operation. action_re = self.ACTION_RE.match(match_action.group('action')) if not action_re: # Attempt to match record operation. action_re = self.ACTION2_RE.match(match_action.group('action')) if not action_re: # Math implicit defaults with an optional new state. action_re = self.ACTION3_RE.match(match_action.group('action')) if not action_re: # Last attempt, match an optional new state only. raise TextFSMTemplateError("Badly formatted rule '%s'. Line: %s." % (line, self.line_num)) # We have an Line operator. if 'ln_op' in action_re.groupdict() and action_re.group('ln_op'): self.line_op = action_re.group('ln_op') # We have a record operator. if 'rec_op' in action_re.groupdict() and action_re.group('rec_op'): self.record_op = action_re.group('rec_op') # A new state was specified. if 'new_state' in action_re.groupdict() and action_re.group('new_state'): self.new_state = action_re.group('new_state') # Only 'Next' (or implicit 'Next') line operator can have a new_state. # But we allow error to have one as a warning message so we are left # checking that Continue does not. if (self.line_op == 'Continue' and self.new_state): raise TextFSMTemplateError( "Action '%s' with new state %s specified. Line: %s." % (self.line_op, self.new_state, self.line_num)) # Check that an error message is present only with the 'Error' operator. if self.line_op != 'Error' and self.new_state: if not re.match('\w+', self.new_state): raise TextFSMTemplateError( 'Alphanumeric characters only in state names. Line: %s.' % (self.line_num)) def __str__(self): """Prints out the FSM Rule, mimic the input file.""" operation = '' if self.line_op and self.record_op: operation = '.' operation = '%s%s%s' % (self.line_op, operation, self.record_op) if operation and self.new_state: new_state = ' ' + self.new_state else: new_state = self.new_state # Print with implicit defaults. if not (operation or new_state): return ' %s' % self.match # Non defaults. return ' %s -> %s%s' % (self.match, operation, new_state) class TextFSM(object): """Parses template and creates Finite State Machine (FSM). Attributes: states: (str), Dictionary of FSMState objects. values: (str), List of FSMVariables. value_map: (map), For substituting values for names in the expressions. header: Ordered list of values. state_list: Ordered list of valid states. """ # Variable and State name length. MAX_NAME_LEN = 48 comment_regex = re.compile('^\s*#') state_name_re = re.compile('^(\w+)$') _DEFAULT_OPTIONS = TextFSMOptions def __init__(self, template, options_class=_DEFAULT_OPTIONS): """Initialises and also parses the template file.""" self._options_cls = options_class self.states = {} # Track order of state definitions. self.state_list = [] self.values = [] self.value_map = {} # Track where we are for error reporting. self._line_num = 0 # Run FSM in this state self._cur_state = None # Name of the current state. self._cur_state_name = None # Read and parse FSM definition. # Restore the file pointer once done. try: self._Parse(template) finally: template.seek(0) # Initialise starting data. self.Reset() def __str__(self): """Returns the FSM template, mimic the input file.""" result = '\n'.join([str(value) for value in self.values]) result += '\n' for state in self.state_list: result += '\n%s\n' % state state_rules = '\n'.join([str(rule) for rule in self.states[state]]) if state_rules: result += state_rules + '\n' return result def Reset(self): """Preserves FSM but resets starting state and current record.""" # Current state is Start state. self._cur_state = self.states['Start'] self._cur_state_name = 'Start' # Clear table of results and current record. self._result = [] self._ClearAllRecord() @property def header(self): """Returns header.""" return self._GetHeader() def _GetHeader(self): """Returns header.""" header = [] for value in self.values: try: header.append(value.Header()) except SkipValue: continue return header def _GetValue(self, name): """Returns the TextFSMValue object natching the requested name.""" for value in self.values: if value.name == name: return value def _AppendRecord(self): """Adds current record to result if well formed.""" # If no Values then don't output. if not self.values: return cur_record = [] for value in self.values: try: value.OnSaveRecord() except SkipRecord: self._ClearRecord() return except SkipValue: continue # Build current record into a list. cur_record.append(value.value) # If no Values in template or whole record is empty then don't output. if len(cur_record) == (cur_record.count(None) + cur_record.count([])): return # Replace any 'None' entries with null string ''. while None in cur_record: cur_record[cur_record.index(None)] = '' self._result.append(cur_record) self._ClearRecord() def _Parse(self, template): """Parses template file for FSM structure. Args: template: Valid template file. Raises: TextFSMTemplateError: If template file syntax is invalid. """ if not template: raise TextFSMTemplateError('Null template.') # Parse header with Variables. self._ParseFSMVariables(template) # Parse States. while self._ParseFSMState(template): pass # Validate destination states. self._ValidateFSM() def _ParseFSMVariables(self, template): """Extracts Variables from start of template file. Values are expected as a contiguous block at the head of the file. These will be line separated from the State definitions that follow. Args: template: Valid template file, with Value definitions at the top. Raises: TextFSMTemplateError: If syntax or semantic errors are found. """ self.values = [] for line in template: self._line_num += 1 line = line.rstrip() # Blank line signifies end of Value definitions. if not line: return # Skip commented lines. if self.comment_regex.match(line): continue if line.startswith('Value '): try: value = TextFSMValue( fsm=self, max_name_len=self.MAX_NAME_LEN, options_class=self._options_cls) value.Parse(line) except TextFSMTemplateError, error: raise TextFSMTemplateError('%s Line %s.' % (error, self._line_num)) if value.name in self.header: raise TextFSMTemplateError( "Duplicate declarations for Value '%s'. Line: %s." % (value.name, self._line_num)) try: self._ValidateOptions(value) except TextFSMTemplateError, error: raise TextFSMTemplateError('%s Line %s.' % (error, self._line_num)) self.values.append(value) self.value_map[value.name] = value.template # The line has text but without the 'Value ' prefix. elif not self.values: raise TextFSMTemplateError('No Value definitions found.') else: raise TextFSMTemplateError( 'Expected blank line after last Value entry. Line: %s.' % (self._line_num)) def _ValidateOptions(self, value): """Checks that combination of Options is valid.""" # Always passes in base class. pass def _ParseFSMState(self, template): """Extracts State and associated Rules from body of template file. After the Value definitions the remainder of the template is state definitions. The routine is expected to be called iteratively until no more states remain - indicated by returning None. The routine checks that the state names are a well formed string, do not clash with reserved names and are unique. Args: template: Valid template file after Value definitions have already been read. Returns: Name of the state parsed from file. None otherwise. Raises: TextFSMTemplateError: If any state definitions are invalid. """ if not template: return state_name = '' # Strip off extra white space lines (including comments). for line in template: self._line_num += 1 line = line.rstrip() # First line is state definition if line and not self.comment_regex.match(line): # Ensure statename has valid syntax and is not a reserved word. if (not self.state_name_re.match(line) or len(line) > self.MAX_NAME_LEN or line in TextFSMRule.LINE_OP or line in TextFSMRule.RECORD_OP): raise TextFSMTemplateError("Invalid state name: '%s'. Line: %s" % (line, self._line_num)) state_name = line if state_name in self.states: raise TextFSMTemplateError("Duplicate state name: '%s'. Line: %s" % (line, self._line_num)) self.states[state_name] = [] self.state_list.append(state_name) break # Parse each rule in the state. for line in template: self._line_num += 1 line = line.rstrip() # Finish rules processing on blank line. if not line: break if self.comment_regex.match(line): continue # A rule within a state, starts with whitespace if not (line.startswith(' ^') or line.startswith('\t^')): raise TextFSMTemplateError( "Missing white space or carat ('^') before rule. Line: %s" % self._line_num) self.states[state_name].append( TextFSMRule(line, self._line_num, self.value_map)) return state_name def _ValidateFSM(self): """Checks state names and destinations for validity. Each destination state must exist, be a valid name and not be a reserved name. There must be a 'Start' state and if 'EOF' or 'End' states are specified, they must be empty. Returns: True if FSM is valid. Raises: TextFSMTemplateError: If any state definitions are invalid. """ # Must have 'Start' state. if 'Start' not in self.states: raise TextFSMTemplateError("Missing state 'Start'.") # 'End/EOF' state (if specified) must be empty. if self.states.get('End'): raise TextFSMTemplateError("Non-Empty 'End' state.") if self.states.get('EOF'): raise TextFSMTemplateError("Non-Empty 'EOF' state.") # Remove 'End' state. if 'End' in self.states: del(self.states['End']) self.state_list.remove('End') # Ensure jump states are all valid. for state in self.states: for rule in self.states[state]: if rule.line_op == 'Error': continue if not rule.new_state or rule.new_state in ('End', 'EOF'): continue if rule.new_state not in self.states: raise TextFSMTemplateError( "State '%s' not found, referenced in state '%s'" % (rule.new_state, state)) return True def ParseText(self, text, eof=True): """Passes CLI output through FSM and returns list of tuples. First tuple is the header, every subsequent tuple is a row. Args: text: (str), Text to parse with embedded newlines. eof: (boolean), Set to False if we are parsing only part of the file. Suppresses triggering EOF state. Raises: TextFSMError: An error occurred within the FSM. Returns: List of Lists. """ lines = [] if text: lines = text.splitlines() for line in lines: self._CheckLine(line) if self._cur_state_name in ('End', 'EOF'): break if self._cur_state_name != 'End' and 'EOF' not in self.states and eof: # Implicit EOF performs Next.Record operation. # Suppressed if Null EOF state is instantiated. self._AppendRecord() return self._result def _CheckLine(self, line): """Passes the line through each rule until a match is made. Args: line: A string, the current input line. """ for rule in self._cur_state: matched = self._CheckRule(rule, line) if matched: for value in matched.groupdict(): self._AssignVar(matched, value) if self._Operations(rule): # Not a Continue so check for state transition. if rule.new_state: if rule.new_state not in ('End', 'EOF'): self._cur_state = self.states[rule.new_state] self._cur_state_name = rule.new_state break def _CheckRule(self, rule, line): """Check a line against the given rule. This is a separate method so that it can be overridden by a debugging tool. Args: rule: A TextFSMRule(), the rule to check. line: A str, the line to check. Returns: A regex match object. """ return rule.regex_obj.match(line) def _AssignVar(self, matched, value): """Assigns variable into current record from a matched rule. If a record entry is a list then append, otherwise values are replaced. Args: matched: (regexp.match) Named group for each matched value. value: (str) The matched value. """ self._GetValue(value).AssignVar(matched.group(value)) def _Operations(self, rule): """Operators on the data record. Operators come in two parts and are a '.' separated pair: Operators that effect the input line or the current state (line_op). 'Next' Get next input line and restart parsing (default). 'Continue' Keep current input line and continue resume parsing. 'Error' Unrecoverable input discard result and raise Error. Operators that affect the record being built for output (record_op). 'NoRecord' Does nothing (default) 'Record' Adds the current record to the result. 'Clear' Clears non-Filldown data from the record. 'Clearall' Clears all data from the record. Args: rule: FSMRule object. Returns: True if state machine should restart state with new line. Raises: TextFSMError: If Error state is encountered. """ # First process the Record operators. if rule.record_op == 'Record': self._AppendRecord() elif rule.record_op == 'Clear': # Clear record. self._ClearRecord() elif rule.record_op == 'Clearall': # Clear all record entries. self._ClearAllRecord() # Lastly process line operators. if rule.line_op == 'Error': if rule.new_state: raise TextFSMError('Error: %s. Line: %s.' % (rule.new_state, rule.line_num)) raise TextFSMError('State Error raised. Line: %s.' % (rule.line_num)) elif rule.line_op == 'Continue': # Continue with current line without returning to the start of the state. return False # Back to start of current state with a new line. return True def _ClearRecord(self): """Remove non 'Filldown' record entries.""" [value.ClearVar() for value in self.values] def _ClearAllRecord(self): """Remove all record entries.""" [value.ClearAllVar() for value in self.values] def GetValuesByAttrib(self, attribute): """Returns the list of values that have a particular attribute.""" if attribute not in self._options_cls.ValidOptions(): raise ValueError("'%s': Not a valid attribute." % attribute) result = [] for value in self.values: if attribute in value.OptionNames(): result.append(value.name) return result def main(argv=None): """Validate text parsed with FSM or validate an FSM via command line.""" if argv is None: argv = sys.argv try: opts, args = getopt.getopt(argv[1:], 'h', ['help']) except getopt.error, msg: raise Usage(msg) for opt, _ in opts: if opt in ('-h', '--help'): print __doc__ print help_msg return 0 if not args or len(args) > 4: raise Usage('Invalid arguments.') # If we have an argument, parse content of file and display as a template. # Template displayed will match input template, minus any comment lines. template = open(args[0], 'r') fsm = TextFSM(template) print 'FSM Template:\n%s\n' % fsm if len(args) > 1: # Second argument is file with example cli input. # Prints parsed tabular result. cli_input = open(args[1], 'r').read() table = fsm.ParseText(cli_input) print 'FSM Table:' result = str(fsm.header) + '\n' for line in table: result += str(line) + '\n' print result, if len(args) > 2: # Compare tabular result with data in third file argument. # Exit value indicates if processed data matched expected result. ref_table = open(args[2], 'r').read() if ref_table != result: print 'Data mis-match!' return 1 else: print 'Data match!' if __name__ == '__main__': help_msg = '%s [--help] template [input_file [output_file]]\n' % sys.argv[0] try: sys.exit(main()) except Usage, err: print >>sys.stderr, err print >>sys.stderr, 'For help use --help' sys.exit(2) except (IOError, TextFSMError, TextFSMTemplateError), err: print >>sys.stderr, err sys.exit(2) gtextfsm-0.2.1/textfsm/texttable.py0000755000175000017500000007222412513376443021205 0ustar ziozzangziozzang00000000000000#!/usr/bin/python2.6 # # Copyright 2012 Google Inc. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. See the License for the specific language governing # permissions and limitations under the License. """A module to represent and manipulate tabular text data. A table of rows, indexed on row number. Each row is a ordered dictionary of row elements that maintains knowledge of the parent table and column headings. Tables can be created from CSV input and in-turn supports a number of display formats such as CSV and variable sized and justified rows. """ import copy import textwrap import terminal class Error(Exception): """Base class for errors.""" class TableError(Error): """Error in TextTable.""" class Row(dict): """Represents a table row. We implement this as an ordered dictionary. The order is the chronological order of data insertion. Methods are supplied to make it behave like a regular dict() and list(). Attributes: row: int, the row number in the container table. 0 is the header row. table: A TextTable(), the associated container table. """ def __init__(self, *args, **kwargs): super(Row, self).__init__(*args, **kwargs) self._keys = list() self._values = list() self.row = None self.table = None self._color = None def __getitem__(self, column): """Support for [] notation. Args: column: Tuple of column names, or a (str) column name, or positional column number, 0-indexed. Returns: A list or string with column value(s). Raises: IndexError: The given column(s) were not found. """ if isinstance(column, list) or isinstance(column, tuple): ret = [] for col in column: ret.append(self[col]) return ret # Perhaps we have a range like '1', ':-1' or '1:'. try: return self._values[column] except TypeError: pass for i in xrange(len(self._keys)): if self._keys[i] == column: return self._values[i] raise IndexError('No such column "%s" in row.' % column) def __contains__(self, value): return value in self._values def __setitem__(self, column, value): for i in xrange(len(self)): if self._keys[i] == column: self._values[i] = value return # No column found, add a new one. self._keys.append(column) self._values.append(value) def __iter__(self): return iter(self._values) def __len__(self): return len(self._keys) def __str__(self): ret = '' for v in self._values: ret += '%12s ' % v ret += '\n' return ret def __repr__(self): return '%s(%r)' % (self.__class__.__name__, str(self)) def index(self, column): # pylint: disable-msg=C6409 """Fetches the column number (0 indexed). Args: column: A string, column to fetch the index of. Returns: An int, the row index number. Raises: ValueError: The specified column was not found. """ for i, key in enumerate(self._keys): if key == column: return i raise ValueError('Column "%s" not found.' % column) def iterkeys(self): return iter(self._keys) def items(self): # TODO(harro): self.get(k) should work here but didn't ? return [(k, self.__getitem__(k)) for k in self._keys] def _GetValues(self): """Return the row's values.""" return self._values def _GetHeader(self): """Return the row's header.""" return self._keys def _SetHeader(self, values): """Set the row's header from a list.""" if self._values and len(values) != len(self._values): raise ValueError('Header values not equal to existing data width.') if not self._values: for _ in xrange(len(values)): self._values.append(None) self._keys = list(values) def _SetColour(self, value_list): """Sets row's colour attributes to a list of values in terminal.SGR.""" if value_list is None: self._color = None return colors = [] for color in value_list: if color in terminal.SGR: colors.append(color) elif color in terminal.FG_COLOR_WORDS: colors += terminal.FG_COLOR_WORDS[color] elif color in terminal.BG_COLOR_WORDS: colors += terminal.BG_COLOR_WORDS[color] else: raise ValueError('Invalid colour specification.') self._color = list(set(colors)) def _GetColour(self): if self._color is None: return None return list(self._color) def _SetValues(self, values): """Set values from supplied dictionary or list. Args: values: A Row, dict indexed by column name, or list. Raises: TypeError: Argument is not a list or dict, or list is not equal row length or dictionary keys don't match. """ def _ToStr(value): """Convert individul list entries to string.""" if isinstance(value, (list, tuple)): result = [] for val in value: result.append(str(val)) return result else: return str(value) # Row with identical header can be copied directly. if isinstance(values, Row): if self._keys != values.header: raise TypeError('Attempt to append row with mismatched header.') self._values = copy.deepcopy(values.values) elif isinstance(values, dict): for key in self._keys: if key not in values: raise TypeError('Dictionary key mismatch with row.') for key in self._keys: self[key] = _ToStr(values[key]) elif isinstance(values, list) or isinstance(values, tuple): if len(values) != len(self._values): raise TypeError('Supplied list length != row length') for (index, value) in enumerate(values): self._values[index] = _ToStr(value) else: raise TypeError('Supplied argument must be Row, dict or list, not %s', type(values)) def Insert(self, key, value, row_index): """Inserts new values at a specified offset. Args: key: string for header value. value: string for a data value. row_index: Offset into row for data. Raises: IndexError: If the offset is out of bands. """ if row_index < 0: row_index += len(self) if not 0 <= row_index < len(self): raise IndexError('Index "%s" is out of bounds.' % row_index) new_row = Row() for idx in self.header: if self.index(idx) == row_index: new_row[key] = value new_row[idx] = self[idx] self._keys = new_row.header self._values = new_row.values del new_row color = property(_GetColour, _SetColour, doc='Colour spec of this row') header = property(_GetHeader, _SetHeader, doc="List of row's headers.") values = property(_GetValues, _SetValues, doc="List of row's values.") class TextTable(object): """Class that provides data methods on a tabular format. Data is stored as a list of Row() objects. The first row is always present as the header row. Attributes: row_class: class, A class to use for the Row object. separator: str, field separator when printing table. """ def __init__(self, row_class=Row): """Initialises a new table. Args: row_class: A class to use as the row object. This should be a subclass of this module's Row() class. """ self.row_class = row_class self.separator = ', ' self.Reset() def Reset(self): self._row_index = 1 self._table = [[]] self._iterator = 0 # While loop row index def __repr__(self): return '%s(%r)' % (self.__class__.__name__, str(self)) def __str__(self): """Displays table with pretty formatting.""" return self.table def __incr__(self, incr=1): self._SetRowIndex(self._row_index +incr) def __contains__(self, name): """Whether the given column header name exists.""" return name in self.header def __getitem__(self, row): """Fetches the given row number.""" return self._table[row] def __iter__(self): """Iterator that excludes the header row.""" return self.next() def next(self): # Maintain a counter so a row can know what index it is. # Save the old value to support nested interations. old_iter = self._iterator try: for r in self._table[1:]: self._iterator = r.row yield r finally: # Recover the original index after loop termination or exit with break. self._iterator = old_iter def __add__(self, other): """Merges two with identical columns.""" new_table = copy.copy(self) for row in other: new_table.Append(row) return new_table def __copy__(self): """Copy table instance.""" new_table = self.__class__() new_table._table = [self.header] for row in self[1:]: new_table.Append(row) return new_table # pylint: disable-msg=C6409 # pylint: disable-msg=W0622 def sort(self, cmp=None, key=None, reverse=False): """Sorts rows in the texttable. Args: cmp: func, non default sort algorithm to use. key: func, applied to each element before sorting. reverse: bool, reverse order of sort. """ def _DefaultKey(value): """Default key func is to create a list of all fields.""" result = [] for key in self.header: # Try sorting as numerical value if possible. try: result.append(float(value[key])) except ValueError: result.append(value[key]) return result key = key or _DefaultKey # Exclude header by copying table. new_table = self._table[1:] new_table.sort(cmp, key, reverse) # Regenerate the table with original header self._table = [self.header] self._table.extend(new_table) # Re-write the 'row' attribute of each row for index, row in enumerate(self._table): row.row = index # pylint: enable-msg=W0622 def extend(self, table, keys=None): """Extends all rows in the texttable. The rows are extended with the new columns from the table. Args: table: A texttable, the table to extend this table by. keys: A set, the set of columns to use as the key. If None, the row index is used. Raises: IndexError: If key is not a valid column name. """ if keys: for k in keys: if k not in self._Header(): raise IndexError("Unknown key: '%s'", k) extend_with = [] for column in table.header: if column not in self.header: extend_with.append(column) if not extend_with: return for column in extend_with: self.AddColumn(column) if not keys: for row1, row2 in zip(self, table): for column in extend_with: row1[column] = row2[column] return for row1 in self: for row2 in table: for k in keys: if row1[k] != row2[k]: break else: for column in extend_with: row1[column] = row2[column] break # pylint: enable-msg=C6409 def Remove(self, row): """Removes a row from the table. Args: row: int, the row number to delete. Must be >= 1, as the header cannot be removed. Raises: TableError: Attempt to remove nonexistent or header row. """ if row == 0 or row > self.size: raise TableError('Attempt to remove header row') new_table = [] # pylint: disable-msg=E1103 for t_row in self._table: if t_row.row != row: new_table.append(t_row) if t_row.row > row: t_row.row -= 1 self._table = new_table def _Header(self): """Returns the header row.""" return self._table[0] def _GetRow(self, columns=None): """Returns the current row as a tuple.""" row = self._table[self._row_index] if columns: result = [] for col in columns: if not col in self.header: raise TableError('Column header %s not known in table.' % col) result.append(row[self.header.index(col)]) row = result return row def _SetRow(self, new_values, row=0): """Sets the current row to new list. Args: new_values: List|dict of new values to insert into row. row: int, Row to insert values into. Raises: TableError: If number of new values is not equal to row size. """ if not row: row = self._row_index if row > self.size: raise TableError('Entry %s beyond table size %s.' % (row, self.size)) self._table[row].values = new_values def _SetHeader(self, new_values): """Sets header of table to the given tuple. Args: new_values: Tuple of new header values. """ row = self.row_class() row.row = 0 for v in new_values: row[v] = v self._table[0] = row def _SetRowIndex(self, row): if not row or row > self.size: raise TableError('Entry %s beyond table size %s.' % (row, self.size)) self._row_index = row def _GetRowIndex(self): return self._row_index def _GetSize(self): """Returns number of rows in table.""" if not self._table: return 0 return len(self._table) - 1 def _GetTable(self): """Returns table, with column headers and separators. Returns: The whole table including headers as a string. Each row is joined by a newline and each entry by self.separator. """ result = [] # Avoid the global lookup cost on each iteration. lstr = str for row in self._table: result.append( '%s\n' % self.separator.join(lstr(v) for v in row)) return ''.join(result) def _SetTable(self, table): """Sets table, with column headers and separators.""" if not isinstance(table, TextTable): raise TypeError('Not an instance of TextTable.') self.Reset() self._table = copy.deepcopy(table._table) # pylint: disable-msg=W0212 # Point parent table of each row back ourselves. for row in self: row.table = self def _SmallestColSize(self, text): """Finds the largest indivisible word of a string. ...and thus the smallest possible column width that can contain that word unsplit over rows. Args: text: A string of text potentially consisting of words. Returns: Integer size of the largest single word in the text. """ if not text: return 0 stripped = terminal.StripAnsiText(text) return max(len(word) for word in stripped.split()) def _TextJustify(self, text, col_size): """Formats text within column with white space padding. A single space is prefixed, and a number of spaces are added as a suffix such that the length of the resultant string equals the col_size. If the length of the text exceeds the column width available then it is split into words and returned as a list of string, each string contains one or more words padded to the column size. Args: text: String of text to format. col_size: integer size of column to pad out the text to. Returns: List of strings col_size in length. Raises: TableError: If col_size is too small to fit the words in the text. """ result = [] if '\n' in text: for paragraph in text.split('\n'): result.extend(self._TextJustify(paragraph, col_size)) return result wrapper = textwrap.TextWrapper(width=col_size-2, break_long_words=False, expand_tabs=False) try: text_list = wrapper.wrap(text) except ValueError: raise TableError('Field too small (minimum width: 3)') if not text_list: return [' '*col_size] for current_line in text_list: stripped_len = len(terminal.StripAnsiText(current_line)) ansi_color_adds = len(current_line) - stripped_len # +2 for white space on either side. if stripped_len + 2 > col_size: raise TableError('String contains words that do not fit in column.') result.append(' %-*s' % (col_size - 1 + ansi_color_adds, current_line)) return result def FormattedTable(self, width=80, force_display=False, ml_delimiter=True, color=True, display_header=True): """Returns whole table, with whitespace padding and row delimiters. Args: width: An int, the max width we want the table to fit in. force_display: A bool, if set to True will display table when the table can't be made to fit to the width. ml_delimiter: A bool, if set to False will not display the multi-line delimiter. color: A bool. If true, display any colours in row.colour. display_header: A bool. If true, display header. Returns: A string. The tabled output. Raises: TableError: Width too narrow to display table. """ # Largest is the biggest data entry in a column. largest = {} # Smallest is the same as above but with linewrap i.e. largest unbroken # word in the data stream. smallest = {} # largest == smallest for a column with a single word of data. # Initialise largest and smallest for all columns. for key in self._Header(): largest[key] = 0 smallest[key] = 0 # Find the largest and smallest values. # Include Title line in equation. # pylint: disable-msg=E1103 for row in self._table: for key, value in row.items(): # Convert lists into a string. if isinstance(value, list): value = ', '.join(value) value = terminal.StripAnsiText(value) largest[key] = max(len(value), largest[key]) smallest[key] = max(self._SmallestColSize(value), smallest[key]) # pylint: enable-msg=E1103 min_total_width = 0 multi_word = [] # Bump up the size of each column to include minimum pad. # Find all columns that can be wrapped (multi-line). # And the minimum width needed to display all columns (even if wrapped). for key in self._Header(): # Each column is bracketed by a space on both sides. # So increase size required accordingly. largest[key] += 2 smallest[key] += 2 min_total_width += smallest[key] # If column contains data that 'could' be split over multiple lines. if largest[key] != smallest[key]: multi_word.append(key) # Check if we have enough space to display the table. if min_total_width > width and not force_display: raise TableError('Width too narrow to display table.') # We have some columns that may need wrapping over several lines. if multi_word: # Find how much space is left over for the wrapped columns to use. # Also find how much space we would need if they were not wrapped. # These are 'spare_width' and 'desired_width' respectively. desired_width = 0 spare_width = width - min_total_width for key in multi_word: spare_width += smallest[key] desired_width += largest[key] # Scale up the space we give each wrapped column. # Proportional to its size relative to 'desired_width' for all columns. # Rinse and repeat if we changed the wrap list in this iteration. # Once done we will have a list of columns that definitely need wrapping. done = False while not done: done = True for key in multi_word: # If we scale past the desired width for this particular column, # then give it its desired width and remove it from the wrapped list. if (largest[key] <= round((largest[key] / float(desired_width)) * spare_width)): smallest[key] = largest[key] multi_word.remove(key) spare_width -= smallest[key] desired_width -= largest[key] done = False # If we scale below the minimum width for this particular column, # then leave it at its minimum and remove it from the wrapped list. elif (smallest[key] >= round((largest[key] / float(desired_width)) * spare_width)): multi_word.remove(key) spare_width -= smallest[key] desired_width -= largest[key] done = False # Repeat the scaling algorithm with the final wrap list. # This time we assign the extra column space by increasing 'smallest'. for key in multi_word: smallest[key] = int(round((largest[key] / float(desired_width)) * spare_width)) total_width = 0 row_count = 0 result_dict = {} # Format the header lines and add to result_dict. # Find what the total width will be and use this for the ruled lines. # Find how many rows are needed for the most wrapped line (row_count). for key in self._Header(): result_dict[key] = self._TextJustify(key, smallest[key]) if len(result_dict[key]) > row_count: row_count = len(result_dict[key]) total_width += smallest[key] # Store header in header_list, working down the wrapped rows. header_list = [] for row_idx in xrange(row_count): for key in self._Header(): try: header_list.append(result_dict[key][row_idx]) except IndexError: # If no value than use whitespace of equal size. header_list.append(' '*smallest[key]) header_list.append('\n') # Format and store the body lines result_dict = {} body_list = [] # We separate multi line rows with a single line delimiter. prev_muli_line = False # Unless it is the first line in which there is already the header line. first_line = True for row in self: row_count = 0 for key, value in row.items(): # Convert field contents to a string. if isinstance(value, list): value = ', '.join(value) # Store results in result_dict and take note of wrapped line count. result_dict[key] = self._TextJustify(value, smallest[key]) if len(result_dict[key]) > row_count: row_count = len(result_dict[key]) if row_count > 1: prev_muli_line = True # If current or prior line was multi-line then include delimiter. if not first_line and prev_muli_line and ml_delimiter: body_list.append('-'*total_width + '\n') if row_count == 1: # Our current line was not wrapped, so clear flag. prev_muli_line = False row_list = [] for row_idx in xrange(row_count): for key in self._Header(): try: row_list.append(result_dict[key][row_idx]) except IndexError: # If no value than use whitespace of equal size. row_list.append(' '*smallest[key]) row_list.append('\n') if color and row.color is not None: body_list.append( terminal.AnsiText(''.join(row_list)[:-1], command_list=row.color)) body_list.append('\n') else: body_list.append(''.join(row_list)) first_line = False header = ''.join(header_list) + '='*total_width if color and self._Header().color is not None: header = terminal.AnsiText(header, command_list=self._Header().color) # Add double line delimiter between header and main body. if display_header: return '%s\n%s' % (header, ''.join(body_list)) return '%s' % ''.join(body_list) def LabelValueTable(self, label_list=None): """Returns whole table as rows of name/value pairs. One (or more) column entries are used for the row prefix label. The remaining columns are each displayed as a row entry with the prefix labels appended. Use the first column as the label if label_list is None. Args: label_list: A list of prefix labels to use. Returns: Label/Value formatted table. Raises: TableError: If specified label is not a column header of the table. """ label_list = label_list or self._Header()[0] # Ensure all labels are valid. for label in label_list: if label not in self._Header(): raise TableError('Invalid label prefix: %s.' % label) sorted_list = [] for header in self._Header(): if header in label_list: sorted_list.append(header) label_str = '# LABEL %s\n' % '.'.join(sorted_list) body = [] for row in self: # Some of the row values are pulled into the label, stored in label_prefix. label_prefix = [] value_list = [] for key, value in row.items(): if key in sorted_list: # Set prefix. label_prefix.append(value) else: value_list.append('%s %s' % (key, value)) body.append(''.join( ['%s.%s\n' % ('.'.join(label_prefix), v) for v in value_list])) return '%s%s' % (label_str, ''.join(body)) table = property(_GetTable, _SetTable, doc='Whole table') row = property(_GetRow, _SetRow, doc='Current row') header = property(_Header, _SetHeader, doc='List of header entries.') row_index = property(_GetRowIndex, _SetRowIndex, doc='Current row.') size = property(_GetSize, doc='Number of rows in table.') def RowWith(self, column, value): """Retrieves the first non header row with the column of the given value. Args: column: str, the name of the column to check. value: str, The value of the column to check. Returns: A Row() of the first row found, None otherwise. Raises: IndexError: The specified column does not exist. """ for row in self._table[1:]: if row[column] == value: return row return None def AddColumn(self, column, default='', col_index=-1): """Appends a new column to the table. Args: column: A string, name of the column to add. default: Default value for entries. Defaults to ''. col_index: Integer index for where to insert new column. Raises: TableError: Column name already exists. """ if column in self.table: raise TableError('Column %r already in table.' % column) if col_index == -1: self._table[0][column] = column for i in xrange(1, len(self._table)): self._table[i][column] = default else: self._table[0].Insert(column, column, col_index) for i in xrange(1, len(self._table)): self._table[i].Insert(column, default, col_index) def Append(self, new_values): """Adds a new row (list) to the table. Args: new_values: Tuple, dict, or Row() of new values to append as a row. Raises: TableError: Supplied tuple not equal to table width. """ newrow = self.NewRow() newrow.values = new_values self._table.append(newrow) def NewRow(self, value=''): """Fetches a new, empty row, with headers populated. Args: value: Initial value to set each row entry to. Returns: A Row() object. """ newrow = self.row_class() newrow.row = self.size + 1 newrow.table = self headers = self._Header() for header in headers: newrow[header] = value return newrow def CsvToTable(self, buf, header=True, separator=','): """Parses buffer into tabular format. Strips off comments (preceded by '#'). Optionally parses and indexes by first line (header). Args: buf: String file buffer containing CSV data. header: Is the first line of buffer a header. separator: String that CSV is separated by. Returns: int, the size of the table created. Raises: TableError: A parsing error occurred. """ self.Reset() header_row = self.row_class() if header: line = buf.readline() header_str = '' while not header_str: # Remove comments. header_str = line.split('#')[0].strip() if not header_str: line = buf.readline() header_list = header_str.split(separator) header_length = len(header_list) for entry in header_list: entry = entry.strip() if entry in header_row: raise TableError('Duplicate header entry %r.' % entry) header_row[entry] = entry header_row.row = 0 self._table[0] = header_row # xreadlines would be better but not supported by StringIO for testing. for line in buf: # Support commented lines, provide '#' is first character of line. if line.startswith('#'): continue lst = line.split(separator) lst = [l.strip() for l in lst] if header and len(lst) != header_length: # Silently drop illegal line entries continue if not header: header_row = self.row_class() header_length = len(lst) header_row.values = dict(zip(xrange(header_length), xrange(header_length))) self._table[0] = header_row header = True continue new_row = self.NewRow() new_row.values = lst header_row.row = self.size + 1 self._table.append(new_row) return self.size def index(self, name=None): # pylint: disable-msg=C6409 """Returns index number of supplied column name. Args: name: string of column name. Raises: TableError: If name not found. Returns: Index of the specified header entry. """ try: return self.header.index(name) except ValueError: raise TableError('Unknown index name %s.' % name) gtextfsm-0.2.1/setup.py0000755000175000017500000000244112513400313016631 0ustar ziozzangziozzang00000000000000#!/usr/bin/python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from distutils.core import setup import textfsm setup(name='gtextfsm', maintainer='Google', maintainer_email='textfsm-dev@googlegroups.com', version=textfsm.__version__, url='https://code.google.com/p/textfsm/', license='Apache License, Version 2.0', classifiers=[ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: Apache Software License', 'Operating System :: OS Independent', 'Topic :: Software Development :: Libraries'], requires=['terminal'], packages = ["textfsm"],) #py_modules=['clitable', 'textfsm', 'copyable_regex_object', 'texttable']) gtextfsm-0.2.1/PKG-INFO0000644000175000017500000000102512513400434016212 0ustar ziozzangziozzang00000000000000Metadata-Version: 1.1 Name: gtextfsm Version: 0.2.1 Summary: UNKNOWN Home-page: https://code.google.com/p/textfsm/ Author: Google Author-email: textfsm-dev@googlegroups.com License: Apache License, Version 2.0 Description: UNKNOWN Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: Apache Software License Classifier: Operating System :: OS Independent Classifier: Topic :: Software Development :: Libraries Requires: terminal