Bases: object
Base table header reader
Attributes Summary
auto_format | format string for auto-generating column names |
colnames | Return the column names of the table |
comment | regular expression for comment lines |
names | list of names corresponding to each data column |
start_line | None, int, or a function of lines that returns None or int |
write_comment | |
write_spacer_lines |
Methods Summary
check_column_names(names, strict_names, guessing) | Check column names. |
get_col_type(col) | |
get_cols(lines) | Initialize the header Column objects from the table lines. |
get_type_map_key(col) | |
process_lines(lines) | Generator to yield non-comment lines |
update_meta(lines, meta) | Extract any table-level metadata, e.g. |
write(lines) | |
write_comments(lines, meta) |
Attributes Documentation
format string for auto-generating column names
Return the column names of the table
regular expression for comment lines
list of names corresponding to each data column
None, int, or a function of lines that returns None or int
Methods Documentation
Check column names.
This must be done before applying the names transformation so that guessing will fail appropriately if names is supplied. For instance if the basic reader is given a table with no column header row.
Parameters: | names : list
strict_names : bool
guessing : bool
|
---|
Initialize the header Column objects from the table lines.
Based on the previously set Header attributes find or create the column names. Sets self.cols with the list of Columns.
Parameters: | lines : list
|
---|
Generator to yield non-comment lines
Extract any table-level metadata, e.g. keywords, comments, column metadata, from the table lines and update the OrderedDict meta in place. This base method extracts comment lines and stores them in meta for output.