BaseHeader

class astropy.io.ascii.BaseHeader[source] [edit on github]

Bases: object

Base table header reader

Attributes Summary

auto_format
colnames Return the column names of the table
comment
names
start_line
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-blank and non-comment lines
update_meta(lines, meta) Extract any table-level metadata, e.g.
write(lines)
write_comments(lines, meta)

Attributes Documentation

auto_format = 'col{}'
colnames

Return the column names of the table

comment = None
names = None
start_line = None
write_comment = False
write_spacer_lines = ['ASCII_TABLE_WRITE_SPACER_LINE']

Methods Documentation

check_column_names(names, strict_names, guessing)[source] [edit on github]

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

User-supplied list of column names

strict_names : bool

Whether to impose extra requirements on names

guessing : bool

True if this method is being called while guessing the table format

get_col_type(col)[source] [edit on github]
get_cols(lines)[source] [edit on github]

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

List of table lines

get_type_map_key(col)[source] [edit on github]
process_lines(lines)[source] [edit on github]

Generator to yield non-blank and non-comment lines

update_meta(lines, meta)[source] [edit on github]

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.

write(lines)[source] [edit on github]
write_comments(lines, meta)[source] [edit on github]