ipynbdiff 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0839dd5e5fbcdf19b5525d859fa7d224ec1bb647d7131f9cc20487190ccea80
-  data.tar.gz: ca32de2c784712f66f2f1c8b5642b32fca0078eae0279c8b30f975216101d143
+  metadata.gz: 54c011ed4790dc548b33d6e4773bb9bbdaedd7b8c1ffbdbcfa5e494e5380b1a9
+  data.tar.gz: 70f78c722ddc432576ec52d55617e4ce5bdf29cb7ff32ad46219ac52d0d6f5d5
 SHA512:
-  metadata.gz: 45353d2e38a4378cb5f785edb6b38d250bf38ce4934f8943dcbe08973e4c187942449d185d4a3af59649d9459c74071475b33f23033c192b4345b24f95a2fd78
-  data.tar.gz: 7d8df2c34356018dfe098c0f36e8fb8f3c189c8121411826b9923b406ead730856a9e46ca57124b4e4e23e0409e1fdf83c5785686ab6aa0254bcedca07b95246
+  metadata.gz: 757f9ea284f358771835db2e27ebe90cb5c8c99336313a65d04cbd0080c0891e1c25af79740cb4d191eeafec10e66c74baceef1ba24729b6ba6f743d502564fa
+  data.tar.gz: 35866e056ae8f4ab043bd9cc247f6c3f8dc3b02d475e94221ca11352badf1e96cf840e8020553ffa8c32b1359f967c74ccc67e0f4abda376e8a035d027871daf

data/README.md

@@ -1,3 +1,58 @@
-# rb-ipynbdiff: Better Jupyter Notebook diffs, in Ruby
+# IpynbDiff: Better diff for Jupyter Notebooks
 
-This is a port of [ipynbdiff](https://gitlab.com/gitlab-org/incubation-engineering/mlops/ipynbdiff)
+This is a simple diff tool that cleans up jupyter notebooks, transforming each [notebook](example/1/from.ipynb)
+into a [readable markdown file](example/1/from_html.md), keeping the output of cells, and running the
+diff after. Markdowns are generated using an opinionated Jupyter to Markdown conversion. This means
+that the entire file is readable on the diff.
+
+The result are diffs that are much easier to read:
+
+| Diff | IpynbDiff - HTML | IpynbDiff - Percent |  
+| ------ | ------ | ------ |
+| [Here](example/diff.txt) | [Here](example/ipynbdiff.txt) | [Here](example/ipynbdiff_percent.txt) |
+| ![](example/img/diff.png) | ![](example/img/ipynbdiff_html.png) | ![](example/img/ipynbdiff_percent.png) | 
+
+
+This started as a port of This is a port of [ipynbdiff](https://gitlab.com/gitlab-org/incubation-engineering/mlops/ipynbdiff), 
+but now has extended functionality although not working as git driver.
+
+## Usage
+
+### Generating diffs
+
+```ruby
+IpynbDiff.diff(from_path, to_path, options)
+```
+
+Options:
+
+```ruby
+@default_transform_options = {
+  preprocess_input: TRUE, # Whether the input should be transformed
+  write_output_to: nil, # Pass a path to save the output to a file
+  format: :text, # These are the formats Diffy accepts https://github.com/samg/diffy
+  sources_are_files: FALSE, # Weather to use the from/to as string or path to a file 
+  raise_if_invalid_notebook: FALSE, # Raises an error if the notebooks are invalid, otherwise returns nil 
+  transform_options: @default_transform_options, # See below for transform options
+  diff_opts: {
+    include_diff_info: FALSE # These are passed to Diffy https://github.com/samg/diffy
+  }
+} 
+```
+
+### Transforming the notebooks
+
+It might be necessary to have the transformed files in addition to the diff.
+
+```ruby
+IpynbDiff.transform(notebook, options)
+```
+
+Options:
+
+```ruby
+@default_transform_options = {
+    include_metadata: FALSE, # Whether to include or not the notebook metadata (kernel, language, etc)
+    cell_decorator: :html # :html is useful to add styling with css, :percent is better for text format
+}
+```

data/ipynbdiff.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ipynbdiff'
-  s.version     = '0.3.1'
-  s.summary     = 'Human Readble diffs for Jupyter Notebooks'
-  s.description = 'A simple hello world gem'
+  s.version     = '0.3.5'
+  s.summary     = 'Human Readable diffs for Jupyter Notebooks'
+  s.description = 'Better diff for Jupyter Notebooks by first preprocessing them and removing clutter'
   s.authors     = ['Eduardo Bonet']
   s.email       = 'ebonet@gitlab.com'
   # Specify which files should be added to the gem when it is released.

data/lib/ipynbdiff.rb

@@ -2,41 +2,57 @@
 
 # Human Readable Jupyter Diffs
 module IpynbDiff
-  require 'transformer.rb'
+  require 'transformer'
   require 'diffy'
 
-  @default_options = {
+  @default_transform_options = {
+    include_metadata: FALSE,
+    cell_decorator: :html
+  }
+
+  @default_diff_options = {
     preprocess_input: TRUE,
     write_output_to: nil,
     format: :text,
     sources_are_files: FALSE,
+    raise_if_invalid_notebook: FALSE,
+    transform_options: @default_transform_options,
     diff_opts: {
       include_diff_info: FALSE
     }
   }.freeze
 
-  def self.prepare_input(to_prepare, load_from_file, preprocess)
-    prepared = to_prepare
-    prepared = File.read(prepared) if load_from_file
-    prepared = Transformer.transform(prepared) if preprocess
+  def self.prepare_input(to_prepare, options)
+    return '' unless to_prepare
 
-    prepared
+    prep = to_prepare
+    prep = File.read(prep) if options[:sources_are_files]
+    prep = transform(prep, raise_errors: TRUE, options: options[:transform_options]) if options[:preprocess_input]
+    prep
   end
 
   def self.diff(
     from_notebook,
     to_notebook,
-    options = {}
+    options = @default_diff_options
   )
-    options = @default_options.merge(options)
+    options = @default_diff_options.merge(options)
 
-    from = prepare_input(from_notebook, options[:sources_are_files], options[:preprocess_input])
-    to = prepare_input(to_notebook, options[:sources_are_files], options[:preprocess_input])
+    from = prepare_input(from_notebook, options)
+    to = prepare_input(to_notebook, options)
 
     d = Diffy::Diff.new(from, to, **options[:diff_opts]).to_s(options[:format])
-
     File.write(options[:write_output_to], d) if options[:write_output_to]
-
     d
+  rescue InvalidNotebookError
+    raise if options[:raise_if_invalid_notebook]
+  end
+
+  def self.transform(notebook, raise_errors: FALSE, options: @default_transform_options)
+    options = @default_transform_options.merge(options)
+
+    Transformer.new(**options).transform(notebook)
+  rescue InvalidNotebookError
+    raise if raise_errors
   end
 end

data/lib/transformer.rb

@@ -1,93 +1,119 @@
 # frozen_string_literal: true
 
 module IpynbDiff
+  class InvalidNotebookError < StandardError
+  end
+
   # Returns a markdown version of the Jupyter Notebook
   class Transformer
     require 'json'
     require 'yaml'
 
-    def self.transform(notebook, include_metadata: TRUE)
+    @cell_decorator = :html
+    @include_metadata = TRUE
+
+    def initialize(include_metadata: TRUE, cell_decorator: :html)
+      @include_metadata = include_metadata
+      @cell_decorator = cell_decorator
+    end
+
+    def validate_notebook(notebook)
       notebook_json = JSON.parse(notebook)
-      transformed_blocks = notebook_json['cells'].map { |cell| transform_cell(cell, notebook_json) }
-      transformed_blocks.prepend(transform_metadata(notebook_json)) if include_metadata
+
+      return notebook_json if notebook_json.key?('cells') && notebook_json.key?('metadata')
+
+      raise InvalidNotebookError
+    rescue JSON::ParserError
+      raise InvalidNotebookError
+    end
+
+    def transform(notebook)
+      notebook_json = validate_notebook(notebook)
+      transformed_blocks = notebook_json['cells'].map do |cell|
+        decorate_cell(transform_cell(cell, notebook_json), cell)
+      end
+
+      transformed_blocks.prepend(transform_metadata(notebook_json)) if @include_metadata
       transformed_blocks.join("\n")
     end
 
-    def self.transform_cell(cell, notebook)
+    def decorate_cell(rows, cell)
+      tags = cell['metadata']&.fetch('tags', [])
+      type = cell['cell_type'] || 'raw'
+
+      case @cell_decorator
+      when :html
+        rows.prepend(%(<div class="cell #{type}" data-id="#{cell['id']}" data-tags="#{tags&.join(' ')}">\n\n))
+            .append("\n</div>\n")
+      when :percent
+        rows.prepend(%(%% Cell type:#{type} id:#{cell['id']} tags:#{tags&.join(',')}\n\n))
+      else
+        rows
+      end.join('')
+    end
+
+    def transform_cell(cell, notebook)
       cell['cell_type'] == 'code' ? transform_code_cell(cell, notebook) : transform_text_cell(cell)
     end
 
-    def self.transform_code_cell(cell, notebook)
-      tags = cell['metadata'].fetch('tags', []).join(' ')
+    def decorate_output(output_rows, output)
+      if @cell_decorator == :html
+        output_rows.prepend(%(\n<div class="output #{output['output_type']}">\n\n)).append("\n</div>\n")
+      else
+        output_rows.prepend(%(\n%%%% Output: #{output['output_type']}\n\n))
+      end
+    end
 
+    def transform_code_cell(cell, notebook)
       [
-        %(<div class="cell code" data-id="#{cell['id']}" data-tags="#{tags}">\n\n),
         %(``` #{notebook['metadata']['kernelspec']['language']}\n),
         *cell['source'],
         "\n```\n",
-        *cell['outputs'].map { |output| transform_output(output) },
-        "\n</div>\n"
-      ].join('')
+        *cell['outputs'].map { |output| transform_output(output) }
+      ]
     end
 
-    def self.format_traceback(traceback)
+    def format_traceback(traceback)
       traceback.map do |t|
         t.split("\n").map do |line|
-          line.gsub(/\[[0-9][0-9;]*m/, '').sub("\u001B", '    ').gsub(/\u001B/, '').rstrip
+          line.gsub(/\[[0-9][0-9;]*m/, '').sub("\u001B", '    ').gsub(/\u001B/, '').rstrip << "\n"
         end
-      end.join("\n")
+      end
     end
 
-    def self.transform_execute_result(output)
-      [
-        %(\n<div class="output execute_result">\n\n),
-        *output['data']['text/plain'].map { |line| "    #{line}" },
-        "\n\n</div>\n"
-      ].join('')
+    def transform_execute_result(output)
+      output['data']['text/plain'].map { |line| "    #{line}" }.append("\n")
     end
 
-    def self.transform_image_result(output)
+    def transform_image_result(output)
       if output['data'].key?('image/png')
-        [
-          %(\n<div class="output display_data">\n\n),
-          "![](data:image/png;base64,#{output['data']['image/png'].gsub("\n", '')})",
-          "\n\n</div>\n"
-        ].join('')
+        ["![](data:image/png;base64,#{output['data']['image/png'].gsub("\n", '')})", "\n"]
       end
     end
 
-    def self.transform_error_result(output)
-      [
-        %(\n<div class="output error">\n\n),
-        format_traceback(output['traceback']),
-        "\n\n</div>\n"
-      ].join('')
+    def transform_error_result(output)
+      format_traceback(output['traceback'])
     end
 
-    def self.transform_output(output)
-      case output['output_type']
-      when 'execute_result'
-        transform_execute_result(output)
-      when 'display_data'
-        transform_image_result(output)
-      when 'error'
-        transform_error_result(output)
-      end
-    end
+    def transform_output(output)
+      transformed =
+        case output['output_type']
+        when 'execute_result'
+          transform_execute_result(output)
+        when 'display_data'
+          transform_image_result(output)
+        when 'error'
+          transform_error_result(output)
+        end
 
-    def self.transform_text_cell(cell)
-      tags = cell['metadata'].fetch('tags', []).join(' ')
-      id = cell['id']
-      cell_type = cell['cell_type']
+      decorate_output(transformed, output).join('') if transformed
+    end
 
-      [
-        %(<div class="cell #{cell_type}" data-id="#{id}" data-tags="#{tags}">\n\n),
-        *cell['source'],
-        "\n\n</div>\n"
-      ].join('')
+    def transform_text_cell(cell)
+      cell['source'].append("\n")
     end
 
-    def self.transform_metadata(notebook_json)
+    def transform_metadata(notebook_json)
       {
         'jupyter' => {
           'kernelspec' => notebook_json['metadata']['kernelspec'],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipynbdiff
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors:
 - Eduardo Bonet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -108,7 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple hello world gem
+description: Better diff for Jupyter Notebooks by first preprocessing them and removing
+  clutter
 email: ebonet@gitlab.com
 executables: []
 extensions: []
@@ -143,5 +144,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Human Readble diffs for Jupyter Notebooks
+summary: Human Readable diffs for Jupyter Notebooks
 test_files: []