Improve logging

skycalc_ipy/__init__.py

@@ -8,6 +8,10 @@
 
 from .ui import SkyCalc
 
+import logging
+logger = logging.getLogger("astar." + __name__)
+logger.addHandler(logging.NullHandler())
+
 from importlib import metadata
 
 __version__ = metadata.version(__package__)

skycalc_ipy/core.py

@@ -23,6 +23,7 @@
 
 
 CACHE_DIR_FALLBACK = ".astar/skycalc_ipy"
+logger = logging.getLogger("astar." + __name__)
 
 
 def get_cache_dir() -> Path:
@@ -65,12 +66,12 @@
                 response = client.post(self.url, json=self.params)
             response.raise_for_status()
         except httpx.RequestError as err:
-            logging.exception("An error occurred while requesting %s.",
-                              err.request.url)
+            logger.exception("An error occurred while requesting %s.",
+                             err.request.url)
             raise err
         except httpx.HTTPStatusError as err:
-            logging.error("Error response %s while requesting %s.",
-                          err.response.status_code, err.request.url)
+            logger.error("Error response %s while requesting %s.",
+                         err.response.status_code, err.request.url)
             raise err
         return response
 
@@ -181,11 +182,10 @@
         try:
             self.params[f"coord_{which}"] = float(indic[which])
         except KeyError as err:
-            logging.exception("%s coordinate not given for the Almanac.",
-                              which)
+            logger.exception("%s coordinate not given for the Almanac.", which)
             raise err
         except ValueError as err:
-            logging.exception("Wrong %s format for the Almanac.", which)
+            logger.exception("Wrong %s format for the Almanac.", which)
             raise err
 
     def _get_jsondata(self, file_path: Path):
@@ -238,8 +238,8 @@
             try:
                 almdata[key] = jsondata[subsection][value]
             except (KeyError, ValueError):
-                logging.warning("Key '%s/%s' not found in Almanac response.",
-                                subsection, value)
+                logger.warning("Key '%s/%s' not found in Almanac response.",
+                               subsection, value)
 
         return almdata
 
@@ -413,7 +413,7 @@
             # identical requests.
             self.data[0].header["DATE"] = "2017-01-07T00:00:00"
         except Exception as err:
-            logging.exception(
+            logger.exception(
                 "Exception raised trying to get FITS data from %s", url)
             raise err
 
@@ -422,7 +422,7 @@
         try:
             self.data.writeto(local_filename, **kwargs)
         except (IOError, FileNotFoundError):
-            logging.exception("Exception raised trying to write fits file.")
+            logger.exception("Exception raised trying to write fits file.")
 
     def getdata(self):
         """Deprecated feature, just use the .data attribute."""
@@ -439,22 +439,22 @@
                                       params={"d": tmpdir})
             deleter_response = response.text.strip().lower()
             if deleter_response != "ok":
-                logging.error("Could not delete server tmpdir %s: %s",
-                              tmpdir, deleter_response)
+                logger.error("Could not delete server tmpdir %s: %s",
+                             tmpdir, deleter_response)
         except httpx.HTTPError:
-            logging.exception("Exception raised trying to delete tmp dir %s",
-                              tmpdir)
+            logger.exception("Exception raised trying to delete tmp dir %s",
+                             tmpdir)
 
     def _update_params(self, updated: Mapping) -> None:
         par_keys = self.params.keys()
         new_keys = updated.keys()
         self.params.update((key, updated[key]) for key in par_keys & new_keys)
-        logging.debug("Ignoring invalid keywords: %s", new_keys - par_keys)
+        logger.debug("Ignoring invalid keywords: %s", new_keys - par_keys)
 
     def __call__(self, **kwargs):
         """Send server request."""
         if kwargs:
-            logging.info("Setting new parameters: %s", kwargs)
+            logger.info("Setting new parameters: %s", kwargs)
 
         self._update_params(kwargs)
         self.fix_observatory()
@@ -474,7 +474,7 @@
             status = res["status"]
             tmpdir = res["tmpdir"]
         except (KeyError, ValueError) as err:
-            logging.exception(
+            logger.exception(
                 "Exception raised trying to decode server response.")
             raise err
 
@@ -486,7 +486,7 @@
                 self._retrieve_data(
                     self.BASE_URL + self.data_url + tmpdir + "/skytable.fits")
             except httpx.HTTPError as err:
-                logging.exception("Could not retrieve FITS data from server.")
+                logger.exception("Could not retrieve FITS data from server.")
                 raise err
 
             try:
@@ -500,7 +500,7 @@
             self._delete_server_tmpdir(tmpdir)
 
         else:  # print why validation failed
-            logging.error("Parameter validation error: %s", res["error"])
+            logger.error("Parameter validation error: %s", res["error"])
 
     def call(self):
         """Deprecated feature, just call the instance."""

skycalc_ipy/ui.py

@@ -27,6 +27,7 @@
 }
 
 PATH_HERE = Path(__file__).parent
+logger = logging.getLogger("astar." + __name__)
 
 
 class SkyCalc:
@@ -84,10 +85,10 @@ def validate_params(self):
                     invalid_keys.append(key)
 
         if invalid_keys:
-            logging.warning("The following entries are invalid:")
+            logger.warning("The following entries are invalid:")
             for key in invalid_keys:
-                logging.warning("'%s' : %s : %s", key,
-                                self.values[key], self.comments[key])
+                logger.warning("'%s' : %s : %s", key,
+                               self.values[key], self.comments[key])
 
         return not invalid_keys
 
@@ -211,7 +212,7 @@ def get_sky_spectrum(self, return_type="table", filename=None):
                 points=tbl["lam"].data * tbl["lam"].unit,
                 lookup_table=tbl["flux"].data * funit,
             )
-            logging.warning(
+            logger.warning(
                 "Synphot doesn't accept surface brightnesses \n"
                 "The resulting spectrum should be multiplied by arcsec-2"
             )