PyroLab 0.3.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

pyrolab/__init__.py

@@ -23,119 +23,68 @@ PyroLab
 A framework for using remote lab instruments as local resources built on Pyro5.
 """
 
+import logging
 import os
-import pathlib
 import platform
 import sys
 
 # Check if Python version is supported
 pyversion = sys.version_info
-if pyversion < (3, 7, 0):
+if pyversion < (3, 11, 0):
     raise Exception(
-        "PyroLab requires Python 3.7+ (version "
+        "PyroLab requires Python 3.11+ (version "
         + platform.python_version()
         + " detected)."
     )
 
 
 # Metadata
-__name__ = "PyroLab"
+__title__ = "PyroLab"
 __author__ = "CamachoLab"
 __copyright__ = "Copyright 2020, The PyroLab Project"
-__version__ = "0.3.2"
+# pyproject.toml is the single source of the version (see `uv version`).
+import importlib.metadata as _metadata
+
+try:
+    __version__ = _metadata.version("pyrolab")
+except _metadata.PackageNotFoundError:  # source tree that isn't installed
+    __version__ = "0.0.0+unknown"
 __license__ = "GPLv3+"
 __maintainer__ = "Sequoia Ploeg"
 __maintainer_email__ = "sequoia.ploeg@byu.edu"
-__status__ = "Development" # "Production"
+__status__ = "Development"  # "Production"
 __project_url__ = "https://github.com/sequoiap/pyrolab"
 __forum_url__ = "https://github.com/sequoiap/pyrolab/issues"
 __website_url__ = "https://camacholab.byu.edu/"
 
 
-# Filter warnings
-import warnings
-
-warnings.filterwarnings("default", category=DeprecationWarning)
-if "PYROLAB_HUSH_DEPRECATION" in os.environ:
-    warnings.filterwarnings("ignore", category=DeprecationWarning)
-
-
-# Configuration directories
-# Old api deprecated in 3.11, new api added in 3.9
-if pyversion < (3, 9, 0):
-    base_path = pathlib.Path(__file__).resolve().parent
-else:
-    from importlib.resources import files
-    base_path = files("pyrolab")
-base_path = base_path / "data" / "local"
-
-# Data directories
-PYROLAB_DATA_DIR = pathlib.Path(base_path)
-PYROLAB_DATA_DIR.mkdir(parents=True, exist_ok=True)
-
-NAMESERVER_STORAGE = PYROLAB_DATA_DIR / "nameserver"
-NAMESERVER_STORAGE.mkdir(parents=True, exist_ok=True)
-
-PYROLAB_LOGDIR = PYROLAB_DATA_DIR / "logs"
-PYROLAB_LOGDIR.mkdir(parents=True, exist_ok=True)
-
-LOCKFILE = PYROLAB_DATA_DIR / "pyrolabd.lock"
-USER_CONFIG_FILE = PYROLAB_DATA_DIR / "user_configuration.yaml"
-RUNTIME_CONFIG = PYROLAB_DATA_DIR / "runtime_config.yaml"
-
-
-# Set up logging to file
-import logging
-import logging.handlers
-
-
-def get_loglevel() -> int:
-    loglevel = os.getenv("PYROLAB_LOGLEVEL", "INFO")
-    try:
-        loglevel = getattr(logging, loglevel.upper())
-    except AttributeError:
-        loglevel = logging.INFO
-    return loglevel
-
-
-if len(logging.root.handlers) == 0:    
-    logfile = PYROLAB_LOGDIR / f"pyrolab_{os.getpid()}.log"
-    root = logging.getLogger()
-    h = logging.handlers.RotatingFileHandler(logfile, 'a', 30000, 10)
-    f = logging.Formatter('[%(asctime)s.%(msecs)03d] %(process)-5s %(processName)-10s %(name)-12s %(levelname)-8s %(message)s', datefmt="%Y-%m-%d %H:%M:%S")
-    h.setFormatter(f)
-    root.addHandler(h)
-    root.setLevel(get_loglevel())
-    root.debug("PyroLab logging configured")
-
-
-# Include remote traceback in local tracebacks
-import Pyro5.errors
-
-sys.excepthook = Pyro5.errors.excepthook
-
-
-# Check for updates to PyroLab
-try:
-    import json
-    import requests
-    from requests.adapters import HTTPAdapter
-    from packaging.version import parse
-
-    url = "https://pypi.org/pypi/pyrolab/json"
-    with requests.Session() as s:
-        s.mount('https://pypi.org', HTTPAdapter(max_retries=3))
-        resp = s.get(url).text
-
-    v = json.loads(resp)['info']['version']
-    curver = parse(__version__)
-    latest = parse(v)
-
-    log = logging.getLogger(__name__)
-
-    if curver < latest:
-        message = f"A new version of PyroLab is available (latest is {latest}, but {curver} is installed)."
-        warnings.warn(message, stacklevel=2)
-        log.info(message)
-except:
-    pass
+# Where PyroLab keeps its files: per-user directories (see pyrolab.locations).
+# Importing creates nothing; files and directories are created when written.
+from pathlib import Path
+
+from pyrolab.locations import LEGACY_DATA_DIR
+from pyrolab.locations import locations as _find_locations
+
+_locations = _find_locations()
+
+PYROLAB_DATA_DIR = _locations.data_dir
+NAMESERVER_STORAGE = _locations.data_dir / "nameserver"
+PYROLAB_LOGDIR = _locations.log_dir
+# The daemon's single log file; PYROLAB_LOGFILE overrides where it goes.
+PYROLAB_LOGFILE = Path(
+    os.environ.get("PYROLAB_LOGFILE") or PYROLAB_LOGDIR / "pyrolab.log"
+)
+USER_CONFIG_FILE = _locations.config_dir / "user_configuration.yaml"
+LOCKFILE = _locations.state_dir / "pyrolabd.lock"
+RUNTIME_CONFIG = _locations.state_dir / "runtime_config.yaml"
+# Why the background daemon exited before it could serve requests, for `up`.
+STARTUP_ERROR_FILE = _locations.state_dir / "pyrolabd_startup_error.txt"
+# Records that files from a pre-0.5 install were copied (see pyrolab.locations).
+LEGACY_MIGRATION_MARKER = _locations.state_dir / "legacy_files_copied.txt"
+UPDATE_CHECK_FILE = _locations.cache_dir / "update_check.json"
+
+
+# As a library, PyroLab leaves logging to the application: its loggers do
+# nothing until the application (or PyroLab's own CLI and daemon, see
+# pyrolab.logs) configures logging.
+logging.getLogger(__name__).addHandler(logging.NullHandler())

pyrolab/api.py

@@ -14,11 +14,11 @@ from Pyro5.core import locate_ns
 from Pyro5.server import behavior, expose, oneway, serve
 from pyrolab import USER_CONFIG_FILE
 from pyrolab.configure import (
-    PyroLabConfiguration, 
-    NameServerConfiguration, 
-    DaemonConfiguration, 
-    ServiceConfiguration, 
-    reset_config, 
+    PyroLabConfiguration,
+    NameServerConfiguration,
+    DaemonConfiguration,
+    ServiceConfiguration,
+    reset_config,
     update_config,
 )
 from pyrolab.server import Daemon, LockableDaemon
@@ -47,8 +47,20 @@ __all__ = [
 ]
 
 # If a user config file exists, load the first listed nameserver by default,
-# so that locate_ns "just works." 
+# so that locate_ns "just works."
+# This is a convenience only: importing the API must never fail because the
+# local configuration is invalid, has no nameservers, or names a "public"
+# host that can't be resolved -- otherwise neither client scripts nor the
+# CLI commands that would fix the configuration could even start.
 if USER_CONFIG_FILE.exists():
-    cfg = PyroLabConfiguration.from_file(USER_CONFIG_FILE)
-    nscfg = next(iter(cfg.nameservers.values()))
-    nscfg.update_pyro_config()
+    try:
+        cfg = PyroLabConfiguration.from_file(USER_CONFIG_FILE)
+        nscfg = next(iter(cfg.nameservers.values()), None)
+        if nscfg is not None:
+            nscfg.update_pyro_config()
+    except Exception as e:
+        import logging
+
+        logging.getLogger(__name__).warning(
+            "Not applying nameserver defaults from %s: %s", USER_CONFIG_FILE, e
+        )