a2p2 0.7.4__py3-none-any.whl → 0.7.6__py3-none-any.whl

a2p2/jmmc/catalogs.py

@@ -4,6 +4,9 @@ __all__ = []
 
 import logging
 
+import pyvo
+import astropy.table.table
+
 from ..client import A2P2ClientPreferences
 
 from .utils import JmmcAPI
@@ -17,20 +20,36 @@ class Catalog():
         Credential can be explicitly given for method that require an authentication, else:
         - a2p2 preferences login will be used if present (see a2p2 -c)
         - or uses .netrc file
+        A where clause can be added to limit on rows of interest (adql syntax)
+        A joins list of dictionnary can be provided to combine this catalog to other ones ( format is: [{"name":"cattojoin","id":"commonkey"},...] )
     """
 
-    def __init__(self, catalogName, username=None, password=None, prod=False, apiUrl=None):
+    def __init__(self, catalogName, username=None, password=None, prod=False, apiUrl=None, tapUrl=None, where=None, joins=None):
         self.catalogName = catalogName
+        self.where = where
+        self.joins = joins
         self.prod = prod
+        self.colDelimiterName = "coldelimiter___"
 
         # Manage prod & preprod or user provided access points
         if apiUrl:
             self.apiUrl = apiUrl  # trust given url as catalogAPI if value is provided
-        elif self.prod:
-            self.apiUrl = "https://oidb.jmmc.fr/restxq/catalogs"
-        else:
-            self.apiUrl = "https://oidb-beta.jmmc.fr/restxq/catalogs"
-
+        if tapUrl:
+            self.tapUrl = tapUrl  # trust given url as TAP server if value is provided
+
+        if not(apiUrl):
+            if self.prod:
+                self.apiUrl = "https://oidb.jmmc.fr/restxq/catalogs"
+            else:
+                self.apiUrl = "https://oidb-beta.jmmc.fr/restxq/catalogs"
+
+        if not(tapUrl):
+            if self.prod:
+                self.tapUrl = "https://tap.jmmc.fr/vollt/tap"
+            else:
+                self.tapUrl = "https://tap-preprod.jmmc.fr/vollt/tap"
+
+        self.tap = pyvo.dal.TAPService(self.tapUrl)
         self.api = JmmcAPI(self.apiUrl, username, password)
 
         logger.info(f"Create catalog wrapper to access '{catalogName}' ({PRODLABEL[self.prod]} API at {self.api.rootURL})")
@@ -40,7 +59,7 @@ class Catalog():
         return self.api._get("")
 
     def metadata(self):
-        """ Get catalog metadata """
+        """ Get catalog metadata"""
         return self.api._get(f"/meta/{self.catalogName}")
 
     def pis(self):
@@ -66,12 +85,82 @@ class Catalog():
                 return pi["name"]
 
     def getRow(self, id):
-        """ Get a single catalog record for the given id.
+        """ Get a single catalog record for the given id on the main catalog.
 
             usage: cat.getRow(42)
         """
         return self.api._get(f"/{self.catalogName}/{id}")
 
+    def getDataFrame(self):
+        """ Get a pandas DataFrame from the main catalog joined the other if provided in constructor.
+
+            usage: cat.getDataFrame()
+        """
+
+        return self.getTable().to_pandas()
+
+    def getTable(self, maxrec=10000):
+        """ Get an astropy table from the main catalog joined the other if provided in constructor.
+
+            usage: cat.getTable()
+        """
+        # using SELECT TOP N below to workarround astroquery.utils.tap BUG
+
+        clauses = []
+        if self.joins :
+            joinedCatalogNames = []
+            for join in self.joins:
+                joinedCatalogNames.append(join["name"] + ".*")
+
+            # colDelimiterName is added so we can keep the mainCatalog colnames for later updates (using rowsToDict)
+            clauses.append(f"SELECT TOP {maxrec} {self.catalogName}.*, '' as {self.colDelimiterName}, {', '.join(joinedCatalogNames)} FROM {self.catalogName}" )
+
+            for join in self.joins:
+                if "catalogKey" in join.keys():
+                    catalogKey=join["catalogKey"]
+                else:
+                    # we could use the (cached) metadata key, but this would add a additional remote call.A2P2ClientPreferences
+                    # let's try with this convention using the same key name
+                    catalogKey=join["id"]
+                name=join["name"]
+                id=join["id"]
+                # LEFT JOIN may be an option provided by join key ?
+                clauses.append (f" LEFT JOIN {name} ON {self.catalogName}.{catalogKey} = {name}.{id}")
+
+            if self.where:
+                clauses.append(f" WHERE {self.catalogName}.{self.where}")
+        else:
+            clauses.append(f"SELECT TOP {maxrec} * FROM {self.catalogName}")
+            if self.where:
+                clauses.append(f" WHERE {self.where}")
+
+        query = "  ".join(clauses)
+        logger.info(f"Querying remote catalog : {query}")
+        return self.tap.search(query,maxrec=maxrec).to_table()
+
+    def tableToDict(self, table):
+        """ Convert table (astropy.table or row) to a list of dict so we can modify content and update remote catalog using updateRows().
+
+            usage: cat.tableToDict(table)
+        """
+        colnames = table.colnames
+        if "coldelimiter___" in colnames:
+            colnames = colnames[0:colnames.index("coldelimiter___")]
+        dicts=[]
+        # handle single row case
+        table = table if isinstance(table, astropy.table.table.Table ) else [table]
+        for row in table:
+            dict = {}
+            for colname in colnames:
+                v=row[colname]
+                if isinstance(v,str):
+                    dict[colname] = v
+                else:
+                    # avoid np.numeric type to make it json serializable
+                    dict[colname] = v.item()
+            dicts.append(dict)
+        return dicts
+
     def updateRow(self, id, values):
         """ Update record identified by given id and associated values.
 
@@ -87,6 +176,7 @@ class Catalog():
         """
 
         # We may check befere sending payload that we always provide an id for every record
+        # What is the behaviour if we provide various data assosiated to the same id ?
         return self.api._put(f"/{self.catalogName}", values)
 
     def addRows(self, values):
@@ -97,6 +187,7 @@ class Catalog():
         """
         return self.api._post(f"/{self.catalogName}", json=values)
 
+
     def getDelegations(self, pi=None):
         """ Get -all- delegations.
             A specific pi parameter may be given but requires admin priviledges. Else use current piname will be used by remote service.

a2p2/version.py

@@ -1,4 +1,4 @@
-__version__ = "0.7.4"
+__version__ = "0.7.6"
 
 __release_notes__ = {
     # "0.1.6": {
@@ -23,7 +23,15 @@ __release_notes__ = {
 #          "Try to read OB in P2 and send them back to Aspro2 as a new obs",
 #      ],
 
-    "0.7.4": {
+    "0.7.6": {
+       "A2P2": [
+           "add getDataFrame() to a2p2.jmmc.Catalog to provide remote data with pandas format",
+        ],
+    },"0.7.5": {
+       "A2P2": [
+           "Add support for join and filter in a2p2.jmmc.Catalog wrapper",
+        ],
+    },"0.7.4": {
        "A2P2": [
            "Use pyproject.toml for python installation",
         ],"VLTI": [

{a2p2-0.7.4.dist-info → a2p2-0.7.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: a2p2
-Version: 0.7.4
+Version: 0.7.6
 Author-email: JMMC Tech Group <jmmc-tech-group@jmmc.fr>
 License: OSI Approved :: GNU General Public License v3 (GPLv3)
 Project-URL: Homepage, https://www.jmmc.fr/a2p2
@@ -15,8 +15,10 @@ Requires-Python: >=3
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: appdirs
-Requires-Dist: astropy >=5.2.2
+Requires-Dist: astropy>=5.2.2
+Requires-Dist: pyvo>=1.6.1
 Requires-Dist: p2api
+Dynamic: license-file
 
 a2p2 |A2P2Badge|
 ================

{a2p2-0.7.4.dist-info → a2p2-0.7.6.dist-info}/RECORD

@@ -7,12 +7,12 @@ a2p2/instrument.py,sha256=JI1i8vsGu1ku_3i7my278b8y8vL5Z-SF3V8XkHPSs48,732
 a2p2/ob.py,sha256=lcSm5eXv79K6cjp0VxvxD4sSlsBTKHGbmT85XEx74lY,6268
 a2p2/samp.py,sha256=DN20lWszkuuneR1BV1MBLEyoGyN8tZWvOeC5rEVLICo,3438
 a2p2/utils.py,sha256=QEA9cpc2TaqXDa4yqrFiGkCl__1wV8--rVw_A-p_HM0,23833
-a2p2/version.py,sha256=_N6fsRiq6jonys8LHzHhDDHK23gABI2vSSLu4quaQDM,12353
+a2p2/version.py,sha256=SBcM00GM4AaYrNLt35Q9OmYC5RG20coTbavUQYpboB0,12614
 a2p2/chara/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 a2p2/chara/facility.py,sha256=otv0UVQVYD7dE_ENojjatjld5owgM9qRm7vsAc0jyqQ,2754
 a2p2/chara/gui.py,sha256=4O8u-g-UJSeqEV9CUPNflVNWIsmH0b_xf8c9huxAivs,5119
 a2p2/jmmc/__init__.py,sha256=Yx8Ae77UQA_aLMzhKgWym4m2fbMR_4m77TGfaXy6I4A,187
-a2p2/jmmc/catalogs.py,sha256=8hf8nUVfAdgROpPGzP-aD4Haulp7lWGCSHod5ZhmJNM,4801
+a2p2/jmmc/catalogs.py,sha256=bEmG_gkte5uGeKcbsnz6BTMYLnWB4HFpp_XmgSxcwyg,8624
 a2p2/jmmc/generated_models.py,sha256=69fmPfkCMBc0GyDeHp1rs0vkoPqOE4j0egMBWX5mB1U,11823
 a2p2/jmmc/models.py,sha256=ikI8Dk-9ThkG1uHtoPJwB43tPF_YZj8M5tftIcJio7s,3776
 a2p2/jmmc/services.py,sha256=kcRaRnR4COKijF5izDqqNHjKyU1j2H8PEPvbDsBUFcw,312
@@ -31,9 +31,9 @@ a2p2/vlti/conf/MATISSE_ditTable.json,sha256=2RQXb9UL1_VlcAAGoxqpe3nTrRfO4gyOX_IG
 a2p2/vlti/conf/MATISSE_rangeTable.json,sha256=_j5m-EOh4bbfwdaANdh23yjgNef95AUku_uNujr9BDc,5770
 a2p2/vlti/conf/PIONIER_ditTable.json,sha256=BKK7nF0nE_LOP44l_fAvAnpG8oOq5p9srcdTNQ2udKo,857
 a2p2/vlti/conf/PIONIER_rangeTable.json,sha256=71Ycm2h-uBUVSAWy6lTpaBDOYwKKL5MuZH6F5ESHOI0,2113
-a2p2-0.7.4.dist-info/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
-a2p2-0.7.4.dist-info/METADATA,sha256=igT2BELh2nCRDMYuJO5C_tgKxWS9LJWz1eBgKyHHUDA,4140
-a2p2-0.7.4.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-a2p2-0.7.4.dist-info/entry_points.txt,sha256=5Pq7faxs04hSEtjpqtBAlHw3cGUpvTmBugnS5PzgJMY,44
-a2p2-0.7.4.dist-info/top_level.txt,sha256=lLDb6xGRyHYSbrO0EUx8vNEzTiCDtPe2z7PSbqGY4kE,5
-a2p2-0.7.4.dist-info/RECORD,,
+a2p2-0.7.6.dist-info/licenses/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+a2p2-0.7.6.dist-info/METADATA,sha256=7JQoo7_dNUObegDtEqWxnsdSkFIOZOeTziMDx7hKyTY,4188
+a2p2-0.7.6.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+a2p2-0.7.6.dist-info/entry_points.txt,sha256=5Pq7faxs04hSEtjpqtBAlHw3cGUpvTmBugnS5PzgJMY,44
+a2p2-0.7.6.dist-info/top_level.txt,sha256=lLDb6xGRyHYSbrO0EUx8vNEzTiCDtPe2z7PSbqGY4kE,5
+a2p2-0.7.6.dist-info/RECORD,,

{a2p2-0.7.4.dist-info → a2p2-0.7.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any