Merge branch 'main' into 80-handle-empty-column-headers

WHAT-WE-LEARNED.md

@@ -76,3 +76,7 @@ I've had to tweak the CSS a few times:
 
 The different flavors of "Shiny" are a bit of nuissance when trying to find examples.
 The maturity of Shiny for R means that the vast majority of the examples are for R, even with Python in the search. It would be nice if the docs site remembered that I only want to look at docs for Core.
+
+## Shiny docs could have better formatting
+
+- https://shiny.posit.co/py/api/core/ui.layout_columns.html: bullet list not rendered correctly.

dp_creator_ii/app/components/column_module.py

@@ -10,28 +10,44 @@
 
 @module.ui
 def column_ui():  # pragma: no cover
-    return [
-        ui.input_numeric("min", "Min", 0),
-        ui.input_numeric("max", "Max", 10),
-        ui.input_numeric("bins", "Bins", 10),
-        ui.input_select(
-            "weight",
-            "Weight",
-            choices={
-                1: "Less accurate",
-                2: "Default",
-                4: "More accurate",
-            },
-            selected=2,
-        ),
-        output_code_sample("Column Definition", "column_code"),
-        ui.markdown(
-            "This simulation assumes a normal distribution "
-            "between the specified min and max. "
-            "Your data file has not been read except to determine the columns."
-        ),
-        ui.output_plot("column_plot"),
-    ]
+    width = "10em"  # Just wide enough so the text isn't trucated.
+    return ui.layout_columns(
+        [
+            ui.input_numeric("min", "Min", 0, width=width),
+            ui.input_numeric("max", "Max", 10, width=width),
+            ui.input_numeric("bins", "Bins", 10, width=width),
+            ui.input_select(
+                "weight",
+                "Weight",
+                choices={
+                    1: "Less accurate",
+                    2: "Default",
+                    4: "More accurate",
+                },
+                selected=2,
+                width=width,
+            ),
+        ],
+        [
+            # TODO: This doesn't need to be repeated: could just go once at the top.
+            # https://github.com/opendp/dp-creator-ii/issues/138
+            ui.markdown(
+                "This simulation assumes a normal distribution "
+                "between the specified min and max. "
+                "Your data file has not been read except to determine the columns."
+            ),
+            ui.output_plot("column_plot", height="300px"),
+            # Make plot smaller than default: about the same size as the other column.
+            output_code_sample("Column Definition", "column_code"),
+        ],
+        col_widths={
+            # Controls stay roughly a constant width;
+            # Graph expands to fill space.
+            "sm": (4, 8),
+            "md": (3, 9),
+            "lg": (2, 10),
+        },
+    )
 
 
 @module.server

dp_creator_ii/app/components/plots.py

@@ -15,9 +15,15 @@ def _df_to_columns(df):
 
 
 def plot_histogram(histogram_df, error, cutoff):  # pragma: no cover
-    labels, values = _df_to_columns(histogram_df)
+    bins, values = _df_to_columns(histogram_df)
+    mod = (len(bins) // 12) + 1
+    majors = [label for i, label in enumerate(bins) if i % mod == 0]
+    minors = [label for i, label in enumerate(bins) if i % mod != 0]
     _figure, axes = plt.subplots()
     bar_colors = ["blue" if v > cutoff else "lightblue" for v in values]
-    axes.bar(labels, values, color=bar_colors, yerr=error)
+    axes.bar(bins, values, color=bar_colors, yerr=error)
+    axes.set_xticks(majors, majors)
+    axes.set_xticks(minors, ["" for _ in minors], minor=True)
     axes.axhline(cutoff, color="lightgrey", zorder=-1)
+    axes.set_ylim(bottom=0)
     # TODO: Since this seems to return None, how does the information flow?

dp_creator_ii/app/css/styles.css

@@ -1,5 +1,5 @@
 body {
-    margin: 1em;
+    margin: 2em;
 }
 
 #top_level_nav {

tests/test_arg_parser.py → tests/utils/test_argparse_helpers.py

@@ -6,6 +6,9 @@
 from dp_creator_ii.utils.argparse_helpers import _get_arg_parser, _existing_csv_type
 
 
+fixtures_path = Path(__file__).parent.parent / "fixtures"
+
+
 def test_help():
     help = (
         _get_arg_parser()
@@ -19,7 +22,7 @@ def test_help():
     )
     print(help)
 
-    readme_md = (Path(__file__).parent.parent / "README.md").read_text()
+    readme_md = (Path(__file__).parent.parent.parent / "README.md").read_text()
     assert help in readme_md
 
 
@@ -30,9 +33,9 @@ def test_arg_validation_no_file():
 
 def test_arg_validation_not_csv():
     with pytest.raises(ArgumentTypeError, match='Must have ".csv" extension:'):
-        _existing_csv_type(Path(__file__).parent / "fixtures" / "fake.ipynb")
+        _existing_csv_type(fixtures_path / "fake.ipynb")
 
 
 def test_arg_validation_works():
-    path = _existing_csv_type(Path(__file__).parent / "fixtures" / "fake.csv")
+    path = _existing_csv_type(fixtures_path / "fake.csv")
     assert path.name == "fake.csv"

tests/test_converters.py → tests/utils/test_converters.py

@@ -5,6 +5,9 @@
 from dp_creator_ii.utils.converters import convert_py_to_nb
 
 
+fixtures_path = Path(__file__).parent.parent / "fixtures"
+
+
 def norm_nb(nb_str):
     normed_nb_str = nb_str
     normed_nb_str = re.sub(r'"id": "[^"]+"', '"id": "12345678"', normed_nb_str)
@@ -21,7 +24,6 @@ def norm_nb(nb_str):
 
 
 def test_convert_py_to_nb():
-    fixtures_path = Path(__file__).parent / "fixtures"
     python_str = (fixtures_path / "fake.py").read_text()
     actual_nb_str = convert_py_to_nb(python_str)
     expected_nb_str = (fixtures_path / "fake.ipynb").read_text()
@@ -32,7 +34,6 @@ def test_convert_py_to_nb():
 
 
 def test_convert_py_to_nb_execute():
-    fixtures_path = Path(__file__).parent / "fixtures"
     python_str = (fixtures_path / "fake.py").read_text()
     actual_nb_str = convert_py_to_nb(python_str, execute=True)
     expected_nb_str = (fixtures_path / "fake-executed.ipynb").read_text()

tests/test_template.py → tests/utils/test_templates.py

@@ -7,6 +7,7 @@
 from dp_creator_ii.utils.templates import _Template, make_notebook_py, make_script_py
 
 
+fixtures_path = Path(__file__).parent.parent / "fixtures"
 fake_csv = "tests/fixtures/fake.csv"
 
 
@@ -113,9 +114,7 @@ def clear_empty_lines(text):
         # Cleanup whitespace after indenting blocks
         return re.sub(r"^\s+$", "", text, flags=re.MULTILINE).strip()
 
-    expected_script = (
-        Path(__file__).parent / "fixtures" / "expected-script.py"
-    ).read_text()
+    expected_script = (fixtures_path / "expected-script.py").read_text()
     assert clear_empty_lines(script) == clear_empty_lines(expected_script)
 
     with NamedTemporaryFile(mode="w") as fp: