Merge pull request #147 from plotly/dev

Release 1.1.0

Author: waralex

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2
 jobs:
 
   test:
-    working_directory: ~/dashjl 
+    working_directory: ~/dashjl
     docker:
       - image: plotly/julia:ci
         auth:
@@ -30,15 +30,15 @@ jobs:
       - run:
           name: 🔎 Unit tests
           command: |
-            julia test/ci_prepare.jl 
+            julia test/ci_prepare.jl
 
       - run:
           name: ⚙️  Integration tests
           command: |
             python -m venv venv
             . venv/bin/activate
             git clone --depth 1 https://github.com/plotly/dash.git -b dev dash-main
-            cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ~/dashjl 
+            cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ~/dashjl
             export PATH=$PATH:/home/circleci/.local/bin/
             pytest --headless --nopercyfinalize --junitxml=test-reports/dashjl.xml --percy-assets=test/assets/ test/integration/
       - store_artifacts:
@@ -51,7 +51,6 @@ jobs:
       - run:
           name: 🦔 percy finalize
           command: npx percy finalize --all
-          when: on_fail
 
 workflows:
   version: 2

Project.toml

@@ -1,9 +1,10 @@
 name = "Dash"
 uuid = "1b08a953-4be3-4667-9a23-3db579824955"
 authors = ["Chris Parmer <chris@plotly.com>", "Alexandr Romanenko <waralex@gmail.com>"]
-version = "1.0.0"
+version = "1.1.0"
 
 [deps]
+Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
 DashBase = "03207cf0-e2b3-4b91-9ca8-690cf0fb507e"
 DashCoreComponents = "1b08a953-4be3-4667-9a23-9da06441d987"
@@ -12,7 +13,7 @@ DashTable = "1b08a953-4be3-4667-9a23-f0e2ba4deb9a"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
-JSON2 = "2535ab7d-5cd8-5a07-80ac-9b1792aadce3"
+JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
 MD5 = "6ac74813-4b46-53a4-afec-0b5dc9d7885c"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PlotlyBase = "a03496cd-edff-5a9b-9e67-9cda94a718b5"
@@ -30,11 +31,11 @@ DashTable = "5.0.0"
 DataStructures = "0.17, 0.18"
 HTTP = "0.8.10, 0.9"
 JSON = "0.21"
-JSON2 = "0.3"
+JSON3 = "1.9"
 MD5 = "0.2"
 PlotlyBase = "0.8.5, 0.8.6"
-julia = "1.3"
 YAML = "0.4.7"
+julia = "1.3"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -10,8 +10,6 @@ As of v1.15.0 of Dash, Julia components can be generated in tandem with Python a
 
 #### Create beautiful, analytic applications in Julia
 
-🚧 Dash.jl is a work-in-progress. Feel free to test the waters and submit issues.
-
 Built on top of Plotly.js, React and HTTP.jl, [Dash](https://plotly.com/dash/) ties modern UI elements like dropdowns, sliders, and graphs directly to your analytical Julia code.
 
 ## Installation
@@ -191,6 +189,5 @@ Be careful - in Dash.jl states come first in an arguments list.
 
 ### JSON:
 
-I use JSON2.jl for JSON serialization/deserialization, so in callbacks all JSON objects are `NamedTuples` rather than dictionaries. Within component properties you can use both `Dict` and `NamedTuple` for JSON objects.
-
+I use JSON3.jl for JSON serialization/deserialization.
 Note when declaring elements with a single properly that `layout = (title = "Test graph")` is not interpreted as a `NamedTuple` by Julia  - you'll need to add a comma when declaring the layout, e.g. `layout = (title = "Test graph",)`

docs/src/index.md

@@ -174,4 +174,4 @@ Be careful - in Dashboards states came first in arguments list
 
 ### json:
 
-I use JSON2 for json serialization/deserialization, so in callbacks all json objects are NamedTuples not Dicts. In component props you can use both Dicts and NamedTuples for json objects. But be careful with single property objects: `layout = (title = "Test graph")` is not interpreted as NamedTuple by Julia  - you need add comma at the end `layout = (title = "Test graph",)`
+I use JSON3 for json serialization/deserialization. In component props you can use both Dicts and NamedTuples for json objects. But be careful with single property objects: `layout = (title = "Test graph")` is not interpreted as NamedTuple by Julia  - you need add comma at the end `layout = (title = "Test graph",)`

src/Dash.jl

@@ -1,8 +1,9 @@
 module Dash
 using DashBase
-import HTTP, JSON2, CodecZlib, MD5
+import HTTP, JSON3, CodecZlib, MD5
 using Sockets
 using Pkg.Artifacts
+
 const ROOT_PATH = realpath(joinpath(@__DIR__, ".."))
 #const RESOURCE_PATH = realpath(joinpath(ROOT_PATH, "resources"))
 include("exceptions.jl")
@@ -25,6 +26,8 @@ include("resources/application.jl")
 include("handlers.jl")
 include("server.jl")
 include("init.jl")
+include("components_utils/_components_utils.jl")
+include("plotly_base.jl")
 
 @doc """
     module Dash
@@ -107,6 +110,8 @@ function __init__()
 end
 
 
+JSON3.StructTypes.StructType(::Type{DashBase.Component}) = JSON3.StructTypes.Struct()
+JSON3.StructTypes.excludes(::Type{DashBase.Component}) = (:name, :available_props, :wildcard_regex)
 
 
-end # module
+end # module

src/app/callbacks.jl

@@ -165,21 +165,11 @@ function check_callback(func, app::DashApp, deps::CallbackDeps)
     isempty(deps.output) && error("The callback method requires that one or more properly formatted outputs are passed.")
     isempty(deps.input) && error("The callback method requires that one or more properly formatted inputs are passed.")
 
-    !check_unique(deps.output) && error("One or more callback outputs have been duplicated; please confirm that all outputs are unique.")
-
-    for out in deps.output
-        if any(x->out in x.dependencies.output, values(app.callbacks))
-            error("output \"$(out)\" already registered")
-        end
-    end
 
     args_count = length(deps.state) + length(deps.input)
 
     check_callback_func(func, args_count)
 
-    for id_prop in deps.input
-        id_prop in deps.output && error("Circular input and output arguments were found. Please verify that callback outputs are not also input arguments.")
-    end
 end
 
 function check_callback_func(func::Function, args_count)

src/app/supporttypes.jl

@@ -2,7 +2,9 @@ struct Wildcard
     type ::Symbol
 end
 
-JSON2.write(io::IO, wild::Wildcard; kwargs...) = Base.write(io, "[\"", wild.type, "\"]")
+JSON3.StructTypes.StructType(::Type{Wildcard}) = JSON3.RawType()
+
+JSON3.rawbytes(wild::Wildcard) = string("[\"", wild.type, "\"]")
 
 const MATCH = Wildcard(:MATCH)
 const ALL = Wildcard(:ALL)
@@ -30,6 +32,8 @@ const Input = Dependency{TraitInput}
 const State = Dependency{TraitState}
 const Output = Dependency{TraitOutput}
 
+JSON3.StructTypes.StructType(::Type{<:Dependency}) = JSON3.StructTypes.Struct()
+
 """
     Base.==(a::Dependency, b::Dependency)
 
@@ -97,6 +101,9 @@ struct ClientsideFunction
     namespace ::String
     function_name ::String
 end
+
+JSON3.StructTypes.StructType(::Type{ClientsideFunction}) = JSON3.StructTypes.Struct()
+
 struct Callback
     func ::Union{Function, ClientsideFunction}
     dependencies ::CallbackDeps

src/components_utils/_components_utils.jl

@@ -0,0 +1,2 @@
+include("express.jl")
+include("table_format.jl")

src/components_utils/express.jl

@@ -0,0 +1,102 @@
+import Base64
+export dcc_send_file, dcc_send_string, dcc_send_bytes
+"""
+    dbc_send_file(path::AbstractString, filename = nothing; type = nothing)
+
+Convert a file into the format expected by the Download component.
+
+# Arguments
+- `path` - path to the file to be sent
+- `filename` - name of the file, if not provided the original filename is used
+- `type` - type of the file (optional, passed to Blob in the javascript layer)
+"""
+function dcc_send_file(path, filename = nothing; type = nothing)
+    filename = isnothing(filename) ? basename(path) : filename
+    return dcc_send_bytes(read(path), filename, type = type)
+end
+
+"""
+    dcc_send_bytes(src::AbstractVector{UInt8}, filename; type = nothing)
+    dcc_send_bytes(writer::Function, data, filename; type = nothing)
+
+Convert vector of bytes into the format expected by the Download component.
+`writer` function must have signature `(io::IO, data)`
+
+# Examples
+
+Sending binary content
+```julia
+file_data = read("path/to/file")
+callback!(app, Output("download", "data"), Input("download-btn", "n_clicks"), prevent_initial_call = true) do n_clicks
+    return dcc_send_bytes(file_data, "filename.fl")
+end
+```
+
+Sending `DataFrame` in `Arrow` format
+```julia
+using DataFrames, Arrow
+...
+df = DataFrame(...)
+callback!(app, Output("download", "data"), Input("download-btn", "n_clicks"), prevent_initial_call = true) do n_clicks
+    return dcc_send_bytes(Arrow.write, df, "df.arr")
+end
+```
+"""
+function dcc_send_bytes(src::AbstractVector{UInt8}, filename; type = nothing)
+
+    return Dict(
+        :content => Base64.base64encode(src),
+        :filename => filename,
+        :type => type,
+        :base64 => true
+    )
+end
+
+function dcc_send_bytes(writer::Function, data, filename; type = nothing)
+    io = IOBuffer()
+    writer(io, data)
+    return dcc_send_bytes(take!(io), filename, type = type)
+end
+
+"""
+    dcc_send_data(src::AbstractString, filename; type = nothing)
+    dcc_send_data(writer::Function, data, filename; type = nothing)
+
+Convert string into the format expected by the Download component.
+`writer` function must have signature `(io::IO, data)`
+
+# Examples
+
+Sending string content
+```julia
+text_data = "this is the test"
+callback!(app, Output("download", "data"), Input("download-btn", "n_clicks"), prevent_initial_call = true) do n_clicks
+    return dcc_send_string(text_data, "text.txt")
+end
+```
+
+Sending `DataFrame` in `CSV` format
+```julia
+using DataFrames, CSV
+...
+df = DataFrame(...)
+callback!(app, Output("download", "data"), Input("download-btn", "n_clicks"), prevent_initial_call = true) do n_clicks
+    return dcc_send_string(CSV.write, df, "df.csv")
+end
+```
+"""
+function dcc_send_string(src::AbstractString, filename; type = nothing)
+
+    return Dict(
+        :content => src,
+        :filename => filename,
+        :type => type,
+        :base64 => false
+    )
+end
+
+function dcc_send_string(writer::Function, data, filename; type = nothing)
+    io = IOBuffer()
+    writer(io, data)
+    return dcc_send_string(String(take!(io)), filename, type = type)
+end