104 migrate fink broker to dataservice by phycodurus · Pull Request #112 · TOMToolkit/tom_fink

phycodurus · 2026-02-17T23:35:02Z

Adds FinkDataService class; deprecates FinkBroker

My tests are passing with poetry run python tom_fink/tests/run_tests.py and a local, but un altered tom_base (dev).

In this case, make the Fink broker appear in TOMToolkit's list of DataServices, when tom_fink is INSTALLED. TOMToolkit will look for certain methods in the AppConfig of a TOM's INSTALLED_APPS to ask the App how to integrate it into the TOM. This makes apps more self contained and reduces app-specific configuration data in settings.py.

This is part of the "DataServices refactor" of the Fink broker interface.

- minimal form changes: remove GenericQueryForm.common_layout (it is replaced by layout in the BaseQueryForm) - the FinkBroker has been removed - FinkBroker.to_generic_alert and FinkBroker.to_target functionality condensed into create_target_from_query - FinkerBroker.fetch_alerts is now FinkDataService._fetch_alerts and FinkDataServic.query_service just calls _fetch_alerts.

condense query results in to structure suitable for presenting in the selectable "create target" table.

The target table row dictionary was updated to be appropriate for one-target-one-row. These changes follow from that and use the appropriate dict keys to get the data to create the target.

Setting up these DataService subclass properties in this way allows the base class to display this info on the RunQueryView, etc.

...using the DataService base class methods and compatibly-written partials.

...by implementing query_photometry() method

The data is already in memory (in the response JSON payload). So, there's not advantage to converting it to an Iterator. Other refactor: group target method together and photometry methods togeter.

phycodurus · 2026-03-03T20:05:24Z

The latest commits implement Photometry updating and divide the Form into Simple and Advanced using the DataSerivce base class-provided mechanisms.

jchate6

Also, the README needs to be updated.

Let me know if you want to go through this, or have me make these changes.

jchate6 · 2026-03-12T22:48:47Z

tom_fink/tests/boot_django.py

Should probably actually have some tests.

jchate6 · 2026-03-12T22:49:27Z

tom_fink/fink.py

+
+class FinkDataService(DataService):
+    """
+    This is an Example Data Service with the minimum required


need real doc string

jchate6 · 2026-03-12T23:03:08Z

tom_fink/fink.py

+
+    def build_query_parameters(self, parameters, **kwargs):
+        """
+        Use this function to convert the form results into the query parameters understood


Better doc string.

jchate6 · 2026-03-12T23:13:43Z

tom_fink/fink.py

+        self.query_parameters = parameters
+        return self.query_parameters
+
+    def _fetch_alerts(self, parameters: dict) -> Iterator:


This function effectively ignores the point of having a build_query_parameters. You are including both the functionality of translating form fields into fink-readable parameters (class_name, n_alert = parameters["classsearch"].split(",")) and the submission of a valid request to fink.
This makes this more difficult to test and maintain.

jchate6 · 2026-03-12T23:16:06Z

tom_fink/fink.py

+                    "stopdate": end,
+                },
+            )
+        elif len(parameters["ssosearch"].strip()) > 0:


If this functionality isn't working, it should be (temporarily) removed from the query form and this method.

jchate6 · 2026-03-12T23:26:11Z

tom_fink/fink.py

+        :param self: Description
+        :param target_result: Dict of Target data for selected Target
+        :type target_result: Dict[str, Any]
+        :param kwargs: Description


jchate6 · 2026-03-12T23:27:19Z

tom_fink/fink.py

+        """
+
+        # extract values from query target_result and create Target
+        # NOTE: use constructor, not get_or_create, CreateTargetFromQueryView will save the Target


This is now in to_target to keep it out of the view and give the data service access.

jchate6 · 2026-03-12T23:42:31Z

tom_fink/fink.py

+            # search among the target's aliases for something that starts with 'ZTF'
+            ztf_aliases = target.aliases.filter(name__startswith='ZTF').order_by('-created')
+            if not ztf_aliases.exists():
+                raise ValueError(


this should use QueryServiceError imported from tom_dataservices.dataservices
I'll add a note about this to the basic docs.

jchate6 · 2026-03-12T23:43:55Z

tom_fink/fink.py

+    # Photometry
+    #
+
+    def query_photometry(self, query_parameters, **kwargs):


No Docstring

A lot of your comments in this section would be better captured in the doc string.

jchate6 · 2026-03-12T23:46:25Z

tom_fink/fink.py

+                target=target,
+                timestamp=timestamp,
+                data_type=data_type,
+                source_name='Fink',


Use self.name for consistency.

phycodurus added 5 commits February 17, 2026 15:18

Add DataServic imports and do some re-ordering

155b860

update FINK_API_URL to distinguish between ZTF and LSST

3a08973

adapt (legacy) FinkQueryForm to (new) FinkServiceForm

7ad3d4a

This is part of the "DataServices refactor" of the Fink broker interface.

Add FinkDataService; for now, as a thin wrapper around FinkBroker

6182f74

phycodurus linked an issue Feb 17, 2026 that may be closed by this pull request

Migrate Fink Broker to DataService #104

Open

7 tasks

phycodurus added 9 commits February 18, 2026 16:43

create ReducedDatum objects from Fink alert data for a given Target

c2f2d1a

re-write query_targets to process Alerts for the queried Target

258594f

condense query results in to structure suitable for presenting in the selectable "create target" table.

update Target create call to use values from target table row dict

2cbfa03

The target table row dictionary was updated to be appropriate for one-target-one-row. These changes follow from that and use the appropriate dict keys to get the data to create the target.

clean up and improve doc strings

04da2a8

add filter ID to return columns and convert to filter name

90725a5

an error value is necessary for plotting (0.0 means 'unknown')

7368bb9

update run_tests.py and restore (deprecated) code for tests

a4ba339

phycodurus requested a review from jchate6 February 23, 2026 21:26

phycodurus marked this pull request as ready for review February 23, 2026 21:26

jchate6 added this to TOM Toolkit Feb 27, 2026

jchate6 moved this to Needs Review in TOM Toolkit Feb 27, 2026

phycodurus added 4 commits March 3, 2026 11:48

add DataService class properties for versioning and repo link

c390141

Setting up these DataService subclass properties in this way allows the base class to display this info on the RunQueryView, etc.

Organize the Query Form into Simple and Advance forms

4c7310c

...using the DataService base class methods and compatibly-written partials.

Allow for updating photometry of an existing Target

c088beb

...by implementing query_photometry() method

largely a refactor, but removes Iterator in favor of List

97bcf7e

The data is already in memory (in the response JSON payload). So, there's not advantage to converting it to an Iterator. Other refactor: group target method together and photometry methods togeter.

jchate6 added 2 commits March 12, 2026 14:20

update dependencies

b4f7158

simplify forms

95a0cce

jchate6 requested changes Mar 12, 2026

View reviewed changes

Conversation

phycodurus commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

phycodurus commented Mar 3, 2026

Uh oh!

jchate6 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jchate6 Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

phycodurus commented Feb 17, 2026 •

edited

Loading

jchate6 Mar 12, 2026 •

edited

Loading