Skip to content

Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rpkyle merged 4 commits into from
Aug 23, 2019
Merged

Use dev_tools_prune_errors instead of pruned_errors #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
370c79e
rename pruned_errors to prune_errors
rpkyle Aug 12, 2019
f7adc83
rename pruned to prune
rpkyle Aug 12, 2019
a44050a
Provide support for no_update in Dash for R (#111)
rpkyle Aug 13, 2019
1206744
Merge branch 'master' into 112-prune-errors
rpkyle Aug 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions NAMESPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down
18 changes: 12 additions & 6 deletions R/dash.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

output_value <- getStackTrace(do.call(callback, callback_args),
debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

# reset callback context
private$callback_context_ <- NULL

if (is.null(private$stack_message)) {
# inspect the output_value to determine whether any outputs have no_update
# objects within them; these should not be updated
if (length(output_value) == 1 && class(output_value) == "no_update") {
response$body <- character(1) # return empty string
response$status <- 204L
}
else if (is.null(private$stack_message)) {
# pass on output_value to encode_plotly in case there are dccGraph
# components which include Plotly.js figures for which we'll need to
# run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
port = Sys.getenv('DASH_PORT', 8050),
block = TRUE,
showcase = FALSE,
pruned_errors = TRUE,
dev_tools_prune_errors = TRUE,
debug = FALSE,
dev_tools_ui = NULL,
dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
self$config$props_check <- FALSE
}

private$pruned_errors <- pruned_errors
private$prune_errors <- dev_tools_prune_errors
private$debug <- debug

self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

# initialize flags for debug mode and stack pruning,
debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
stack_message = NULL,

# callback context
Expand Down
12 changes: 11 additions & 1 deletion R/dependencies.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#'
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
property = property
)
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
x <- list(NULL)
class(x) <- "no_update"
return(x)
}
4 changes: 2 additions & 2 deletions R/utils.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
if(debug) {
tryCatch(withCallingHandlers(
expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

reverseStack <- rev(calls)

if (pruned_errors) {
if (prune_errors) {
# this line should match the last occurrence of the function
# which raised the error within the call stack; prune here
indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down
7 changes: 7 additions & 0 deletions man/dependencies.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

111 changes: 111 additions & 0 deletions tests/integration/callbacks/test_no_update.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
htmlDiv(list(
dccDropdown(options = list(
list(label = "Red", value = "#FF0000"),
list(label = "Green", value = "#00FF00"),
list(label = "Blue", value = "#0000FF"),
list(label = "Do nothing", value = "nothing")
),
id = "color-selector"),
htmlButton(children = "Select all the colors!",
id = "multi-selector"
),
htmlDiv(id='message-box',
children='Please select a color choice from the dropdown menu.'),
htmlDiv(id='message-box2',
children=' ')
)
)
)

app$callback(output=list(id='message-box2', property='children'),
params=list(
input(id='multi-selector', property='n_clicks')),
function(n_clicks)
{
# if button has been clicked, n_clicks is numeric()
# on first launch of callback at layout initialization,
# value of n_clicks will be list(NULL), which is not
# comparable using >, < or =; hence the is.numeric()
# check
if (is.numeric(n_clicks) && n_clicks >= 1)
{
# return a vector to ensure that the check for
# class(x) == "no_update" isn't made for objects
# where length(x) > 1
return(c("Multiple color values: ",
"#FF0000, ",
"#00FF00, ",
"#0000FF ",
"returned!")
)
}
}
)

app$callback(output=list(id='message-box', property='children'),
params=list(
input(id='color-selector', property='value')),
function(color)
{
if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
color)
return(msg)
} else {
return(dashNoUpdate())
}
}
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
dashr.start_server(app)
dashr.find_element("#color-selector").click()
dashr.find_elements("div.VirtualizedSelectOption")[0].click()
dashr.wait_for_text_to_equal(
"#message-box",
"The hexadecimal representation of your last chosen color is #FF0000"
)
dashr.find_element("#color-selector").click()
dashr.find_elements("div.VirtualizedSelectOption")[3].click()
time.sleep(1)
assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
dashr.find_element("#color-selector").click()
dashr.find_elements("div.VirtualizedSelectOption")[1].click()
dashr.wait_for_text_to_equal(
"#message-box",
"The hexadecimal representation of your last chosen color is #00FF00"
)
dashr.find_element("#color-selector").click()
dashr.find_elements("div.VirtualizedSelectOption")[3].click()
time.sleep(1)
assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
dashr.find_element("#color-selector").click()
dashr.find_elements("div.VirtualizedSelectOption")[2].click()
dashr.wait_for_text_to_equal(
"#message-box",
"The hexadecimal representation of your last chosen color is #0000FF"
)
dashr.find_element("#color-selector").click()
dashr.find_elements("div.VirtualizedSelectOption")[3].click()
time.sleep(1)
assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
dashr.find_element("#multi-selector").click()
dashr.wait_for_text_to_equal(
"#message-box2",
"Multiple color values: #FF0000, #00FF00, #0000FF returned!"
)
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Use dev_tools_prune_errors instead of pruned_errors by rpkyle · Pull Request #113 · plotly/dashR · GitHub
Skip to content
Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Aug 23, 2019
 Merged


Use dev_tools_prune_errors instead of pruned_errors
#113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
370c79e

rename pruned_errors to prune_errors


rpkyle Aug 12, 2019
f7adc83

rename pruned to prune


rpkyle Aug 12, 2019
a44050a

Provide support for no_update in Dash for R (#111)


rpkyle Aug 13, 2019
1206744

Merge branch 'master' into 112-prune-errors


rpkyle Aug 13, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down

18 changes: 12 additions & 6 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

 output_value <- getStackTrace(do.call(callback, callback_args),
 debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

 # reset callback context
 private$callback_context_ <- NULL

 if (is.null(private$stack_message)) {
 # inspect the output_value to determine whether any outputs have no_update
 # objects within them; these should not be updated
 if (length(output_value) == 1 && class(output_value) == "no_update") {
 response$body <- character(1) # return empty string
 response$status <- 204L
 }
 else if (is.null(private$stack_message)) {
 # pass on output_value to encode_plotly in case there are dccGraph
 # components which include Plotly.js figures for which we'll need to 
 # run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
pruned_errors = TRUE, 
dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
 dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
 self$config$props_check <- FALSE
 }

 private$pruned_errors <- pruned_errors
 private$prune_errors <- dev_tools_prune_errors
 private$debug <- debug

 self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

 # initialize flags for debug mode and stack pruning,
 debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
 stack_message = NULL,

 # callback context
Expand Down

12 changes: 11 additions & 1 deletion
R/dependencies.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#' 
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
 property = property
 )
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
 x <- list(NULL)
 class(x) <- "no_update"
 return(x)
}

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 if(debug) {
 tryCatch(withCallingHandlers(
 expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

 reverseStack <- rev(calls)

 if (pruned_errors) {
 if (prune_errors) {
 # this line should match the last occurrence of the function
 # which raised the error within the call stack; prune here
 indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down

7 changes: 7 additions & 0 deletions
man/dependencies.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


111 changes: 111 additions & 0 deletions
tests/integration/callbacks/test_no_update.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
 htmlDiv(list(
 dccDropdown(options = list(
 list(label = "Red", value = "#FF0000"),
 list(label = "Green", value = "#00FF00"), 
 list(label = "Blue", value = "#0000FF"),
 list(label = "Do nothing", value = "nothing")
 ),
 id = "color-selector"),
 htmlButton(children = "Select all the colors!",
 id = "multi-selector"
 ),
 htmlDiv(id='message-box',
 children='Please select a color choice from the dropdown menu.'),
 htmlDiv(id='message-box2',
 children=' ')
 )
 )
)

app$callback(output=list(id='message-box2', property='children'),
 params=list(
 input(id='multi-selector', property='n_clicks')),
 function(n_clicks)
 {
 # if button has been clicked, n_clicks is numeric()
 # on first launch of callback at layout initialization,
 # value of n_clicks will be list(NULL), which is not
 # comparable using >, < or =; hence the is.numeric()
 # check
 if (is.numeric(n_clicks) && n_clicks >= 1)
 {
 # return a vector to ensure that the check for
 # class(x) == "no_update" isn't made for objects
 # where length(x) > 1
 return(c("Multiple color values: ", 
 "#FF0000, ", 
 "#00FF00, ", 
 "#0000FF ", 
 "returned!")
 )
 }
 }
)

app$callback(output=list(id='message-box', property='children'),
 params=list(
 input(id='color-selector', property='value')),
 function(color)
 {
 if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
 msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
 color)
 return(msg)
 } else {
 return(dashNoUpdate())
 }
 }
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
 dashr.start_server(app)
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[0].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #FF0000"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[1].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #00FF00"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[2].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #0000FF"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
 dashr.find_element("#multi-selector").click()
 dashr.wait_for_text_to_equal(
 "#message-box2",
 "Multiple color values: #FF0000, #00FF00, #0000FF returned!"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Use dev_tools_prune_errors instead of pruned_errors by rpkyle · Pull Request #113 · plotly/dashR · GitHub
Skip to content
Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Aug 23, 2019
 Merged


Use dev_tools_prune_errors instead of pruned_errors
#113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
370c79e

rename pruned_errors to prune_errors


rpkyle Aug 12, 2019
f7adc83

rename pruned to prune


rpkyle Aug 12, 2019
a44050a

Provide support for no_update in Dash for R (#111)


rpkyle Aug 13, 2019
1206744

Merge branch 'master' into 112-prune-errors


rpkyle Aug 13, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down

18 changes: 12 additions & 6 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

 output_value <- getStackTrace(do.call(callback, callback_args),
 debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

 # reset callback context
 private$callback_context_ <- NULL

 if (is.null(private$stack_message)) {
 # inspect the output_value to determine whether any outputs have no_update
 # objects within them; these should not be updated
 if (length(output_value) == 1 && class(output_value) == "no_update") {
 response$body <- character(1) # return empty string
 response$status <- 204L
 }
 else if (is.null(private$stack_message)) {
 # pass on output_value to encode_plotly in case there are dccGraph
 # components which include Plotly.js figures for which we'll need to 
 # run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
pruned_errors = TRUE, 
dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
 dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
 self$config$props_check <- FALSE
 }

 private$pruned_errors <- pruned_errors
 private$prune_errors <- dev_tools_prune_errors
 private$debug <- debug

 self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

 # initialize flags for debug mode and stack pruning,
 debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
 stack_message = NULL,

 # callback context
Expand Down

12 changes: 11 additions & 1 deletion
R/dependencies.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#' 
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
 property = property
 )
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
 x <- list(NULL)
 class(x) <- "no_update"
 return(x)
}

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 if(debug) {
 tryCatch(withCallingHandlers(
 expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

 reverseStack <- rev(calls)

 if (pruned_errors) {
 if (prune_errors) {
 # this line should match the last occurrence of the function
 # which raised the error within the call stack; prune here
 indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down

7 changes: 7 additions & 0 deletions
man/dependencies.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


111 changes: 111 additions & 0 deletions
tests/integration/callbacks/test_no_update.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
 htmlDiv(list(
 dccDropdown(options = list(
 list(label = "Red", value = "#FF0000"),
 list(label = "Green", value = "#00FF00"), 
 list(label = "Blue", value = "#0000FF"),
 list(label = "Do nothing", value = "nothing")
 ),
 id = "color-selector"),
 htmlButton(children = "Select all the colors!",
 id = "multi-selector"
 ),
 htmlDiv(id='message-box',
 children='Please select a color choice from the dropdown menu.'),
 htmlDiv(id='message-box2',
 children=' ')
 )
 )
)

app$callback(output=list(id='message-box2', property='children'),
 params=list(
 input(id='multi-selector', property='n_clicks')),
 function(n_clicks)
 {
 # if button has been clicked, n_clicks is numeric()
 # on first launch of callback at layout initialization,
 # value of n_clicks will be list(NULL), which is not
 # comparable using >, < or =; hence the is.numeric()
 # check
 if (is.numeric(n_clicks) && n_clicks >= 1)
 {
 # return a vector to ensure that the check for
 # class(x) == "no_update" isn't made for objects
 # where length(x) > 1
 return(c("Multiple color values: ", 
 "#FF0000, ", 
 "#00FF00, ", 
 "#0000FF ", 
 "returned!")
 )
 }
 }
)

app$callback(output=list(id='message-box', property='children'),
 params=list(
 input(id='color-selector', property='value')),
 function(color)
 {
 if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
 msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
 color)
 return(msg)
 } else {
 return(dashNoUpdate())
 }
 }
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
 dashr.start_server(app)
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[0].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #FF0000"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[1].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #00FF00"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[2].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #0000FF"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
 dashr.find_element("#multi-selector").click()
 dashr.wait_for_text_to_equal(
 "#message-box2",
 "Multiple color values: #FF0000, #00FF00, #0000FF returned!"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Use dev_tools_prune_errors instead of pruned_errors by rpkyle · Pull Request #113 · plotly/dashR · GitHub
Skip to content
Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Aug 23, 2019
 Merged


Use dev_tools_prune_errors instead of pruned_errors
#113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
370c79e

rename pruned_errors to prune_errors


rpkyle Aug 12, 2019
f7adc83

rename pruned to prune


rpkyle Aug 12, 2019
a44050a

Provide support for no_update in Dash for R (#111)


rpkyle Aug 13, 2019
1206744

Merge branch 'master' into 112-prune-errors


rpkyle Aug 13, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down

18 changes: 12 additions & 6 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

 output_value <- getStackTrace(do.call(callback, callback_args),
 debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

 # reset callback context
 private$callback_context_ <- NULL

 if (is.null(private$stack_message)) {
 # inspect the output_value to determine whether any outputs have no_update
 # objects within them; these should not be updated
 if (length(output_value) == 1 && class(output_value) == "no_update") {
 response$body <- character(1) # return empty string
 response$status <- 204L
 }
 else if (is.null(private$stack_message)) {
 # pass on output_value to encode_plotly in case there are dccGraph
 # components which include Plotly.js figures for which we'll need to 
 # run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
pruned_errors = TRUE, 
dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
 dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
 self$config$props_check <- FALSE
 }

 private$pruned_errors <- pruned_errors
 private$prune_errors <- dev_tools_prune_errors
 private$debug <- debug

 self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

 # initialize flags for debug mode and stack pruning,
 debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
 stack_message = NULL,

 # callback context
Expand Down

12 changes: 11 additions & 1 deletion
R/dependencies.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#' 
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
 property = property
 )
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
 x <- list(NULL)
 class(x) <- "no_update"
 return(x)
}

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 if(debug) {
 tryCatch(withCallingHandlers(
 expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

 reverseStack <- rev(calls)

 if (pruned_errors) {
 if (prune_errors) {
 # this line should match the last occurrence of the function
 # which raised the error within the call stack; prune here
 indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down

7 changes: 7 additions & 0 deletions
man/dependencies.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


111 changes: 111 additions & 0 deletions
tests/integration/callbacks/test_no_update.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
 htmlDiv(list(
 dccDropdown(options = list(
 list(label = "Red", value = "#FF0000"),
 list(label = "Green", value = "#00FF00"), 
 list(label = "Blue", value = "#0000FF"),
 list(label = "Do nothing", value = "nothing")
 ),
 id = "color-selector"),
 htmlButton(children = "Select all the colors!",
 id = "multi-selector"
 ),
 htmlDiv(id='message-box',
 children='Please select a color choice from the dropdown menu.'),
 htmlDiv(id='message-box2',
 children=' ')
 )
 )
)

app$callback(output=list(id='message-box2', property='children'),
 params=list(
 input(id='multi-selector', property='n_clicks')),
 function(n_clicks)
 {
 # if button has been clicked, n_clicks is numeric()
 # on first launch of callback at layout initialization,
 # value of n_clicks will be list(NULL), which is not
 # comparable using >, < or =; hence the is.numeric()
 # check
 if (is.numeric(n_clicks) && n_clicks >= 1)
 {
 # return a vector to ensure that the check for
 # class(x) == "no_update" isn't made for objects
 # where length(x) > 1
 return(c("Multiple color values: ", 
 "#FF0000, ", 
 "#00FF00, ", 
 "#0000FF ", 
 "returned!")
 )
 }
 }
)

app$callback(output=list(id='message-box', property='children'),
 params=list(
 input(id='color-selector', property='value')),
 function(color)
 {
 if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
 msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
 color)
 return(msg)
 } else {
 return(dashNoUpdate())
 }
 }
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
 dashr.start_server(app)
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[0].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #FF0000"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[1].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #00FF00"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[2].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #0000FF"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
 dashr.find_element("#multi-selector").click()
 dashr.wait_for_text_to_equal(
 "#message-box2",
 "Multiple color values: #FF0000, #00FF00, #0000FF returned!"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Use dev_tools_prune_errors instead of pruned_errors by rpkyle · Pull Request #113 · plotly/dashR · GitHub
Skip to content
Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Aug 23, 2019
 Merged


Use dev_tools_prune_errors instead of pruned_errors
#113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
370c79e

rename pruned_errors to prune_errors


rpkyle Aug 12, 2019
f7adc83

rename pruned to prune


rpkyle Aug 12, 2019
a44050a

Provide support for no_update in Dash for R (#111)


rpkyle Aug 13, 2019
1206744

Merge branch 'master' into 112-prune-errors


rpkyle Aug 13, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down

18 changes: 12 additions & 6 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

 output_value <- getStackTrace(do.call(callback, callback_args),
 debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

 # reset callback context
 private$callback_context_ <- NULL

 if (is.null(private$stack_message)) {
 # inspect the output_value to determine whether any outputs have no_update
 # objects within them; these should not be updated
 if (length(output_value) == 1 && class(output_value) == "no_update") {
 response$body <- character(1) # return empty string
 response$status <- 204L
 }
 else if (is.null(private$stack_message)) {
 # pass on output_value to encode_plotly in case there are dccGraph
 # components which include Plotly.js figures for which we'll need to 
 # run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
pruned_errors = TRUE, 
dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
 dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
 self$config$props_check <- FALSE
 }

 private$pruned_errors <- pruned_errors
 private$prune_errors <- dev_tools_prune_errors
 private$debug <- debug

 self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

 # initialize flags for debug mode and stack pruning,
 debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
 stack_message = NULL,

 # callback context
Expand Down

12 changes: 11 additions & 1 deletion
R/dependencies.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#' 
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
 property = property
 )
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
 x <- list(NULL)
 class(x) <- "no_update"
 return(x)
}

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 if(debug) {
 tryCatch(withCallingHandlers(
 expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

 reverseStack <- rev(calls)

 if (pruned_errors) {
 if (prune_errors) {
 # this line should match the last occurrence of the function
 # which raised the error within the call stack; prune here
 indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down

7 changes: 7 additions & 0 deletions
man/dependencies.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


111 changes: 111 additions & 0 deletions
tests/integration/callbacks/test_no_update.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
 htmlDiv(list(
 dccDropdown(options = list(
 list(label = "Red", value = "#FF0000"),
 list(label = "Green", value = "#00FF00"), 
 list(label = "Blue", value = "#0000FF"),
 list(label = "Do nothing", value = "nothing")
 ),
 id = "color-selector"),
 htmlButton(children = "Select all the colors!",
 id = "multi-selector"
 ),
 htmlDiv(id='message-box',
 children='Please select a color choice from the dropdown menu.'),
 htmlDiv(id='message-box2',
 children=' ')
 )
 )
)

app$callback(output=list(id='message-box2', property='children'),
 params=list(
 input(id='multi-selector', property='n_clicks')),
 function(n_clicks)
 {
 # if button has been clicked, n_clicks is numeric()
 # on first launch of callback at layout initialization,
 # value of n_clicks will be list(NULL), which is not
 # comparable using >, < or =; hence the is.numeric()
 # check
 if (is.numeric(n_clicks) && n_clicks >= 1)
 {
 # return a vector to ensure that the check for
 # class(x) == "no_update" isn't made for objects
 # where length(x) > 1
 return(c("Multiple color values: ", 
 "#FF0000, ", 
 "#00FF00, ", 
 "#0000FF ", 
 "returned!")
 )
 }
 }
)

app$callback(output=list(id='message-box', property='children'),
 params=list(
 input(id='color-selector', property='value')),
 function(color)
 {
 if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
 msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
 color)
 return(msg)
 } else {
 return(dashNoUpdate())
 }
 }
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
 dashr.start_server(app)
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[0].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #FF0000"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[1].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #00FF00"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[2].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #0000FF"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
 dashr.find_element("#multi-selector").click()
 dashr.wait_for_text_to_equal(
 "#message-box2",
 "Multiple color values: #FF0000, #00FF00, #0000FF returned!"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Use dev_tools_prune_errors instead of pruned_errors by rpkyle · Pull Request #113 · plotly/dashR · GitHub
Skip to content
Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Aug 23, 2019
 Merged


Use dev_tools_prune_errors instead of pruned_errors
#113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
370c79e

rename pruned_errors to prune_errors


rpkyle Aug 12, 2019
f7adc83

rename pruned to prune


rpkyle Aug 12, 2019
a44050a

Provide support for no_update in Dash for R (#111)


rpkyle Aug 13, 2019
1206744

Merge branch 'master' into 112-prune-errors


rpkyle Aug 13, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down

18 changes: 12 additions & 6 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

 output_value <- getStackTrace(do.call(callback, callback_args),
 debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

 # reset callback context
 private$callback_context_ <- NULL

 if (is.null(private$stack_message)) {
 # inspect the output_value to determine whether any outputs have no_update
 # objects within them; these should not be updated
 if (length(output_value) == 1 && class(output_value) == "no_update") {
 response$body <- character(1) # return empty string
 response$status <- 204L
 }
 else if (is.null(private$stack_message)) {
 # pass on output_value to encode_plotly in case there are dccGraph
 # components which include Plotly.js figures for which we'll need to 
 # run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
pruned_errors = TRUE, 
dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
 dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
 self$config$props_check <- FALSE
 }

 private$pruned_errors <- pruned_errors
 private$prune_errors <- dev_tools_prune_errors
 private$debug <- debug

 self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

 # initialize flags for debug mode and stack pruning,
 debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
 stack_message = NULL,

 # callback context
Expand Down

12 changes: 11 additions & 1 deletion
R/dependencies.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#' 
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
 property = property
 )
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
 x <- list(NULL)
 class(x) <- "no_update"
 return(x)
}

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 if(debug) {
 tryCatch(withCallingHandlers(
 expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

 reverseStack <- rev(calls)

 if (pruned_errors) {
 if (prune_errors) {
 # this line should match the last occurrence of the function
 # which raised the error within the call stack; prune here
 indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down

7 changes: 7 additions & 0 deletions
man/dependencies.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


111 changes: 111 additions & 0 deletions
tests/integration/callbacks/test_no_update.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
 htmlDiv(list(
 dccDropdown(options = list(
 list(label = "Red", value = "#FF0000"),
 list(label = "Green", value = "#00FF00"), 
 list(label = "Blue", value = "#0000FF"),
 list(label = "Do nothing", value = "nothing")
 ),
 id = "color-selector"),
 htmlButton(children = "Select all the colors!",
 id = "multi-selector"
 ),
 htmlDiv(id='message-box',
 children='Please select a color choice from the dropdown menu.'),
 htmlDiv(id='message-box2',
 children=' ')
 )
 )
)

app$callback(output=list(id='message-box2', property='children'),
 params=list(
 input(id='multi-selector', property='n_clicks')),
 function(n_clicks)
 {
 # if button has been clicked, n_clicks is numeric()
 # on first launch of callback at layout initialization,
 # value of n_clicks will be list(NULL), which is not
 # comparable using >, < or =; hence the is.numeric()
 # check
 if (is.numeric(n_clicks) && n_clicks >= 1)
 {
 # return a vector to ensure that the check for
 # class(x) == "no_update" isn't made for objects
 # where length(x) > 1
 return(c("Multiple color values: ", 
 "#FF0000, ", 
 "#00FF00, ", 
 "#0000FF ", 
 "returned!")
 )
 }
 }
)

app$callback(output=list(id='message-box', property='children'),
 params=list(
 input(id='color-selector', property='value')),
 function(color)
 {
 if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
 msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
 color)
 return(msg)
 } else {
 return(dashNoUpdate())
 }
 }
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
 dashr.start_server(app)
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[0].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #FF0000"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[1].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #00FF00"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[2].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #0000FF"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
 dashr.find_element("#multi-selector").click()
 dashr.wait_for_text_to_equal(
 "#message-box2",
 "Multiple color values: #FF0000, #00FF00, #0000FF returned!"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Use dev_tools_prune_errors instead of pruned_errors by rpkyle · Pull Request #113 · plotly/dashR · GitHub
Skip to content
Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Aug 23, 2019
 Merged


Use dev_tools_prune_errors instead of pruned_errors
#113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
370c79e

rename pruned_errors to prune_errors


rpkyle Aug 12, 2019
f7adc83

rename pruned to prune


rpkyle Aug 12, 2019
a44050a

Provide support for no_update in Dash for R (#111)


rpkyle Aug 13, 2019
1206744

Merge branch 'master' into 112-prune-errors


rpkyle Aug 13, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down

18 changes: 12 additions & 6 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

 output_value <- getStackTrace(do.call(callback, callback_args),
 debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

 # reset callback context
 private$callback_context_ <- NULL

 if (is.null(private$stack_message)) {
 # inspect the output_value to determine whether any outputs have no_update
 # objects within them; these should not be updated
 if (length(output_value) == 1 && class(output_value) == "no_update") {
 response$body <- character(1) # return empty string
 response$status <- 204L
 }
 else if (is.null(private$stack_message)) {
 # pass on output_value to encode_plotly in case there are dccGraph
 # components which include Plotly.js figures for which we'll need to 
 # run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
pruned_errors = TRUE, 
dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
 dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
 self$config$props_check <- FALSE
 }

 private$pruned_errors <- pruned_errors
 private$prune_errors <- dev_tools_prune_errors
 private$debug <- debug

 self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

 # initialize flags for debug mode and stack pruning,
 debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
 stack_message = NULL,

 # callback context
Expand Down

12 changes: 11 additions & 1 deletion
R/dependencies.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#' 
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
 property = property
 )
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
 x <- list(NULL)
 class(x) <- "no_update"
 return(x)
}

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 if(debug) {
 tryCatch(withCallingHandlers(
 expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

 reverseStack <- rev(calls)

 if (pruned_errors) {
 if (prune_errors) {
 # this line should match the last occurrence of the function
 # which raised the error within the call stack; prune here
 indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down

7 changes: 7 additions & 0 deletions
man/dependencies.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


111 changes: 111 additions & 0 deletions
tests/integration/callbacks/test_no_update.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
 htmlDiv(list(
 dccDropdown(options = list(
 list(label = "Red", value = "#FF0000"),
 list(label = "Green", value = "#00FF00"), 
 list(label = "Blue", value = "#0000FF"),
 list(label = "Do nothing", value = "nothing")
 ),
 id = "color-selector"),
 htmlButton(children = "Select all the colors!",
 id = "multi-selector"
 ),
 htmlDiv(id='message-box',
 children='Please select a color choice from the dropdown menu.'),
 htmlDiv(id='message-box2',
 children=' ')
 )
 )
)

app$callback(output=list(id='message-box2', property='children'),
 params=list(
 input(id='multi-selector', property='n_clicks')),
 function(n_clicks)
 {
 # if button has been clicked, n_clicks is numeric()
 # on first launch of callback at layout initialization,
 # value of n_clicks will be list(NULL), which is not
 # comparable using >, < or =; hence the is.numeric()
 # check
 if (is.numeric(n_clicks) && n_clicks >= 1)
 {
 # return a vector to ensure that the check for
 # class(x) == "no_update" isn't made for objects
 # where length(x) > 1
 return(c("Multiple color values: ", 
 "#FF0000, ", 
 "#00FF00, ", 
 "#0000FF ", 
 "returned!")
 )
 }
 }
)

app$callback(output=list(id='message-box', property='children'),
 params=list(
 input(id='color-selector', property='value')),
 function(color)
 {
 if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
 msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
 color)
 return(msg)
 } else {
 return(dashNoUpdate())
 }
 }
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
 dashr.start_server(app)
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[0].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #FF0000"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[1].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #00FF00"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[2].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #0000FF"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
 dashr.find_element("#multi-selector").click()
 dashr.wait_for_text_to_equal(
 "#message-box2",
 "Multiple color values: #FF0000, #00FF00, #0000FF returned!"
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Use dev_tools_prune_errors instead of pruned_errors by rpkyle · Pull Request #113 · plotly/dashR · GitHub
Skip to content
Use dev_tools_prune_errors instead of pruned_errors#113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Aug 23, 2019
 Merged


Use dev_tools_prune_errors instead of pruned_errors
#113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
370c79e

rename pruned_errors to prune_errors


rpkyle Aug 12, 2019
f7adc83

rename pruned to prune


rpkyle Aug 12, 2019
a44050a

Provide support for no_update in Dash for R (#111)


rpkyle Aug 13, 2019
1206744

Merge branch 'master' into 112-prune-errors


rpkyle Aug 13, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down

18 changes: 12 additions & 6 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -286,12 +286,18 @@ Dash <- R6::R6Class(

 output_value <- getStackTrace(do.call(callback, callback_args),
 debug = private$debug,
pruned_errors = private$pruned_errors)
prune_errors = private$prune_errors)

 # reset callback context
 private$callback_context_ <- NULL

 if (is.null(private$stack_message)) {
 # inspect the output_value to determine whether any outputs have no_update
 # objects within them; these should not be updated
 if (length(output_value) == 1 && class(output_value) == "no_update") {
 response$body <- character(1) # return empty string
 response$status <- 204L
 }
 else if (is.null(private$stack_message)) {
 # pass on output_value to encode_plotly in case there are dccGraph
 # components which include Plotly.js figures for which we'll need to 
 # run plotly_build from the plotly package
Expand DownExpand Up@@ -525,7 +531,7 @@ Dash <- R6::R6Class(
 port = Sys.getenv('DASH_PORT', 8050), 
 block = TRUE, 
 showcase = FALSE, 
pruned_errors = TRUE, 
dev_tools_prune_errors = TRUE, 
 debug = FALSE, 
 dev_tools_ui = NULL,
 dev_tools_props_check = NULL,
Expand All@@ -545,7 +551,7 @@ Dash <- R6::R6Class(
 self$config$props_check <- FALSE
 }

 private$pruned_errors <- pruned_errors
 private$prune_errors <- dev_tools_prune_errors
 private$debug <- debug

 self$server$ignite(block = block, showcase = showcase, ...)
Expand All@@ -569,7 +575,7 @@ Dash <- R6::R6Class(

 # initialize flags for debug mode and stack pruning,
 debug = NULL,
pruned_errors = NULL,
prune_errors = NULL,
 stack_message = NULL,

 # callback context
Expand Down

12 changes: 11 additions & 1 deletion
R/dependencies.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,11 +5,13 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments.
#' 
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand DownExpand Up@@ -44,3 +46,11 @@ dependency <- function(id = NULL, property = NULL) {
 property = property
 )
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
 x <- list(NULL)
 class(x) <- "no_update"
 return(x)
}

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -685,7 +685,7 @@ stackTraceToHTML <- function(call_stack,
# and capture the call stack. By default, the call
# stack will be "pruned" of error handling functions
# for greater readability.
getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {
getStackTrace <- function(expr, debug = FALSE, prune_errors = TRUE) {
 if(debug) {
 tryCatch(withCallingHandlers(
 expr,
Expand All@@ -711,7 +711,7 @@ getStackTrace <- function(expr, debug = FALSE, pruned_errors = TRUE) {

 reverseStack <- rev(calls)

 if (pruned_errors) {
 if (prune_errors) {
 # this line should match the last occurrence of the function
 # which raised the error within the call stack; prune here
 indexFromLast <- match(TRUE, lapply(reverseStack, function(currentCall) {
Expand Down

7 changes: 7 additions & 0 deletions
man/dependencies.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


111 changes: 111 additions & 0 deletions
tests/integration/callbacks/test_no_update.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
from selenium.webdriver.support.select import Select
import time

app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

app <- Dash$new()

app$layout(
 htmlDiv(list(
 dccDropdown(options = list(
 list(label = "Red", value = "#FF0000"),
 list(label = "Green", value = "#00FF00"), 
 list(label = "Blue", value = "#0000FF"),
 list(label = "Do nothing", value = "nothing")
 ),
 id = "color-selector"),
 htmlButton(children = "Select all the colors!",
 id = "multi-selector"
 ),
 htmlDiv(id='message-box',
 children='Please select a color choice from the dropdown menu.'),
 htmlDiv(id='message-box2',
 children=' ')
 )
 )
)

app$callback(output=list(id='message-box2', property='children'),
 params=list(
 input(id='multi-selector', property='n_clicks')),
 function(n_clicks)
 {
 # if button has been clicked, n_clicks is numeric()
 # on first launch of callback at layout initialization,
 # value of n_clicks will be list(NULL), which is not
 # comparable using >, < or =; hence the is.numeric()
 # check
 if (is.numeric(n_clicks) && n_clicks >= 1)
 {
 # return a vector to ensure that the check for
 # class(x) == "no_update" isn't made for objects
 # where length(x) > 1
 return(c("Multiple color values: ", 
 "#FF0000, ", 
 "#00FF00, ", 
 "#0000FF ", 
 "returned!")
 )
 }
 }
)

app$callback(output=list(id='message-box', property='children'),
 params=list(
 input(id='color-selector', property='value')),
 function(color)
 {
 if (color %in% c("#FF0000", "#00FF00", "#0000FF")) {
 msg <- sprintf("The hexadecimal representation of your last chosen color is %s",
 color)
 return(msg)
 } else {
 return(dashNoUpdate())
 }
 }
)

app$run_server()
"""


def test_rsnu001_no_update(dashr):
 dashr.start_server(app)
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[0].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #FF0000"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #FF0000"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[1].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #00FF00"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #00FF00"
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[2].click()
 dashr.wait_for_text_to_equal(
 "#message-box",
 "The hexadecimal representation of your last chosen color is #0000FF"
 )
 dashr.find_element("#color-selector").click()
 dashr.find_elements("div.VirtualizedSelectOption")[3].click()
 time.sleep(1)
 assert dashr.find_element("#message-box").text == "The hexadecimal representation of your last chosen color is #0000FF"
 dashr.find_element("#multi-selector").click()
 dashr.wait_for_text_to_equal(
 "#message-box2",
 "Multiple color values: #FF0000, #00FF00, #0000FF returned!"
 )