Merge pull request #210 from mraspaud/disable-tle-dl

Start deprecating automatic tle downloads

Author: mraspaud

pyorbital/config.py

@@ -0,0 +1,4 @@
+"""Set up the config object."""
+from donfig import Config
+
+config = Config("pyorbital")

pyorbital/tests/test_tlefile.py

@@ -32,6 +32,8 @@
 
 import pytest
 
+from pyorbital.config import config
+
 LINE0 = "ISS (ZARYA)"
 LINE1 = "1 25544U 98067A   08264.51782528 -.00002182  00000-0 -11606-4 0  2927"
 LINE2 = "2 25544  51.6416 247.4627 0006703 130.5360 325.0288 15.72125391563537"
@@ -120,9 +122,9 @@ def test_read_tlefile_standard_platform_name(monkeypatch, fake_platforms_txt_fil
     from pyorbital import tlefile
 
     path_to_platforms_txt_file = fake_platforms_txt_file.parent
-    monkeypatch.setenv("PYORBITAL_CONFIG_PATH", str(path_to_platforms_txt_file))
 
-    tle_n21 = tlefile.read("NOAA-21", str(fake_tlefile))
+    with config.set(config_path=str(path_to_platforms_txt_file)):
+        tle_n21 = tlefile.read("NOAA-21", str(fake_tlefile))
     assert tle_n21.line1 == "1 54234U 22150A   23045.56664999  .00000332  00000+0  17829-3 0  9993"
     assert tle_n21.line2 == "2 54234  98.7059 345.5113 0001226  81.6523 278.4792 14.19543871 13653"
 
@@ -135,9 +137,9 @@ def test_read_tlefile_non_standard_platform_name(monkeypatch, fake_platforms_txt
     from pyorbital import tlefile
 
     path_to_platforms_txt_file = fake_platforms_txt_file.parent
-    monkeypatch.setenv("PYORBITAL_CONFIG_PATH", str(path_to_platforms_txt_file))
 
-    tle_n20 = tlefile.read("NOAA 20", str(fake_tlefile))
+    with config.set(config_path=str(path_to_platforms_txt_file)):
+        tle_n20 = tlefile.read("NOAA 20", str(fake_tlefile))
 
     assert tle_n20.line1 == "1 43013U 17073A   23045.54907786  .00000253  00000+0  14081-3 0  9995"
     assert tle_n20.line2 == "2 43013  98.7419 345.5839 0001610  80.3742 279.7616 14.19558274271576"
@@ -168,11 +170,11 @@ def test_read_tlefile_non_standard_platform_name_matching_start_of_name_in_tlefi
     from pyorbital import tlefile
 
     path_to_platforms_txt_file = fake_platforms_txt_file.parent
-    monkeypatch.setenv("PYORBITAL_CONFIG_PATH", str(path_to_platforms_txt_file))
 
-    with pytest.raises(KeyError) as exc_info:
-        with caplog.at_level(logging.DEBUG):
-            _ = tlefile.read(sat_name, str(fake_tlefile))
+    with config.set(config_path=str(path_to_platforms_txt_file)):
+        with pytest.raises(KeyError) as exc_info:
+            with caplog.at_level(logging.DEBUG):
+                _ = tlefile.read(sat_name, str(fake_tlefile))
 
     assert f"Found a possible match: {expected}?" in caplog.text
     assert str(exc_info.value) == f'"Found no TLE entry for \'{sat_name}\'"'
@@ -308,11 +310,10 @@ def test_get_config_path_ppp_config_set_and_pyorbital(caplog, monkeypatch):
     from pyorbital.tlefile import _get_config_path
 
     pyorbital_config_dir = "/path/to/pyorbital/config/dir"
-    monkeypatch.setenv("PYORBITAL_CONFIG_PATH", pyorbital_config_dir)
     monkeypatch.setenv("PPP_CONFIG_DIR", "/path/to/old/mpop/config/dir")
-
-    with caplog.at_level(logging.WARNING):
-        res = _get_config_path()
+    with config.set(config_path=pyorbital_config_dir):
+        with caplog.at_level(logging.WARNING):
+            res = _get_config_path()
 
     assert res == pyorbital_config_dir
     assert caplog.text == ""
@@ -327,10 +328,10 @@ def test_get_config_path_pyorbital_ppp_missing(caplog, monkeypatch):
     from pyorbital.tlefile import _get_config_path
 
     pyorbital_config_dir = "/path/to/pyorbital/config/dir"
-    monkeypatch.setenv("PYORBITAL_CONFIG_PATH", pyorbital_config_dir)
 
-    with caplog.at_level(logging.DEBUG):
-        res = _get_config_path()
+    with config.set(config_path=pyorbital_config_dir):
+        with caplog.at_level(logging.DEBUG):
+            res = _get_config_path()
 
     assert res == pyorbital_config_dir
     log_output = ("Path to the Pyorbital configuration (where e.g. " +

pyorbital/tlefile.py

@@ -27,11 +27,14 @@
 import warnings
 from itertools import zip_longest
 from urllib.request import urlopen
+from warnings import warn
 
 import defusedxml.ElementTree as ET
 import numpy as np
 import requests
 
+from pyorbital.config import config
+
 TLE_GROUPS = ("active",
               "weather",
               "resource",
@@ -55,14 +58,14 @@ class TleDownloadTimeoutError(Exception):
 
 def _get_config_path():
     """Get the config path for Pyorbital."""
-    if "PPP_CONFIG_DIR" in os.environ and "PYORBITAL_CONFIG_PATH" not in os.environ:
+    if "PPP_CONFIG_DIR" in os.environ and "config_path" not in config:
         LOGGER.warning(
             "The use of PPP_CONFIG_DIR is no longer supported!" +
             " Please use PYORBITAL_CONFIG_PATH if you need a custom config path for pyorbital!")
         LOGGER.debug("Using the package default for configuration: %s", PKG_CONFIG_DIR)
         return PKG_CONFIG_DIR
     else:
-        pyorbital_config_path = os.getenv("PYORBITAL_CONFIG_PATH", PKG_CONFIG_DIR)
+        pyorbital_config_path = config.get("config_path", PKG_CONFIG_DIR)
 
     LOGGER.debug("Path to the Pyorbital configuration (where e.g. platforms.txt is found): %s",
                  str(pyorbital_config_path))
@@ -360,6 +363,10 @@ def _get_local_uris_and_open_method(local_tle_path):
         LOGGER.debug("Reading TLE from %s", uris[0])
         open_func = _open
     else:
+        if config.get("fetch_from_celestrak", None) is not True:
+            warn("In the future, implicit downloads of TLEs from Celestrak will be disabled by default. "
+                 "You can enable it (and remove this warning) by setting PYORBITAL_FETCH_FROM_CELESTRAK to True.",
+                 DeprecationWarning)
         LOGGER.warning("TLES environment variable points to no TLE files")
         throttle_warning = "TLEs will be downloaded from Celestrak, which can throttle the connection."
         LOGGER.warning(throttle_warning)

pyproject.toml

@@ -10,6 +10,7 @@ dependencies = ["numpy>=1.19.0",
                 "requests",
                 "defusedxml",
                 "pyproj>=3.7.1",
+                "donfig",
                 ]
 readme = "README.md"
 requires-python = ">=3.10"