byteordercodes.py 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. ''' Byteorder utilities for system - numpy byteorder encoding
  2. Converts a variety of string codes for little endian, big endian,
  3. native byte order and swapped byte order to explicit numpy endian
  4. codes - one of '<' (little endian) or '>' (big endian)
  5. '''
  6. from __future__ import division, print_function, absolute_import
  7. import sys
  8. sys_is_le = sys.byteorder == 'little'
  9. native_code = sys_is_le and '<' or '>'
  10. swapped_code = sys_is_le and '>' or '<'
  11. aliases = {'little': ('little', '<', 'l', 'le'),
  12. 'big': ('big', '>', 'b', 'be'),
  13. 'native': ('native', '='),
  14. 'swapped': ('swapped', 'S')}
  15. def to_numpy_code(code):
  16. """
  17. Convert various order codings to numpy format.
  18. Parameters
  19. ----------
  20. code : str
  21. The code to convert. It is converted to lower case before parsing.
  22. Legal values are:
  23. 'little', 'big', 'l', 'b', 'le', 'be', '<', '>', 'native', '=',
  24. 'swapped', 's'.
  25. Returns
  26. -------
  27. out_code : {'<', '>'}
  28. Here '<' is the numpy dtype code for little endian,
  29. and '>' is the code for big endian.
  30. Examples
  31. --------
  32. >>> import sys
  33. >>> sys_is_le == (sys.byteorder == 'little')
  34. True
  35. >>> to_numpy_code('big')
  36. '>'
  37. >>> to_numpy_code('little')
  38. '<'
  39. >>> nc = to_numpy_code('native')
  40. >>> nc == '<' if sys_is_le else nc == '>'
  41. True
  42. >>> sc = to_numpy_code('swapped')
  43. >>> sc == '>' if sys_is_le else sc == '<'
  44. True
  45. """
  46. code = code.lower()
  47. if code is None:
  48. return native_code
  49. if code in aliases['little']:
  50. return '<'
  51. elif code in aliases['big']:
  52. return '>'
  53. elif code in aliases['native']:
  54. return native_code
  55. elif code in aliases['swapped']:
  56. return swapped_code
  57. else:
  58. raise ValueError(
  59. 'We cannot handle byte order %s' % code)