BaseHeader¶
-
class
astropy.io.ascii.
BaseHeader
[source]¶ Bases:
object
Base table header reader
Attributes Summary
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 intMethods Summary
check_column_names
(self, names, …)Check column names.
get_col_type
(self, col)get_cols
(self, lines)Initialize the header Column objects from the table
lines
.get_type_map_key
(self, col)process_lines
(self, lines)Generator to yield non-blank and non-comment lines
remove_columns
(self, names)Remove several columns from the table.
rename_column
(self, name, new_name)Rename a column.
update_meta
(self, lines, meta)Extract any table-level metadata, e.g.
write
(self, lines)write_comments
(self, lines, meta)Attributes Documentation
-
auto_format
= 'col{}'¶ format string for auto-generating column names
-
colnames
¶ Return the column names of the table
-
comment
= None¶ regular expression for comment lines
-
names
= None¶ list of names corresponding to each data column
-
start_line
= None¶ None, int, or a function of
lines
that returns None or int
-
write_comment
= False¶
-
write_spacer_lines
= ['ASCII_TABLE_WRITE_SPACER_LINE']¶
Methods Documentation
-
check_column_names
(self, names, strict_names, guessing)[source]¶ 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
- nameslist
User-supplied list of column names
- strict_namesbool
Whether to impose extra requirements on names
- guessingbool
True if this method is being called while guessing the table format
-
get_cols
(self, lines)[source]¶ 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
- lineslist
List of table lines
-
remove_columns
(self, names)[source]¶ Remove several columns from the table.
- Parameters
- nameslist
A list containing the names of the columns to remove
-
rename_column
(self, name, new_name)[source]¶ Rename a column.
- Parameters
- namestr
The current name of the column.
- new_namestr
The new name for the column
-