cleaning up code triggering redefined-outer-name pylint warning (pyte…

…st fixtures; function definitions within notebooks) (#1133)

.github/workflows/tests+artifacts+pypi.yml

@@ -109,7 +109,7 @@ jobs:
         pylint --max-module-lines=550 --unsafe-load-any-extension=y --disable=fixme,too-many-function-args,unsubscriptable-object,consider-using-with,protected-access,too-many-statements,too-many-public-methods,too-many-branches,duplicate-code,invalid-name,missing-function-docstring,missing-module-docstring,missing-class-docstring,too-many-locals,too-many-instance-attributes,too-few-public-methods,too-many-arguments,c-extension-no-member $(git ls-files '*.py' | grep ^examples)
     - run: |
         # TODO #682
-        nbqa pylint --unsafe-load-any-extension=y --disable=fixme,duplicate-code,invalid-name,trailing-whitespace,line-too-long,missing-function-docstring,wrong-import-position,missing-module-docstring,wrong-import-order,ungrouped-imports,no-member,too-many-locals,redefined-outer-name,unnecessary-lambda-assignment $(git ls-files '*.ipynb')
+        nbqa pylint --unsafe-load-any-extension=y --disable=fixme,duplicate-code,invalid-name,trailing-whitespace,line-too-long,missing-function-docstring,wrong-import-position,missing-module-docstring,wrong-import-order,ungrouped-imports,no-member,too-many-locals,unnecessary-lambda-assignment $(git ls-files '*.ipynb')
 
   zenodo_json:
     runs-on: ubuntu-latest

examples/PySDM_examples/Arabas_et_al_2023/aida.ipynb

@@ -236,17 +236,17 @@
    "source": [
     "d_dry, conc = spectral_sampling.ConstantMultiplicity(dNdD).sample(common['n_sd'])\n",
     "\n",
-    "attributes = {\n",
+    "ATTRIBUTES = {\n",
     "    'n': conc * common['volume'],\n",
     "    'dry volume': common['formulae'].trivia.volume(radius=d_dry / 2)\n",
     "}\n",
     "\n",
     "outputs = []\n",
-    "settings = [\n",
-    "    Settings(**common, attributes=dict(attributes), singular=False),\n",
-    "    Settings(**common, attributes=dict(attributes), singular=True),\n",
+    "SETTINGS = [\n",
+    "    Settings(**common, attributes=dict(ATTRIBUTES), singular=False),\n",
+    "    Settings(**common, attributes=dict(ATTRIBUTES), singular=True),\n",
     "]\n",
-    "for setting in settings:\n",
+    "for setting in SETTINGS:\n",
     "    simulation = Simulation(setting)\n",
     "    outputs.append(simulation.run())"
    ]
@@ -267,7 +267,7 @@
     "fig, axs = pyplot.subplots(4, 2, figsize=(10, 10), sharex=True)\n",
     "for i, output in enumerate(outputs):\n",
     "    axT = axs[0, i]\n",
-    "    axT.set_title(f\"singular={settings[i].singular}\")\n",
+    "    axT.set_title(f\"singular={SETTINGS[i].singular}\")\n",
     "    axT.grid()\n",
     "    axT.set_ylim(805, 1015)\n",
     "    axT.plot(output['time'], output['ambient pressure'], color='black', label='p')\n",

examples/PySDM_examples/Arabas_et_al_2023/copula_hello.ipynb

@@ -90,29 +90,29 @@
     "\n",
     "grid = np.meshgrid(T, A)\n",
     "\n",
-    "def pdf(T, A):\n",
-    "    return formulae.freezing_temperature_spectrum.pdf(T, A) * spectrum.pdf(A)\n",
+    "def pdf(T_arg, A_arg):\n",
+    "    return formulae.freezing_temperature_spectrum.pdf(T_arg, A_arg) * spectrum.pdf(A_arg)\n",
     "\n",
-    "def cdfA(A):\n",
-    "    return spectrum.cdf(A)\n",
+    "def cdfA(A_arg):\n",
+    "    return spectrum.cdf(A_arg)\n",
     "\n",
-    "def cdfT(T):\n",
-    "    return formulae.freezing_temperature_spectrum.cdf(T, spectrum.median)\n",
+    "def cdfT(T_arg):\n",
+    "    return formulae.freezing_temperature_spectrum.cdf(T_arg, spectrum.median)\n",
     "\n",
     "def invcdfA(x):\n",
     "    return spectrum.percentiles(x)\n",
     "\n",
     "def invcdfT(x):\n",
     "    return formulae.freezing_temperature_spectrum.invcdf(x, spectrum.median)\n",
     "\n",
-    "def _T_to_01(T):\n",
-    "    return (T - T_range[0]) / np.diff(T_range)\n",
+    "def _T_to_01(T_arg):\n",
+    "    return (T_arg - T_range[0]) / np.diff(T_range)\n",
     "\n",
     "def _01_to_T(x):\n",
     "    return x * np.diff(T_range) + T_range[0]\n",
     "\n",
-    "def _A_to_01(A):\n",
-    "    return (A - A_range[0]) / np.diff(A_range)\n",
+    "def _A_to_01(A_arg):\n",
+    "    return (A_arg - A_range[0]) / np.diff(A_range)\n",
     "    \n",
     "def _01_to_A(x):\n",
     "    return x * np.diff(A_range) + A_range[0]\n",
@@ -182,8 +182,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def jointplot(data, title=''):\n",
-    "    h = seaborn.jointplot(x=data[:, 0], y=data[:, 1], kind='hex', label=title)\n",
+    "def jointplot(data_arg, title=''):\n",
+    "    h = seaborn.jointplot(x=data_arg[:, 0], y=data_arg[:, 1], kind='hex', label=title)\n",
     "    h.set_axis_labels(label_T, label_A)\n",
     "    if title != '':\n",
     "        pyplot.legend(loc='upper right')"

examples/PySDM_examples/Arabas_et_al_2023/fig_11.ipynb

@@ -384,12 +384,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def label(settings):\n",
-    "    lbl = str({k.replace('condensation_', ''):\n",
+    "def label(settings_arg):\n",
+    "    tmp = str({k.replace('condensation_', ''):\n",
     "               f\"{v:.1e}\" if isinstance(v, float) else\n",
     "               str(v).zfill(2) if isinstance(v, int) else\n",
-    "               v for k, v in settings.items()})\n",
-    "    return lbl\\\n",
+    "               v for k, v in settings_arg.items()})\n",
+    "    return tmp\\\n",
     "        .replace('{', '')\\\n",
     "        .replace('}', '')\\\n",
     "        .replace(\"'\", '')\\\n",

examples/PySDM_examples/Arabas_et_al_2023/fig_2.ipynb

@@ -50,8 +50,8 @@
     "svp = Formulae(saturation_vapour_pressure='FlatauWalkoCotton').saturation_vapour_pressure\n",
     "T = np.linspace(*TEMP_RANGE) * si.K\n",
     "\n",
-    "def _T(T):\n",
-    "    return (T/si.K).to_base_units().magnitude\n",
+    "def _T(TK):\n",
+    "    return (TK/si.K).to_base_units().magnitude\n",
     "\n",
     "a_w_ice = svp.ice_Celsius(_T(T) - const.T0) / svp.pvs_Celsius(_T(T) - const.T0)"
    ]

examples/PySDM_examples/Arabas_et_al_2023/fig_convergence.ipynb

@@ -28,20 +28,20 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def _plot_fit(fit_x, fit_y, low, hgh, total_time):\n",
+    "def _plot_fit(fit_x_arg, fit_y_arg, low_arg, hgh_arg, total_time_arg):\n",
     "    pyplot.plot(\n",
-    "        fit_x, fit_y, color=\"black\", linestyle=\"--\", label=\"theory\", linewidth=5\n",
+    "        fit_x_arg, fit_y_arg, color=\"black\", linestyle=\"--\", label=\"theory\", linewidth=5\n",
     "    )\n",
     "    pyplot.plot(\n",
-    "        fit_x, hgh(fit_x), color=\"black\", linestyle=\":\", label=\"assert upper bound\"\n",
+    "        fit_x_arg, hgh_arg(fit_x_arg), color=\"black\", linestyle=\":\", label=\"assert upper bound\"\n",
     "    )\n",
     "    pyplot.plot(\n",
-    "        fit_x, low(fit_x), color=\"black\", linestyle=\":\", label=\"assert lower bound\"\n",
+    "        fit_x_arg, low_arg(fit_x_arg), color=\"black\", linestyle=\":\", label=\"assert lower bound\"\n",
     "    )\n",
     "    pyplot.legend()\n",
     "    pyplot.yscale(\"log\")\n",
-    "    pyplot.ylim(fit_y[-1], fit_y[0])\n",
-    "    pyplot.xlim(None, total_time)\n",
+    "    pyplot.ylim(fit_y_arg[-1], fit_y_arg[0])\n",
+    "    pyplot.xlim(None, total_time_arg)\n",
     "    pyplot.xlabel(\"time [s]\")\n",
     "    pyplot.ylabel(\"unfrozen fraction\")\n",
     "    pyplot.grid()"

examples/PySDM_examples/Arabas_et_al_2023/figs_3_and_7_and_8.ipynb

@@ -46,8 +46,8 @@
     "    constants=constants\n",
     ")\n",
     "\n",
-    "def A_spec(ln_s_geom):\n",
-    "    return Lognormal(norm_factor=1, m_mode=LOGNORMAL_MODE_SURF_A, s_geom=np.exp(ln_s_geom))"
+    "def A_spec(ln_s_geom_arg):\n",
+    "    return Lognormal(norm_factor=1, m_mode=LOGNORMAL_MODE_SURF_A, s_geom=np.exp(ln_s_geom_arg))"
    ]
   },
   {
@@ -17394,7 +17394,7 @@
     "              drop_v_um3,\n",
     "              ln10_drop_n,\n",
     "              ln10_vol_m3,\n",
-    "              ln_s_geom,\n",
+    "              ln_s_geom_arg,\n",
     "              times,\n",
     "              temps\n",
     "             ):\n",
@@ -17411,12 +17411,12 @@
     "    )\n",
     "    assert temperature_profile.x[0] == 0\n",
     "    \n",
-    "    params = {\n",
+    "    common_params = {\n",
     "        'droplet_volume': drop_v_um3 * si.um**3,\n",
     "        'total_particle_number': 10**ln10_drop_n,\n",
     "        'volume': 10**ln10_vol_m3\n",
     "    }\n",
-    "    surf_spec=A_spec(ln_s_geom)\n",
+    "    surf_spec=A_spec(ln_s_geom_arg)\n",
     "    \n",
     "    output = []\n",
     "    for singular in (True, False):\n",
@@ -17430,7 +17430,7 @@
     "                seed=seed,\n",
     "                shima_T_fz=formulae.freezing_temperature_spectrum.__name__,\n",
     "                ABIFM_spec=surf_spec,\n",
-    "                **params\n",
+    "                **common_params\n",
     "            )\n",
     "            output.append({\n",
     "                **run_simulation(particulator, temperature_profile, n_steps),\n",
@@ -17447,7 +17447,7 @@
     "        output, \n",
     "        formulae, \n",
     "        surf_spec=surf_spec,\n",
-    "        **params,\n",
+    "        **common_params,\n",
     "        cooling_rate_K_min=cooling_rate_K_min\n",
     "    )\n",
     "    show_plot(f'fig2-c={cooling_rate_K_min}_K_per_min-ln_s_geom={ln_s_geom}.pdf')"
@@ -28354,7 +28354,7 @@
     "for ln_s_geom in (BEST_FIT_LN_S_GEOM, 5*BEST_FIT_LN_S_GEOM, 10*BEST_FIT_LN_S_GEOM):    \n",
     "    run_and_plot(\n",
     "        **params,\n",
-    "        ln_s_geom=ln_s_geom,\n",
+    "        ln_s_geom_arg=ln_s_geom,\n",
     "        times=np.asarray([0, dT / base_cooling_rate]),\n",
     "        temps=np.asarray(list(TEMP_RANGE))\n",
     "    )"
@@ -39258,7 +39258,7 @@
     "for cooling_rate in COOLING_RATES:\n",
     "    run_and_plot(\n",
     "        **params,\n",
-    "        ln_s_geom=BEST_FIT_LN_S_GEOM,\n",
+    "        ln_s_geom_arg=BEST_FIT_LN_S_GEOM,\n",
     "        times=np.asarray([0, dT / cooling_rate]),\n",
     "        temps=np.asarray(list(TEMP_RANGE))\n",
     "    )"