Merge branch 'build_tools' into build_tools_ruff

* build_tools:
  Add comments about pre-commit hooks and how to disable them temporarily
  Code feedback
  Do not use isort on init files
  Discard changes to __init__.py files
  Use correct docs target to build site (not preview)
  Restore missing target

Author: schloerke

.github/workflows/build-docs.yaml

@@ -29,7 +29,7 @@ jobs:
 
       - name: Build site
         run: |
-          make docs
+          make docs-site
 
       - name: Upload site artifact
         if: github.ref == 'refs/heads/main'

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+# For the rare case that you'd like to commit with no pre-commit hooks, you can use `--no-verify` in the commit call.
+# ```
+# git commit --no-verify -m "MSG"
+# ```
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.3.2

Makefile

@@ -1,5 +1,3 @@
-# .PHONY: help clean% check% format% docs% lint test pyright playwright% install% testrail% coverage release
-
 # Depend on `FORCE` to ensure the target is always run
 FORCE:
 
@@ -60,8 +58,10 @@ $(VENV):
 	$(PYBIN)/pip install --upgrade pip
 
 $(PYBIN): $(VENV)
+$(PYTHON): $(PYBIN)
 $(PIP): $(PYBIN)
 
+
 UV = $(SITE_PACKAGES)/uv
 $(UV):
 	$(MAKE) $(PYBIN)
@@ -80,7 +80,7 @@ PYTEST = $(SITE_PACKAGES)/pytest
 COVERAGE = $(SITE_PACKAGES)/coverage
 PYRIGHT = $(SITE_PACKAGES)/pyright
 PLAYWRIGHT = $(SITE_PACKAGES)/playwright
-$(PYTEST) $(COVERAGE) $(PYRIGHT) $(PLAYWRIGHT):
+$(RUFF) $(PYTEST) $(COVERAGE) $(PYRIGHT) $(PLAYWRIGHT):
 	@$(MAKE) install-deps
 
 

README.md

@@ -57,3 +57,5 @@ pre-commit install
 # To disable:
 # pre-commit uninstall
 ```
+
+If you absolutely need to skip the pre-commit hooks, you can use the [`--no-verify` flag when you commit](https://git-scm.com/docs/githooks#_pre_commit) (`git commit --no-verify -m "MSG"`).

examples/model-score/app.py

@@ -16,6 +16,16 @@
 THRESHOLD_LOW = 0.5
 THRESHOLD_LOW_COLOR = "rgb(193, 0, 0)"
 
+
+def value_box_theme(score):
+    if score > THRESHOLD_MID:
+        return "text-success"
+    elif score < THRESHOLD_LOW:
+        return "bg-danger"
+    else:
+        return "text-warning"
+
+
 # Start a background thread that writes fake data to the SQLite database every second
 scoredata.begin()
 
@@ -192,13 +202,7 @@ def value_boxes():
                 ui.value_box(
                     model,
                     ui.h2(score),
-                    theme=(
-                        "text-success"
-                        if score > THRESHOLD_MID
-                        else "text-warning"
-                        if score > THRESHOLD_LOW
-                        else "bg-danger"
-                    ),
+                    theme=value_box_theme(score),
                 )
                 for model, score in scores_by_model.items()
             ],

ruff.toml

@@ -88,6 +88,8 @@ extend-select = [
 ]
 
 [lint.extend-per-file-ignores]
+# I: isort; Do not reformat imports in `__init__.py` files.
+"**/__init__.py" = ["I"]
 # F403: 'from module import *' used; unable to detect undefined names
 # Also ignore `F403` in all `__init__.py` files.
 "shiny/__init__.py" = ["F403"]
@@ -102,8 +104,6 @@ extend-select = [
 "shiny/templates/**" = ["T20"]
 "shiny/api-examples/**" = ["T20"]
 "tests/**" = ["T20"]
-# I: isort
-"shiny/experimental/ui/__init__.py" = ["I"]
 # PT019: pytest
 "tests/pytest/test_output_transformer.py" = ["PT019"]
 

shiny/express/__init__.py

@@ -1,21 +1,14 @@
 from __future__ import annotations
 
-from .. import render
-
 # Import these with underscore names so they won't show in autocomplete from the Python
 # console.
 from ..session import (
     Inputs as _Inputs,
-)
-from ..session import (
     Outputs as _Outputs,
-)
-from ..session import (
     Session as _Session,
-)
-from ..session import (
     get_current_session as _get_current_session,
 )
+from .. import render
 from . import ui
 from ._is_express import is_express_app
 from ._output import (  # noqa: F401
@@ -25,6 +18,7 @@
 from ._run import app_opts, wrap_express_app
 from .expressify_decorator import expressify
 
+
 __all__ = (
     "render",
     "input",

shiny/express/ui/__init__.py

@@ -1,12 +1,15 @@
 from __future__ import annotations
 
+
 from htmltools import (
-    HTML,
+    TagList,
     Tag,
+    TagChild,
     TagAttrs,
     TagAttrValue,
-    TagChild,
-    TagList,
+    tags,
+    HTML,
+    head_content,
     a,
     br,
     code,
@@ -18,31 +21,30 @@
     h4,
     h5,
     h6,
-    head_content,
     hr,
     img,
     p,
     pre,
     span,
     strong,
-    tags,
+)
+
+from ...ui import (
+    fill,
 )
 
 from ...ui import (
     AccordionPanel,
     AnimationOptions,
     CardItem,
-    Progress,
     ShowcaseLayout,
     Sidebar,
     SliderStepArg,
     SliderValueArg,
     ValueBoxTheme,
-    bind_task_button,
     brush_opts,
     click_opts,
     dblclick_opts,
-    fill,
     help_text,
     hover_opts,
     include_css,
@@ -51,70 +53,74 @@
     input_action_link,
     input_checkbox,
     input_checkbox_group,
+    input_switch,
+    input_radio_buttons,
     input_dark_mode,
     input_date,
     input_date_range,
     input_file,
     input_numeric,
     input_password,
-    input_radio_buttons,
     input_select,
     input_selectize,
     input_slider,
-    input_switch,
+    bind_task_button,
     input_task_button,
     input_text,
     input_text_area,
-    insert_accordion_panel,
-    insert_ui,
-    js_eval,
-    markdown,
-    modal,
-    modal_button,
-    modal_remove,
-    modal_show,
-    nav_spacer,
-    notification_remove,
-    notification_show,
     panel_title,
+    insert_accordion_panel,
     remove_accordion_panel,
-    remove_ui,
     update_accordion,
     update_accordion_panel,
+    update_sidebar,
     update_action_button,
     update_action_link,
     update_checkbox,
+    update_switch,
     update_checkbox_group,
+    update_radio_buttons,
     update_dark_mode,
     update_date,
     update_date_range,
-    update_navs,
     update_numeric,
-    update_popover,
-    update_radio_buttons,
     update_select,
     update_selectize,
-    update_sidebar,
     update_slider,
-    update_switch,
     update_task_button,
     update_text,
     update_text_area,
+    update_navs,
     update_tooltip,
+    update_popover,
+    insert_ui,
+    remove_ui,
+    markdown,
+    modal_button,
+    modal,
+    modal_show,
+    modal_remove,
+    notification_show,
+    notification_remove,
+    nav_spacer,
+    Progress,
     value_box_theme,
+    js_eval,
 )
+
 from ._cm_components import (
-    accordion,
-    accordion_panel,
-    card,
-    card_footer,
-    card_header,
+    sidebar,
+    layout_sidebar,
     layout_column_wrap,
     layout_columns,
-    layout_sidebar,
+    card,
+    card_header,
+    card_footer,
+    accordion,
+    accordion_panel,
+    nav_panel,
     nav_control,
     nav_menu,
-    nav_panel,
     navset_bar,
     navset_card_pill,
     navset_card_tab,
@@ -124,22 +130,23 @@
     navset_pill_list,
     navset_tab,
     navset_underline,
-    panel_absolute,
+    value_box,
+    panel_well,
     panel_conditional,
     panel_fixed,
-    panel_well,
-    popover,
-    sidebar,
+    panel_absolute,
     tooltip,
-    value_box,
-)
-from ._hold import (
-    hold,
+    popover,
 )
+
 from ._page import (
     page_opts,
 )
 
+from ._hold import (
+    hold,
+)
+
 __all__ = (
     # Imports from htmltools
     "TagList",

shiny/reactive/__init__.py

@@ -1,26 +1,27 @@
 from ._core import (  # noqa: F401
     Context,
-    flush,
-    get_current_context,  # pyright: ignore[reportUnusedImport]
-    invalidate_later,
     isolate,
+    invalidate_later,
+    flush,
     lock,
     on_flushed,
+    get_current_context,  # pyright: ignore[reportUnusedImport]
 )
-from ._extended_task import ExtendedTask, extended_task
-from ._poll import file_reader, poll
+from ._poll import poll, file_reader
 from ._reactives import (  # noqa: F401
+    value,
+    Value,
+    calc,
     Calc,
     Calc_,  # pyright: ignore[reportUnusedImport]
     CalcAsync_,  # pyright: ignore[reportUnusedImport]
+    effect,
     Effect,
     Effect_,  # pyright: ignore[reportUnusedImport]
-    Value,
-    calc,
-    effect,
     event,
-    value,
 )
+from ._extended_task import ExtendedTask, extended_task
+
 
 __all__ = (
     "Context",

shiny/render/__init__.py

@@ -10,21 +10,21 @@
     DataTable,
     data_frame,
 )
-from ._deprecated import (  # noqa: F401
-    RenderFunction,  # pyright: ignore[reportUnusedImport]
-    RenderFunctionAsync,  # pyright: ignore[reportUnusedImport]
-)
 from ._express import (
     express,
 )
 from ._render import (
     code,
-    download,
     image,
     plot,
     table,
     text,
     ui,
+    download,
+)
+from ._deprecated import (  # noqa: F401
+    RenderFunction,  # pyright: ignore[reportUnusedImport]
+    RenderFunctionAsync,  # pyright: ignore[reportUnusedImport]
 )
 
 __all__ = (

shiny/render/renderer/__init__.py

@@ -1,9 +1,10 @@
 from ._renderer import (
-    AsyncValueFn,
-    Jsonifiable,
     Renderer,
-    RendererT,
     ValueFn,
+    Jsonifiable,
+    RendererT,
+    AsyncValueFn,
+    # IT,  # pyright: ignore[reportUnusedImport]
 )
 
 __all__ = (