Skip to content

nbformat 5.10.4

Download JSON

  • PyPI https://pypi.org/project/nbformat/
    Repository https://github.com/jupyter/nbformat

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 13
    "Any" : 3
    "Untyped" : 580
    • 2.7% coverage
    • 2.2% coverage (strict)
    • 596 typable
      • 13 typed
      • 580 untyped
      • 3 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 333
    "classes" : 239
    "other" : 5
    • 98 functions (+0 overloads)
      • 235 parameters
    • 43 classes
      • 98 methods (+0 overloads)
        • 141 parameters
      • 0 properties
    • 34 modules
      • 5 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
nbformat 0.0% 0.0% 22 0
nbformat._version 0.0% 0.0% 2 1
nbformat.converter 0.0% 0.0% 3 0
nbformat.corpus.words 0.0% 0.0% 1 0
nbformat.current 0.0% 0.0% 34 0
nbformat.json_compat 0.0% 0.0% 19 0
nbformat.notebooknode 0.0% 0.0% 8 0
nbformat.reader 0.0% 0.0% 11 0
nbformat.sentinel 0.0% 0.0% 7 0
nbformat.sign 1.0% 1.0% 102 2
nbformat.v1.convert 0.0% 0.0% 3 0
nbformat.v1.nbbase 0.0% 0.0% 9 0
nbformat.v1.nbjson 0.0% 0.0% 9 0
nbformat.v1.rwbase 0.0% 0.0% 13 0
nbformat.v2 0.0% 0.0% 2 0
nbformat.v2.convert 0.0% 0.0% 5 0
nbformat.v2.nbbase 0.0% 0.0% 44 0
nbformat.v2.nbjson 0.0% 0.0% 11 0
nbformat.v2.nbpy 0.0% 0.0% 16 0
nbformat.v2.nbxml 0.0% 0.0% 9 0
nbformat.v2.rwbase 0.0% 0.0% 23 0
nbformat.v3 0.0% 0.0% 2 0
nbformat.v3.convert 0.0% 0.0% 10 0
nbformat.v3.nbbase 0.0% 0.0% 59 0
nbformat.v3.nbjson 0.0% 0.0% 11 0
nbformat.v3.nbpy 0.0% 0.0% 17 0
nbformat.v3.rwbase 0.0% 0.0% 25 0
nbformat.v4 0.0% 0.0% 0 0
nbformat.v4.convert 0.0% 0.0% 22 0
nbformat.v4.nbbase 0.0% 0.0% 20 0
nbformat.v4.nbjson 0.0% 0.0% 11 0
nbformat.v4.rwbase 0.0% 0.0% 19 0
nbformat.validator 31.9% 25.5% 47 1
nbformat.warnings 0.0% 0.0% 0 0

Incomplete Annotations

nbformat (22 missing, 0 any)

Symbol Typable Typed Any
func write 6 0 0
func writes 5 0 0
func reads 5 0 0
func read 5 0 0
attr NO_CONVERT 1 0 0

nbformat._version (2 missing, 0 any)

Symbol Typable Typed Any
attr version_info 1 0 0
attr version 1 0 0

nbformat.converter (3 missing, 0 any)

Symbol Typable Typed Any
func convert 3 0 0

nbformat.corpus.words (1 missing, 0 any)

Symbol Typable Typed Any
func generate_corpus_id 1 0 0

nbformat.current (34 missing, 0 any)

Symbol Typable Typed Any
func reads_json 3 0 0
func write 5 0 0
func writes 5 0 0
func writes_json 3 0 0
func reads_py 3 0 0
func reads 5 0 0
func read 4 0 0
func parse_py 3 0 0
func writes_py 3 0 0

nbformat.json_compat (19 missing, 0 any)

Symbol Typable Typed Any
func get_current_validator 1 0 0
meth FastJsonSchemaValidator.init 2 0 0
meth FastJsonSchemaValidator.validate 2 0 0
meth FastJsonSchemaValidator.iter_errors 3 0 0
meth FastJsonSchemaValidator.error_tree 2 0 0
meth JsonSchemaValidator.init 2 0 0
meth JsonSchemaValidator.validate 2 0 0
meth JsonSchemaValidator.iter_errors 3 0 0
meth JsonSchemaValidator.error_tree 2 0 0

nbformat.notebooknode (8 missing, 0 any)

Symbol Typable Typed Any
func from_dict 2 0 0
meth NotebookNode.setitem 3 0 0
meth NotebookNode.update 3 0 0

nbformat.reader (11 missing, 0 any)

Symbol Typable Typed Any
func parse_json 3 0 0
func reads 3 0 0
func read 3 0 0
func get_version 2 0 0

nbformat.sentinel (7 missing, 0 any)

Symbol Typable Typed Any
meth Sentinel.init 4 0 0
meth Sentinel.repr 1 0 0
attr Sentinel.name 1 0 0
attr Sentinel.module 1 0 0

nbformat.sign (101 missing, 0 any)

Symbol Typable Typed Any
func signature_removed 2 0 0
func convert_datetime 2 0 0
meth SignatureStore.store_signature 3 0 0
meth SignatureStore.check_signature 3 0 0
meth SignatureStore.remove_signature 3 0 0
meth SignatureStore.close 1 0 0
meth TrustNotebookApp._config_file_name_default 1 0 0
meth TrustNotebookApp._notary_default 1 0 0
meth TrustNotebookApp.sign_notebook_file 2 0 0
meth TrustNotebookApp.sign_notebook 3 0 0
meth TrustNotebookApp.generate_new_key 1 0 0
meth TrustNotebookApp.start 1 0 0
attr TrustNotebookApp.reset 1 0 0
attr TrustNotebookApp.notary 1 0 0
meth MemorySignatureStore.init 1 0 0
meth MemorySignatureStore.store_signature 3 0 0
meth MemorySignatureStore._maybe_cull 1 0 0
meth MemorySignatureStore.check_signature 3 0 0
meth MemorySignatureStore.remove_signature 3 0 0
attr MemorySignatureStore.data 1 0 0
func adapt_datetime_iso 2 0 0
meth NotebookNotary._data_dir_default 1 0 0
meth NotebookNotary._store_factory_default 1 0 0
meth NotebookNotary._db_file_default 1 0 0
meth NotebookNotary._algorithm_changed 2 0 0
meth NotebookNotary._digestmod_default 1 0 0
meth NotebookNotary._secret_file_default 1 0 0
meth NotebookNotary._secret_default 1 0 0
meth NotebookNotary.init 2 0 0
meth NotebookNotary._write_secret_file 2 0 0
meth NotebookNotary.compute_signature 2 0 0
meth NotebookNotary.check_signature 2 0 0
meth NotebookNotary.sign 2 0 0
meth NotebookNotary.unsign 2 0 0
meth NotebookNotary.mark_cells 3 0 0
meth NotebookNotary._check_cell 3 0 0
meth NotebookNotary.check_cells 2 0 0
attr NotebookNotary.data_dir 1 0 0
attr NotebookNotary.store_factory 1 0 0
attr NotebookNotary.db_file 1 0 0
attr NotebookNotary.algorithm 1 0 0
attr NotebookNotary.digestmod 1 0 0
attr NotebookNotary.secret_file 1 0 0
attr NotebookNotary.secret 1 0 0
attr NotebookNotary.store 1 0 0
func yield_code_cells 2 0 0
meth SQLiteSignatureStore.init 3 0 0
meth SQLiteSignatureStore.close 1 0 0
meth SQLiteSignatureStore._connect_db 2 0 0
meth SQLiteSignatureStore.init_db 2 0 0
meth SQLiteSignatureStore.store_signature 3 0 0
meth SQLiteSignatureStore.check_signature 3 0 0
meth SQLiteSignatureStore.remove_signature 3 0 0
meth SQLiteSignatureStore.cull_db 1 0 0
attr SQLiteSignatureStore.cache_size 1 0 0
attr SQLiteSignatureStore.db_file 1 0 0
attr SQLiteSignatureStore.db 1 0 0
func yield_everything 2 0 0
attr algorithms 1 0 0

nbformat.v1.convert (3 missing, 0 any)

Symbol Typable Typed Any
func upgrade 3 0 0

nbformat.v1.nbbase (9 missing, 0 any)

Symbol Typable Typed Any
func from_dict 2 0 0
func new_text_cell 2 0 0
func new_code_cell 3 0 0
func new_notebook 2 0 0

nbformat.v1.nbjson (9 missing, 0 any)

Symbol Typable Typed Any
meth JSONWriter.writes 3 0 0
meth JSONReader.reads 3 0 0
meth JSONReader.to_notebook 3 0 0

nbformat.v1.rwbase (13 missing, 0 any)

Symbol Typable Typed Any
meth NotebookWriter.writes 3 0 0
meth NotebookWriter.write 4 0 0
meth NotebookReader.reads 3 0 0
meth NotebookReader.read 3 0 0

nbformat.v2 (2 missing, 0 any)

Symbol Typable Typed Any
func parse_filename 2 0 0

nbformat.v2.convert (5 missing, 0 any)

Symbol Typable Typed Any
func upgrade 3 0 0
func downgrade 2 0 0

nbformat.v2.nbbase (44 missing, 0 any)

Symbol Typable Typed Any
func new_output 14 0 0
func from_dict 2 0 0
func new_text_cell 4 0 0
func new_worksheet 3 0 0
func new_code_cell 6 0 0
func new_metadata 7 0 0
func new_author 5 0 0
func new_notebook 3 0 0

nbformat.v2.nbjson (11 missing, 0 any)

Symbol Typable Typed Any
meth BytesEncoder.default 2 0 0
meth JSONReader.reads 3 0 0
meth JSONReader.to_notebook 3 0 0
meth JSONWriter.writes 3 0 0

nbformat.v2.nbpy (16 missing, 0 any)

Symbol Typable Typed Any
meth PyWriter.writes 3 0 0
meth PyReader.reads 3 0 0
meth PyReader.to_notebook 3 0 0
meth PyReader.new_cell 3 0 0
meth PyReader._remove_comments 2 0 0
meth PyReader.split_lines_into_blocks 2 0 0

nbformat.v2.nbxml (9 missing, 0 any)

Symbol Typable Typed Any
func to_notebook 3 0 0
func reads 3 0 0
func read 3 0 0

nbformat.v2.rwbase (23 missing, 0 any)

Symbol Typable Typed Any
func rejoin_lines 2 0 0
func base64_encode 2 0 0
meth NotebookWriter.writes 3 0 0
meth NotebookWriter.write 4 0 0
func base64_decode 2 0 0
func split_lines 2 0 0
meth NotebookReader.reads 3 0 0
meth NotebookReader.read 3 0 0
func restore_bytes 2 0 0

nbformat.v3 (2 missing, 0 any)

Symbol Typable Typed Any
func parse_filename 2 0 0

nbformat.v3.convert (10 missing, 0 any)

Symbol Typable Typed Any
func upgrade 4 0 0
func downgrade 2 0 0
func raw_to_md 2 0 0
func heading_to_md 2 0 0

nbformat.v3.nbbase (59 missing, 0 any)

Symbol Typable Typed Any
func new_output 16 0 0
func new_text_cell 5 0 0
func new_metadata 7 0 0
func new_author 5 0 0
func new_heading_cell 5 0 0
func new_worksheet 4 0 0
func new_code_cell 7 0 0
func new_notebook 4 0 0
func from_dict 2 0 0
func cast_str 2 0 0
func str_passthrough 2 0 0

nbformat.v3.nbjson (11 missing, 0 any)

Symbol Typable Typed Any
meth BytesEncoder.default 2 0 0
meth JSONReader.reads 3 0 0
meth JSONReader.to_notebook 3 0 0
meth JSONWriter.writes 3 0 0

nbformat.v3.nbpy (17 missing, 0 any)

Symbol Typable Typed Any
meth PyWriter.writes 3 0 0
meth PyReader.reads 3 0 0
meth PyReader.to_notebook 3 0 0
meth PyReader.new_cell 4 0 0
meth PyReader._remove_comments 2 0 0
meth PyReader.split_lines_into_blocks 2 0 0

nbformat.v3.rwbase (25 missing, 0 any)

Symbol Typable Typed Any
func rejoin_lines 2 0 0
func base64_encode 2 0 0
func strip_transient 2 0 0
meth NotebookWriter.writes 3 0 0
meth NotebookWriter.write 4 0 0
func base64_decode 2 0 0
func split_lines 2 0 0
meth NotebookReader.reads 3 0 0
meth NotebookReader.read 3 0 0
func restore_bytes 2 0 0

nbformat.v4.convert (22 missing, 0 any)

Symbol Typable Typed Any
func upgrade 4 0 0
func downgrade 2 0 0
func upgrade_output 2 0 0
func downgrade_output 2 0 0
func from_mime_key 2 0 0
func upgrade_outputs 2 0 0
func upgrade_cell 2 0 0
func to_mime_key 2 0 0
func downgrade_outputs 2 0 0
func downgrade_cell 2 0 0

nbformat.v4.nbbase (20 missing, 0 any)

Symbol Typable Typed Any
func new_output 4 0 0
func new_raw_cell 3 0 0
func output_from_msg 2 0 0
func new_code_cell 3 0 0
func new_markdown_cell 3 0 0
func new_notebook 2 0 0
func validate 3 0 0

nbformat.v4.nbjson (11 missing, 0 any)

Symbol Typable Typed Any
meth BytesEncoder.default 2 0 0
meth JSONReader.reads 3 0 0
meth JSONReader.to_notebook 3 0 0
meth JSONWriter.writes 3 0 0

nbformat.v4.rwbase (19 missing, 0 any)

Symbol Typable Typed Any
func rejoin_lines 2 0 0
func strip_transient 2 0 0
meth NotebookWriter.writes 3 0 0
meth NotebookWriter.write 4 0 0
func split_lines 2 0 0
meth NotebookReader.reads 3 0 0
meth NotebookReader.read 3 0 0

nbformat.validator (32 missing, 3 any)

Symbol Typable Typed Any
func validate 9 9 2
func isvalid 5 0 0
meth NotebookValidationError.init 3 0 0
meth NotebookValidationError.getattr 2 0 0
meth NotebookValidationError.unicode 1 0 0
meth NotebookValidationError.str 1 0 0
attr NotebookValidationError.original 1 0 0
attr NotebookValidationError.ref 1 0 0
attr NotebookValidationError.message 1 0 0
func better_validation_error 4 0 0
func normalize 6 6 1
func get_validator 5 0 0
func iter_validate 8 0 0

Type-Ignore Comments

Flavor Count
type: ignore[assignment] 1
type: ignore[misc] 1
type: ignore[no-redef] 1
type: ignore[union-attr] 1