_byteordercodes.py 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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. import sys
  7. __all__ = [
  8. 'aliases', 'native_code', 'swapped_code',
  9. 'sys_is_le', 'to_numpy_code'
  10. ]
  11. sys_is_le = sys.byteorder == 'little'
  12. native_code = sys_is_le and '<' or '>'
  13. swapped_code = sys_is_le and '>' or '<'
  14. aliases = {'little': ('little', '<', 'l', 'le'),
  15. 'big': ('big', '>', 'b', 'be'),
  16. 'native': ('native', '='),
  17. 'swapped': ('swapped', 'S')}
  18. def to_numpy_code(code):
  19. """
  20. Convert various order codings to NumPy format.
  21. Parameters
  22. ----------
  23. code : str
  24. The code to convert. It is converted to lower case before parsing.
  25. Legal values are:
  26. 'little', 'big', 'l', 'b', 'le', 'be', '<', '>', 'native', '=',
  27. 'swapped', 's'.
  28. Returns
  29. -------
  30. out_code : {'<', '>'}
  31. Here '<' is the numpy dtype code for little endian,
  32. and '>' is the code for big endian.
  33. Examples
  34. --------
  35. >>> import sys
  36. >>> sys_is_le == (sys.byteorder == 'little')
  37. True
  38. >>> to_numpy_code('big')
  39. '>'
  40. >>> to_numpy_code('little')
  41. '<'
  42. >>> nc = to_numpy_code('native')
  43. >>> nc == '<' if sys_is_le else nc == '>'
  44. True
  45. >>> sc = to_numpy_code('swapped')
  46. >>> sc == '>' if sys_is_le else sc == '<'
  47. True
  48. """
  49. code = code.lower()
  50. if code is None:
  51. return native_code
  52. if code in aliases['little']:
  53. return '<'
  54. elif code in aliases['big']:
  55. return '>'
  56. elif code in aliases['native']:
  57. return native_code
  58. elif code in aliases['swapped']:
  59. return swapped_code
  60. else:
  61. raise ValueError(
  62. 'We cannot handle byte order %s' % code)