Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.9/dist-packages/scipy/io/matlab/__init__.py: 11%

1""" 

2MATLAB® file utilities (:mod:`scipy.io.matlab`) 

3=============================================== 

4 

5.. currentmodule:: scipy.io.matlab 

6 

7This submodule is meant to provide lower-level file utilities related to reading 

8and writing MATLAB files. 

9 

10.. autosummary:: 

11 :toctree: generated/ 

12 

13 matfile_version - Get the MATLAB file version 

14 MatReadError - Exception indicating a read issue 

15 MatReadWarning - Warning class for read issues 

16 MatWriteError - Exception indicating a write issue 

17 mat_struct - Class used when ``struct_as_record=False`` 

18 

19.. autosummary:: 

20 :toctree: generated/ 

21 :template: autosummary/ndarray_subclass.rst 

22 :nosignatures: 

23 

24 MatlabObject - Class for a MATLAB object 

25 MatlabOpaque - Class for a MATLAB opaque matrix 

26 MatlabFunction - Class for a MATLAB function object 

27 

28The following utilities that live in the :mod:`scipy.io` 

29namespace also exist in this namespace: 

30 

31.. autosummary:: 

32 :toctree: generated/ 

33 

34 loadmat - Read a MATLAB style mat file (version 4 through 7.1) 

35 savemat - Write a MATLAB style mat file (version 4 through 7.1) 

36 whosmat - List contents of a MATLAB style mat file (version 4 through 7.1) 

37 

38Notes 

39----- 

40MATLAB(R) is a registered trademark of The MathWorks, Inc., 3 Apple Hill 

41Drive, Natick, MA 01760-2098, USA. 

42 

43""" 

44# Matlab file read and write utilities 

45from ._mio import loadmat, savemat, whosmat 

46from ._mio5 import MatlabFunction 

47from ._mio5_params import MatlabObject, MatlabOpaque, mat_struct 

48from ._miobase import (matfile_version, MatReadError, MatReadWarning, 

49 MatWriteError) 

50 

51# Deprecated namespaces, to be removed in v2.0.0 

52from .import (mio, mio5, mio5_params, mio4, byteordercodes, 

53 miobase, mio_utils, streams, mio5_utils) 

54 

55__all__ = [ 

56 'loadmat', 'savemat', 'whosmat', 'MatlabObject', 

57 'matfile_version', 'MatReadError', 'MatReadWarning', 

58 'MatWriteError', 'mat_struct', 'MatlabOpaque', 'MatlabFunction' 

59] 

60 

61from scipy._lib._testutils import PytestTester 

62test = PytestTester(__name__) 

63del PytestTester