Utils
- class astrophysix.utils.file.FileType(value)
File type enum
Example
>>> ft = FileType.ASCII_FILE >>> ft.alias "ASCII" >>> ft.extension_list [".dat", ".DAT", ".txt", ".TXT", ".ini", ".INI"]
- ASCII_FILE = ('ASCII', ['.dat', '.DAT', '.txt', '.TXT', '.ini', '.INI'])
- CSV_FILE = ('CSV', ['.csv', '.CSV'])
- FITS_FILE = ('FITS', ['.fits', '.FITS'])
- HDF5_FILE = ('HDF5', ['.h5', '.H5', '.hdf5', '.HDF5'])
- JPEG_FILE = ('JPEG', ['.jpg', '.jpeg', '.JPG', '.JPEG'])
- JSON_FILE = ('JSON', ['.json', '.JSON'])
- PICKLE_FILE = ('PICKLE', ['.pkl', '.PKL', '.pickle', '.sav', '.save'])
- PNG_FILE = ('PNG', ['.png', '.PNG'])
- TARGZ_FILE = ('TARGZ', ['.tar.gz', '.TAR.GZ', '.TAR.gz', '.tar.GZ', '.tgz', '.TGZ'])
- XML_FILE = ('XML', ['.xml', '.XML'])
- YAML_FILE = ('YAML', ['.yml', '.YML', '.yaml', '.YAML'])
- __unicode__()
String representation of the enum value. Returns alias.
- property alias
Returns file type alias
- property default_extension
Returns the first item in the file type extension list
- property extension_list
Returns file type valid extension list
- property file_regexp
Returns filename matching regular expression for the current file type
- classmethod from_alias(alias)
Find a FileType according to its alias
- Parameters:
alias (
string
) – required file type alias- Returns:
ft – File type matching the requested alias.
- Return type:
- Raises:
ValueError – if requested alias does not match any file type.
Example
>>> ft = FileType.from_alias("PNG") >>> ft.extension_list [".png", ".PNG"] >>> ft2 = FileType.from_alias("MY_UNKNOWN_FILETYPE") ValuerError: No FileType defined with the alias 'MY_UNKNOWN_FILETYPE'.