FilesExpand file tree

 master

/

reader.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

107 lines (83 loc) · 2.65 KB

 master

/

reader.py

Copy path

Top

File metadata and controls

• Code
• Blame

107 lines (83 loc) · 2.65 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

"""API for reading notebooks.

Authors:

* Jonathan Frederic

"""

#-----------------------------------------------------------------------------

# Copyright (C) 2013 The IPython Development Team

#

# Distributed under the terms of the BSD License. The full license is in

# the file COPYING, distributed as part of this software.

#-----------------------------------------------------------------------------

#-----------------------------------------------------------------------------

# Imports

#-----------------------------------------------------------------------------

import json

from . import v1

from . import v2

from . import v3

versions = {

1: v1,

2: v2,

3: v3,

}

#-----------------------------------------------------------------------------

# Code

#-----------------------------------------------------------------------------

class NotJSONError(ValueError):

pass

def parse_json(s, **kwargs):

"""Parse a JSON string into a dict."""

try:

nb_dict = json.loads(s, **kwargs)

except ValueError:

# Limit the error message to 80 characters. Display whatever JSON will fit.

raise NotJSONError(("Notebook does not appear to be JSON: %r" % s)[:77] + "...")

return nb_dict

# High level API

def get_version(nb):

"""Get the version of a notebook.

Parameters

----------

nb : dict

NotebookNode or dict containing notebook data.

Returns

-------

Tuple containing major (int) and minor (int) version numbers

"""

major = nb.get('nbformat', 1)

minor = nb.get('nbformat_minor', 0)

return (major, minor)

def reads(s, **kwargs):

"""Read a notebook from a json string and return the

NotebookNode object.

This function properly reads notebooks of any version. No version

conversion is performed.

Parameters

----------

s : unicode

The raw unicode string to read the notebook from.

Returns

-------

nb : NotebookNode

The notebook that was read.

"""

nb_dict = parse_json(s, **kwargs)

(major, minor) = get_version(nb_dict)

if major in versions:

return versions[major].to_notebook_json(nb_dict, minor=minor)

else:

raise NBFormatError('Unsupported nbformat version %s' % major)

def read(fp, **kwargs):

"""Read a notebook from a file and return the NotebookNode object.

This function properly reads notebooks of any version. No version

conversion is performed.

Parameters

----------

fp : file

Any file-like object with a read method.

Returns

-------

nb : NotebookNode

The notebook that was read.

"""

return reads(fp.read(), **kwargs)