Package org.sonar.plugins.python

Class IpynbNotebookParser

java.lang.Object

org.sonar.plugins.python.IpynbNotebookParser

public class IpynbNotebookParser
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER

Method Summary

Modifier and Type	Method	Description
Optional<GeneratedIPythonFile>	parse()
Optional<String>	parseLanguage()	Parses the notebook's top-level metadata to find the language.
GeneratedIPythonFile	parseNotebook()
static Optional<GeneratedIPythonFile>	parseNotebook(PythonInputFile inputFile)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER

public static final String SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER

See Also:

• Constant Field Values

Method Details

parseNotebook

public static Optional<GeneratedIPythonFile> parseNotebook(PythonInputFile inputFile)

parse

public Optional<GeneratedIPythonFile> parse()
                                     throws IOException

Throws:

IOException

parseLanguage

public Optional<String> parseLanguage()
                               throws IOException

Parses the notebook's top-level metadata to find the language. Only checks metadata.kernelspec.language and metadata.language_info.name, ignoring any language fields in cell metadata.

Throws:

IOException

parseNotebook

public GeneratedIPythonFile parseNotebook()
                                   throws IOException

Throws:

IOException