Merge pull request #2970 from esdc-esac-esa-int/ESA_gaia_include_table_size_in_TapTableMeta

GAIA: include table size in the class TapTableMeta

Author: bsipocz

CHANGES.rst

@@ -24,6 +24,13 @@ utils.tap
   dot. ``ValueError`` is now raised for such cases. [#2971]
 
 
+gaia
+^^^^
+
+- Include table size in the class TapTableMeta returned by the functions load_tables and load_table, in the class Tap.
+  [#2970]
+
+
 0.4.7 (2024-03-08)
 ==================
 
@@ -219,6 +226,7 @@ gaia
 
 - Default Gaia catalog updated to DR3. [#2596]
 
+
 heasarc
 ^^^^^^^
 

astroquery/utils/tap/core.py

@@ -143,7 +143,8 @@ def __internalInit(self):
         self.tap_client_id = f"aqtappy1-{VERSION}"
 
     def load_tables(self, *, verbose=False):
-        """Loads all public tables
+        """Loads all public table metadata. If the user is logged in, it also returns metadata for those tables in the
+        user's private area.
 
         Parameters
         ----------
@@ -152,12 +153,13 @@ def load_tables(self, *, verbose=False):
 
         Returns
         -------
-        A list of table objects
+        A list of TapTableMeta objects
         """
         return self.__load_tables(verbose=verbose)
 
     def load_table(self, table, *, verbose=False):
-        """Loads the specified table
+        """Loads the table metadata, for the specified table. If the user is logged in, the table can refer to a
+        table in the user's private area.
 
         Parameters
         ----------
@@ -168,7 +170,7 @@ def load_table(self, table, *, verbose=False):
 
         Returns
         -------
-        A table object
+        A TapTableMeta object
         """
         if table is None:
             raise ValueError("Table name is required")

astroquery/utils/tap/model/taptable.py

@@ -27,6 +27,7 @@ def __init__(self):
         self.name = None
         self.schema = None
         self.description = None
+        self.size_bytes = 0
 
     def get_qualified_name(self):
         """Returns the qualified TAP table name. I.e. schema+table
@@ -35,6 +36,9 @@ def get_qualified_name(self):
         -------
         The the qualified TAP table name (schema+table)
         """
+        if '.' in self.name:
+            return self.name
+
         return f"{self.schema}.{self.name}"
 
     def add_column(self, tap_column):
@@ -50,4 +54,5 @@ def add_column(self, tap_column):
     def __str__(self):
         return f"TAP Table name: {self.get_qualified_name()}" \
             f"\nDescription: {self.description}" \
+            f"\nSize (bytes): {self.size_bytes}" \
             f"\nNum. columns: {len(self.columns)}"

astroquery/utils/tap/xmlparser/tableSaxParser.py

@@ -17,8 +17,8 @@
 
 import xml.sax
 
-from astroquery.utils.tap.model.taptable import TapTableMeta
 from astroquery.utils.tap.model.tapcolumn import TapColumn
+from astroquery.utils.tap.model.taptable import TapTableMeta
 from astroquery.utils.tap.xmlparser import utils as Utils
 
 READING_SCHEMA = 10
@@ -94,6 +94,8 @@ def __reading_schema(self, name, attrs):
             self.__status = READING_TABLE
             self.__currentTable = TapTableMeta()
             self.__currentTable.schema = self.__currentSchemaName
+            if 'esatapplus:size_bytes' in attrs:
+                self.__currentTable.size_bytes = int(attrs.getValue('esatapplus:size_bytes'))
 
     def __end_schema(self, name):
         if self.__check_item_id("name", name):