Merge global refactoring to Master

.github/workflows/python-tests.yml

@@ -11,13 +11,16 @@ on:
 jobs:
   python-tests:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8, 3.12]
     steps:
       - name: "Checkout branch"
         uses: actions/checkout@v4
       - name: "Set up Python on Ubuntu"
         uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: ${{ matrix.python-version }}
       - name: "Python codestyle"
         run: |
           pip install ".[dev]"

CHANGELOG.md

@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Change the jslink target trait from `target` to `shared_target` (#80)
 - Change the jslink fov trait from `fov` to `shared_fov` (#83)
+- Deprecate the `add_listener` method for a preferred use of `set_listener` method (#82)
 
 ## [0.3.0]
 

examples/10_Advanced-GUI.ipynb

@@ -36,7 +36,14 @@
     ")\n",
     "\n",
     "\n",
-    "def on_survey_value_change(change):\n",
+    "def on_survey_value_change(change: dict) -> None:\n",
+    "    \"\"\"Survey change callback.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    change : dict\n",
+    "        The change dictionary.\n",
+    "    \"\"\"\n",
     "    aladin.survey = change[\"new\"]\n",
     "\n",
     "\n",
@@ -63,7 +70,14 @@
     ")\n",
     "\n",
     "\n",
-    "def on_survey_overlay_value_change(change):\n",
+    "def on_survey_overlay_value_change(change: dict) -> None:\n",
+    "    \"\"\"Survey overlay change callback.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    change : dict\n",
+    "        The change dictionary.\n",
+    "    \"\"\"\n",
     "    aladin.overlay_survey = change[\"new\"]\n",
     "    aladin.overlay_survey_opacity = aladin.overlay_survey_opacity + 0.00000001\n",
     "\n",
@@ -84,7 +98,14 @@
     ")\n",
     "\n",
     "\n",
-    "def on_surveyoverlay_opacity_value_change(change):\n",
+    "def on_surveyoverlay_opacity_value_change(change: dict) -> None:\n",
+    "    \"\"\"Survey overlay opacity change callback.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    change : dict\n",
+    "        The change dictionary.\n",
+    "    \"\"\"\n",
     "    aladin.overlay_survey_opacity = change[\"new\"]\n",
     "\n",
     "\n",
@@ -105,7 +126,14 @@
     ")\n",
     "\n",
     "\n",
-    "def on_zoom_slider_value_change(change):\n",
+    "def on_zoom_slider_value_change(change: dict) -> None:\n",
+    "    \"\"\"Zoom slider change callback.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    change : dict\n",
+    "        The change dictionary.\n",
+    "    \"\"\"\n",
     "    aladin.fov = 180 / change[\"new\"]\n",
     "\n",
     "\n",

examples/2_Base_Commands.ipynb

@@ -71,6 +71,13 @@
     "aladin.target = \"sgr a*\""
    ]
   },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": "aladin.target"
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -122,6 +129,32 @@
    "source": [
     "aladin.coo_frame"
    ]
+  },
+  {
+   "metadata": {},
+   "cell_type": "markdown",
+   "source": "Some commands can be used with astropy objects"
+  },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": "from astropy.coordinates import Angle, SkyCoord"
+  },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": "aladin.target = SkyCoord(\"12h00m00s\", \"-30d00m00s\", frame=\"icrs\")"
+  },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": "aladin.fov = Angle(5, \"deg\")"
   }
  ],
  "metadata": {

examples/3_Functions.ipynb

@@ -53,7 +53,7 @@
     "    \"http://vizier.u-strasbg.fr/viz-bin/votable?-source=HIP2&-c=LMC&-out.add=_RAJ,_\"\n",
     "    \"DEJ&-oc.form=dm&-out.meta=DhuL&-out.max=9999&-c.rm=180\"\n",
     ")\n",
-    "options = {\"sourceSize\": 12, \"color\": \"#f08080\", \"onClick\": \"showTable\"}\n",
+    "options = {\"source_size\": 12, \"color\": \"#f08080\", \"on_click\": \"showTable\"}\n",
     "aladin.add_catalog_from_URL(url, options)"
    ]
   },
@@ -79,21 +79,35 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def getObjectData(data):\n",
+    "def get_object_data(data: dict) -> dict:\n",
+    "    \"\"\"Print the clicked object data.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    data : dict\n",
+    "        The data of the clicked object.\n",
+    "    \"\"\"\n",
     "    print(\"It clicked.\")\n",
     "    return data\n",
     "\n",
     "\n",
-    "def getObjectRaDecProduct(data):\n",
+    "def get_object_ra_dec_product(data: dict) -> float:\n",
+    "    \"\"\"Return the product of the ra and dec values of the clicked object.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    data : dict\n",
+    "        The data of the clicked object.\n",
+    "    \"\"\"\n",
     "    return data[\"ra\"] * data[\"dec\"]\n",
     "\n",
     "\n",
     "# when triggered, the listeners on the js side of the application will send a\n",
     "# json object whose parameter data will be used by the python functions\n",
     "# (data is a literal object on the js side, it will be converted as a dictionary\n",
     "# object on the python side)\n",
-    "aladin.add_listener(\"object_hovered\", getObjectRaDecProduct)\n",
-    "aladin.add_listener(\"object_clicked\", getObjectData)"
+    "aladin.set_listener(\"object_hovered\", get_object_ra_dec_product)\n",
+    "aladin.set_listener(\"object_clicked\", get_object_data)"
    ]
   },
   {

examples/4_Importing_Tables.ipynb

@@ -58,7 +58,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "aladin.add_table(table, shape=\"rhomb\", color=\"lightskyblue\", sourceSize=20)"
+    "aladin.add_table(table, shape=\"rhomb\", color=\"lightskyblue\", source_size=20)\n",
+    "# This line also works with camelCase instead of snake_case: sourceSize=20"
    ]
   },
   {

examples/5_Display_a_MOC.ipynb

@@ -284,7 +284,9 @@
     "    external_radius=20 * u.deg,\n",
     "    max_depth=16,\n",
     ")\n",
-    "aladin.add_moc(moc, color=\"teal\", edge=True, lineWidth=3, fillColor=\"teal\", opacity=0.5)"
+    "aladin.add_moc(\n",
+    "    moc, color=\"teal\", edge=True, line_width=3, fill_color=\"teal\", opacity=0.5\n",
+    ")"
    ]
   }
  ],

examples/6_Linked-widgets.ipynb

@@ -27,12 +27,12 @@
     "c = Aladin(layout=Layout(width=\"33.33%\"), survey=\"P/2MASS/color\", **cosmetic_options)\n",
     "\n",
     "# synchronize target between 3 widgets\n",
-    "widgets.jslink((a, \"shared_target\"), (b, \"shared_target\"))\n",
-    "widgets.jslink((b, \"shared_target\"), (c, \"shared_target\"))\n",
+    "widgets.jslink((a, \"_target\"), (b, \"_target\"))\n",
+    "widgets.jslink((b, \"_target\"), (c, \"_target\"))\n",
     "\n",
     "# synchronize FoV (zoom level) between 3 widgets\n",
-    "widgets.jslink((a, \"shared_fov\"), (b, \"shared_fov\"))\n",
-    "widgets.jslink((b, \"shared_fov\"), (c, \"shared_fov\"))\n",
+    "widgets.jslink((a, \"_fov\"), (b, \"_fov\"))\n",
+    "widgets.jslink((b, \"_fov\"), (c, \"_fov\"))\n",
     "\n",
     "items = [a, b, c]\n",
     "\n",

examples/7_on-click-callback.ipynb

@@ -37,7 +37,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def process_result(data):\n",
+    "def process_result(data: dict) -> None:\n",
+    "    \"\"\"Process the result of a click event on the Aladin widget.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    data : dict\n",
+    "        The data returned by the click event.\n",
+    "    \"\"\"\n",
     "    info.value = \"\"\n",
     "    ra = data[\"ra\"]\n",
     "    dec = data[\"dec\"]\n",
@@ -78,7 +85,7 @@
     "    info.value = \"<h2>%s</h2><br><br>%s\" % (obj_name, sed_img)\n",
     "\n",
     "\n",
-    "aladin.add_listener(\"click\", process_result)"
+    "aladin.set_listener(\"click\", process_result)"
    ]
   },
   {

examples/8_Rectangular-selection.ipynb

@@ -33,7 +33,16 @@
     "button = widgets.Button(description=\"Select\")\n",
     "\n",
     "\n",
-    "def on_button_clicked(b):  # noqa: ARG001\n",
+    "def on_button_clicked(_: any) -> None:\n",
+    "    \"\"\"Button click event callback.\n",
+    "\n",
+    "    It will trigger the rectangular selection in the Aladin widget.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    _: any\n",
+    "        The button widget that triggered the event.\n",
+    "    \"\"\"\n",
     "    aladin.rectangular_selection()\n",
     "\n",
     "\n",
@@ -61,7 +70,14 @@
     "aladin.add_table(table)\n",
     "\n",
     "\n",
-    "def process_result(sources):\n",
+    "def process_result(sources: dict) -> None:\n",
+    "    \"\"\"Process the sources selected in the Aladin widget and display them in the table.\n",
+    "\n",
+    "    Parameters\n",
+    "    ----------\n",
+    "    sources: dict\n",
+    "        The sources selected in the Aladin widget.\n",
+    "    \"\"\"\n",
     "    s = '<table border=\"1\">'\n",
     "    s += \"<tr><th>MAIN_ID</th><th>RA</th><th>DEC</th></tr>\"\n",
     "    for source in sources:\n",
@@ -74,7 +90,7 @@
     "    table_info.value = s\n",
     "\n",
     "\n",
-    "aladin.add_listener(\"select\", process_result)"
+    "aladin.set_listener(\"select\", process_result)"
    ]
   }
  ],

js/aladin_lite.js

@@ -0,0 +1,3 @@
+import A from "https://esm.sh/[email protected]";
+
+export default A;