devpi-server 6.12.1__tar.gz → 6.13.0__tar.gz

{devpi-server-6.12.1 → devpi-server-6.13.0}/.flake8

@@ -1,9 +1,9 @@
 [flake8]
 ignore = E501,E741,W503
 per-file-ignores =
-    plugin.py:E127,E128,E225,E231,E265,E402,E712
+    plugin.py:E127,E128,E225,E231
     importexport.py:E127
     model.py:E128,E225,E231
     setup.py:E121,E126
     test_importexport.py:E121
-    test*.py:E117,E126,E127,E128,E225,E226,E231,E251,E265,E712,E721
+    test*.py:E126,E127,E128,E225,E226,E231,E251

{devpi-server-6.12.1 → devpi-server-6.13.0}/CHANGELOG

@@ -2,6 +2,41 @@
 
 .. towncrier release notes start
 
+6.13.0 (2024-09-19)
+===================
+
+Deprecations and Removals
+-------------------------
+
+- Remove/Deprecate "master" related terminology in favor of "primary".
+  Usage related changes are the switch to ``--primary-url`` instead of ``--master-url`` and ``--role=primary`` instead of ``--role=master``.
+  Using the old terms will now output warnings.
+  The ``+status`` API has additional fields and the ``role`` field content will change with 7.0.0.
+
+
+
+Features
+--------
+
+- Enable logging command line options for all commands.
+
+- Added support uv pip as an installer.
+
+
+
+Bug Fixes
+---------
+
+- Don't report on lagging event processing while replicating.
+
+- Report primary serial correctly with streaming replication.
+
+- Don't store file data in memory when fetching a release while pushing from a mirror.
+
+- Only warn about replica not being in sync instead of fatal status while still replicating.
+
+
+
 6.12.1 (2024-07-24)
 ===================
 

{devpi-server-6.12.1 → devpi-server-6.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devpi-server
-Version: 6.12.1
+Version: 6.13.0
 Summary: devpi-server: reliable private and pypi.org caching server
 Home-page: https://devpi.net
 Maintainer: Florian Schulze
@@ -9,6 +9,7 @@ License: MIT
 Project-URL: Bug Tracker, https://github.com/devpi/devpi/issues
 Project-URL: Changelog, https://github.com/devpi/devpi/blob/main/server/CHANGELOG
 Project-URL: Documentation, https://doc.devpi.net
+Project-URL: Funding, https://github.com/sponsors/devpi
 Project-URL: Source Code, https://github.com/devpi/devpi
 Keywords: pypi realtime cache server
 Classifier: Development Status :: 5 - Production/Stable
@@ -104,6 +105,41 @@ Changelog
 
 .. towncrier release notes start
 
+6.13.0 (2024-09-19)
+===================
+
+Deprecations and Removals
+-------------------------
+
+- Remove/Deprecate "master" related terminology in favor of "primary".
+  Usage related changes are the switch to ``--primary-url`` instead of ``--master-url`` and ``--role=primary`` instead of ``--role=master``.
+  Using the old terms will now output warnings.
+  The ``+status`` API has additional fields and the ``role`` field content will change with 7.0.0.
+
+
+
+Features
+--------
+
+- Enable logging command line options for all commands.
+
+- Added support uv pip as an installer.
+
+
+
+Bug Fixes
+---------
+
+- Don't report on lagging event processing while replicating.
+
+- Report primary serial correctly with streaming replication.
+
+- Don't store file data in memory when fetching a release while pushing from a mirror.
+
+- Only warn about replica not being in sync instead of fatal status while still replicating.
+
+
+
 6.12.1 (2024-07-24)
 ===================
 
@@ -178,12 +214,3 @@ Bug Fixes
 - Only compare hostname instead of full URL prefix when parsing mirror packages to fix mirrors with basic authentication and absolute URLs. See #1006
 
 
-
-6.9.2 (2023-08-06)
-==================
-
-Bug Fixes
----------
-
-- Prevent duplicates when adding values to lists in index configuration with ``+=`` operator.
-

devpi-server-6.13.0/devpi_server/__init__.py

@@ -0,0 +1 @@
+__version__ = '6.13.0'

{devpi-server-6.12.1 → devpi-server-6.13.0}/devpi_server/config.py

@@ -6,6 +6,7 @@ import secrets
 import sys
 import uuid
 from operator import itemgetter
+from pathlib import Path
 from tempfile import NamedTemporaryFile
 from pluggy import HookimplMarker, PluginManager
 import py
@@ -17,6 +18,8 @@ from . import hookspecs
 import json
 import devpi_server
 from devpi_common.url import URL
+import warnings
+
 
 log = threadlog
 
@@ -70,17 +73,31 @@ def add_configfile_option(parser, pluginmanager):
 def add_role_option(parser, pluginmanager):
     parser.addoption(
         "--role", action="store", dest="role", default="auto",
-        choices=["master", "replica", "standalone", "auto"],
+        choices=["master", "primary", "replica", "standalone", "auto"],
         help="set role of this instance. The default 'auto' sets "
-             "'standalone' by default and 'replica' if the --master-url "
+             "'standalone' by default and 'replica' if the --primary-url "
              "option is used. To enable the replication protocol you have "
-             "to explicitly set the 'master' role.")
+             "to explicitly set the 'primary' role. The 'master' role is "
+             "the deprecated variant of 'primary'.")
 
 
 def add_master_url_option(parser, pluginmanager):
+    warnings.warn(
+        "The add_master_url_option function is deprecated, "
+        "use add_primary_url_option instead",
+        DeprecationWarning,
+        stacklevel=2)
+    add_primary_url_option(parser, pluginmanager)
+
+
+def add_primary_url_option(parser, pluginmanager):  # noqa: ARG001
     parser.addoption(
-        "--master-url", action="store", dest="master_url",
-        help="run as a replica of the specified master server",
+        "--primary-url", action="store", dest="primary_url",
+        help="run as a replica of the specified primary server",
+        default=None)
+    parser.addoption(
+        "--master-url", action="store", dest="deprecated_master_url",
+        help="DEPRECATED, use --primary-url instead",
         default=None)
 
 
@@ -186,7 +203,7 @@ def add_mirror_options(parser, pluginmanager):
 
 
 def add_replica_options(parser, pluginmanager):
-    add_master_url_option(parser, pluginmanager)
+    add_primary_url_option(parser, pluginmanager)
 
     parser.addoption(
         "--replica-max-retries", type=int, metavar="NUM",
@@ -197,7 +214,7 @@ def add_replica_options(parser, pluginmanager):
     parser.addoption(
         "--replica-file-search-path", metavar="PATH",
         help="path to existing files to try before downloading "
-             "from master. These could be from a previous "
+             "from primary. These could be from a previous "
              "replication attempt or downloaded separately. "
              "Expects the structure from previous state or +files.")
 
@@ -214,13 +231,13 @@ def add_replica_options(parser, pluginmanager):
     parser.addoption(
         "--file-replication-threads", type=int, metavar="NUM",
         default=DEFAULT_FILE_REPLICATION_THREADS,
-        help="number of threads for file download from master")
+        help="number of threads for file download from primary")
 
     parser.addoption(
         "--proxy-timeout", type=int, metavar="NUM",
         default=DEFAULT_PROXY_TIMEOUT,
         help="Number of seconds to wait before proxied requests from "
-             "the replica to the master time out (login, uploads etc).")
+             "the replica to the primary time out (login, uploads etc).")
 
     parser.addoption(
         "--no-replica-streaming", dest="replica_streaming",
@@ -555,7 +572,7 @@ class MyArgumentParser(argparse.ArgumentParser):
             default = action.default
             if isinstance(action, argparse._StoreFalseAction):
                 default = not default
-            if action.help and action.help is not argparse.SUPPRESS and action.default is not argparse.SUPPRESS:
+            if action.help and argparse.SUPPRESS not in (action.help, default):
                 action.help += " [%s]" % default
 
     def addgroup(self, *args, **kwargs):
@@ -584,8 +601,19 @@ class MyArgumentParser(argparse.ArgumentParser):
     def add_init_options(self):
         add_init_options(self, self.pluginmanager)
 
+    def add_logging_options(self) -> None:
+        add_logging_options(self, self.pluginmanager)
+
     def add_master_url_option(self):
-        add_master_url_option(self, self.pluginmanager)
+        warnings.warn(
+            "The add_master_url_option method is deprecated, "
+            "use add_primary_url_option instead",
+            DeprecationWarning,
+            stacklevel=2)
+        add_primary_url_option(self, self.pluginmanager)
+
+    def add_primary_url_option(self):
+        add_primary_url_option(self, self.pluginmanager)
 
     def add_role_option(self):
         add_role_option(self, self.pluginmanager)
@@ -656,14 +684,32 @@ class Config(object):
 
     @cached_property
     def serverdir(self):
-        return py.path.local(os.path.expanduser(self.args.serverdir))
+        warnings.warn(
+            "The serverdir property is deprecated, "
+            "use server_path instead",
+            DeprecationWarning,
+            stacklevel=3)
+        return py.path.local(self.server_path)
+
+    @cached_property
+    def server_path(self):
+        return Path(self.args.serverdir).expanduser()
 
     @cached_property
     def path_nodeinfo(self):
-        return self.serverdir.join(".nodeinfo")
+        warnings.warn(
+            "The path_nodeinfo property is deprecated, "
+            "use nodeinfo_path instead",
+            DeprecationWarning,
+            stacklevel=3)
+        return py.path.local(self.nodeinfo_path)
+
+    @cached_property
+    def nodeinfo_path(self):
+        return self.server_path / ".nodeinfo"
 
     def init_nodeinfo(self):
-        log.info("Loading node info from %s", self.path_nodeinfo)
+        log.info("Loading node info from %s", self.nodeinfo_path)
         self._determine_role()
         self._determine_uuid()
         self._determine_storage()
@@ -677,56 +723,111 @@ class Config(object):
 
     @property
     def role(self):
-        return self.nodeinfo["role"]
+        role = self.nodeinfo["role"]
+        if role == "master":
+            warnings.warn(
+                "role==master is deprecated, use primary instead.",
+                DeprecationWarning,
+                stacklevel=2)
+            return "primary"
+        return role
 
     def set_uuid(self, uuid):
         # called when importing state
         self.nodeinfo["uuid"] = uuid
         self.write_nodeinfo()
 
-    def set_master_uuid(self, uuid):
-        assert self.role == "replica", "can only set master uuid on replica"
-        existing = self.nodeinfo.get("master-uuid")
+    def set_primary_uuid(self, uuid):
+        assert self.role == "replica", "can only set primary uuid on replica"
+        existing = self.get_primary_uuid()
         if existing and existing != uuid:
-            raise ValueError("already have master id %r, got %r" % (
+            raise ValueError("already have primary id %r, got %r" % (
                              existing, uuid))
-        self.nodeinfo["master-uuid"] = uuid
+        self.nodeinfo["primary-uuid"] = uuid
         self.write_nodeinfo()
 
     def get_master_uuid(self):
+        warnings.warn(
+            "get_master_uuid is deprecated, use get_primary_uuid instead",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.get_primary_uuid()
+
+    def get_primary_uuid(self):
         if self.role != "replica":
             return self.nodeinfo["uuid"]
-        return self.nodeinfo.get("master-uuid")
+        if "master-uuid" in self.nodeinfo:
+            warnings.warn(
+                "master-uuid in nodeinfo is deprecated, use primary-uuid instead",
+                DeprecationWarning,
+                stacklevel=2)
+            return self.nodeinfo["master-uuid"]
+        return self.nodeinfo.get("primary-uuid")
 
     @cached_property
     def nodeinfo(self):
-        if self.path_nodeinfo.exists():
-            return json.loads(self.path_nodeinfo.read("r"))
+        if self.nodeinfo_path.is_file():
+            with self.nodeinfo_path.open() as f:
+                return json.load(f)
         return {}
 
     def write_nodeinfo(self):
-        nodeinfo_dir = self.path_nodeinfo.dirpath()
-        nodeinfo_dir.ensure(dir=1)
-        prefix = "-" + self.path_nodeinfo.basename
-        with NamedTemporaryFile(prefix=prefix, delete=False, dir=nodeinfo_dir.strpath) as f:
+        nodeinfo_dir = self.nodeinfo_path.parent
+        nodeinfo_dir.mkdir(parents=True, exist_ok=True)
+        prefix = "-" + self.nodeinfo_path.name
+        with NamedTemporaryFile(prefix=prefix, delete=False, dir=nodeinfo_dir) as f:
             f.write(json.dumps(self.nodeinfo, indent=2).encode('utf-8'))
-        fileutil.rename(f.name, self.path_nodeinfo.strpath)
-        threadlog.info("wrote nodeinfo to: %s", self.path_nodeinfo)
+        fileutil.rename(f.name, self.nodeinfo_path)
+        threadlog.info("wrote nodeinfo to: %s", self.nodeinfo_path)
+
+    @property
+    def master_auth(self):
+        warnings.warn(
+            "master_auth is deprecated, use primary_auth instead",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.primary_auth
 
     @property
     def master_url(self):
-        if hasattr(self, '_master_url'):
-            return self._master_url
-        master_url = None
-        if getattr(self.args, 'master_url', None):
-            master_url = URL(self.args.master_url)
+        warnings.warn(
+            "master_url is deprecated, use primary_url instead",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.primary_url
+
+    @property
+    def primary_auth(self):
+        # trigger setting of _primary_auth
+        return self._primary_auth if self.primary_url else None
+
+    @property
+    def primary_url(self):
+        if hasattr(self, '_primary_url'):
+            return self._primary_url
+        primary_url = None
+        if getattr(self.args, 'deprecated_master_url', None):
+            if getattr(self.args, 'primary_url', None):
+                from .main import fatal
+                fatal("Can't use both --master-url and --primary-url")
+            warnings.warn(
+                "The --master-url option is deprecated, "
+                "use --primary-url instead.",
+                DeprecationWarning,
+                stacklevel=2)
+            threadlog.warning(
+                "The --master-url option is deprecated, "
+                "use --primary-url instead.")
+            primary_url = URL(self.args.deprecated_master_url)
+        elif getattr(self.args, 'primary_url', None):
+            primary_url = URL(self.args.primary_url)
         elif self.nodeinfo.get("masterurl"):
-            master_url = URL(self.nodeinfo["masterurl"])
-        self.master_url = master_url
-        return self.master_url
+            primary_url = URL(self.nodeinfo["masterurl"])
+        self.primary_url = primary_url
+        return self.primary_url
 
-    @master_url.setter
-    def master_url(self, value):
+    @primary_url.setter
+    def primary_url(self, value):
         auth = (None, None)
         if value is not None:
             auth = (value.username, value.password)
@@ -736,8 +837,8 @@ class Config(object):
             value = value.replace(netloc=netloc)
         if auth == (None, None):
             auth = None
-        self.master_auth = auth
-        self._master_url = value
+        self._primary_auth = auth
+        self._primary_url = value
 
     @property
     def include_mirrored_files(self):
@@ -813,25 +914,25 @@ class Config(object):
         return getattr(self.args, 'wait_for_events', False)
 
     def _init_role(self):
-        if self.master_url:
+        if self.primary_url:
             self.nodeinfo["role"] = "replica"
         else:
             self.nodeinfo["role"] = "standalone"
 
     def _automatic_role(self, role):
         from .main import Fatal
-        if role == "replica" and not self.master_url:
+        if role == "replica" and not self.primary_url:
             raise Fatal(
-                "configuration error, masterurl isn't set in nodeinfo, but "
+                "configuration error, primary URL isn't set in nodeinfo, but "
                 "role is set to replica")
-        if role != "replica" and self.master_url:
+        if role != "replica" and self.primary_url:
             raise Fatal(
-                "configuration error, masterurl set in nodeinfo, but role "
+                "configuration error, primary URL set in nodeinfo, but role "
                 "isn't set to replica")
         if role != "replica":
-            self.master_url = None
-        if role == "master":
-            # we only allow explicit master role
+            self.primary_url = None
+        if role in ("master", "primary"):
+            # we only allow explicit primary role
             self.nodeinfo["role"] = "standalone"
 
     def _change_role(self, old_role, new_role):
@@ -840,10 +941,10 @@ class Config(object):
             if old_role and old_role != "replica":
                 msg = f"cannot run as replica, was previously run as {old_role}"
                 raise Fatal(msg)
-            if not self.master_url:
-                raise Fatal("need to specify --master-url to run as replica")
+            if not self.primary_url:
+                raise Fatal("need to specify --primary-url to run as replica")
         else:
-            self.master_url = None
+            self.primary_url = None
         self.nodeinfo["role"] = new_role
 
     def _determine_role(self):
@@ -857,9 +958,9 @@ class Config(object):
             self._change_role(old_role, role)
         assert self.nodeinfo["role"]
         if self.nodeinfo["role"] == "replica":
-            assert self.master_url
-        if self.master_url:
-            self.nodeinfo["masterurl"] = self.master_url.url
+            assert self.primary_url
+        if self.primary_url:
+            self.nodeinfo["masterurl"] = self.primary_url.url
         else:
             self.nodeinfo.pop("masterurl", None)
 
@@ -901,36 +1002,45 @@ class Config(object):
     def sqlite_file_needed_but_missing(self):
         return (
             self.storage_info['name'] == 'sqlite'
-            and not self.serverdir.join(".sqlite").exists()
+            and not self.server_path.joinpath(".sqlite").exists()
         )
 
     @cached_property
     def secretfile(self):
+        warnings.warn(
+            "The secretfile property is deprecated, "
+            "use secret_path instead",
+            DeprecationWarning,
+            stacklevel=3)
+        return py.path.local(self.secret_path)
+
+    @cached_property
+    def secret_path(self):
         if not self.args.secretfile:
-            secretfile = self.serverdir.join('.secret')
-            if not secretfile.check(file=True):
+            secretfile = self.server_path / '.secret'
+            if not secretfile.is_file():
                 return None
             log.warning(
                 "Using deprecated existing secret file at '%s', use "
                 "--secretfile to explicitly provide the location." % secretfile)
             return secretfile
-        return py.path.local(
-            os.path.expanduser(self.args.secretfile))
+        return Path(self.args.secretfile).expanduser()
 
     def get_validated_secret(self):
         from .main import Fatal
         import stat
-        if not self.secretfile.check(file=True):
+        secret_path = self.secret_path
+        if not secret_path.is_file():
             raise Fatal("The given secret file doesn't exist.")
-        if self.secretfile.stat().mode & stat.S_IRWXO and sys.platform != "win32":
+        if secret_path.stat().st_mode & stat.S_IRWXO and sys.platform != "win32":
             raise Fatal("The given secret file is world accessible, the access mode must be user accessible only (0600).")
-        if self.secretfile.stat().mode & stat.S_IRWXG and sys.platform != "win32":
+        if secret_path.stat().st_mode & stat.S_IRWXG and sys.platform != "win32":
             raise Fatal("The given secret file is group accessible, the access mode must be user accessible only (0600).")
-        if self.secretfile.dirpath().stat().mode & stat.S_IWGRP and sys.platform != "win32":
+        if secret_path.parent.stat().st_mode & stat.S_IWGRP and sys.platform != "win32":
             raise Fatal("The folder of the given secret file is group writable, it must only be writable by the user.")
-        if self.secretfile.dirpath().stat().mode & stat.S_IWOTH and sys.platform != "win32":
+        if secret_path.parent.stat().st_mode & stat.S_IWOTH and sys.platform != "win32":
             raise Fatal("The folder of the given secret file is world writable, it must only be writable by the user.")
-        secret = self.secretfile.read_binary()
+        secret = secret_path.read_bytes()
         if len(secret) < 32:
             raise Fatal(
                 "The secret in the given secret file is too short, "
@@ -943,7 +1053,7 @@ class Config(object):
 
     @cached_property
     def basesecret(self):
-        if self.secretfile is None:
+        if self.secret_path is None:
             log.warning(
                 "No secret file provided, creating a new random secret. "
                 "Login tokens issued before are invalid. "
@@ -952,7 +1062,7 @@ class Config(object):
                 "devpi-gen-secret command.")
             return new_secret()
         secret = self.get_validated_secret()
-        log.info("Using secret file '%s'.", self.secretfile)
+        log.info("Using secret file '%s'.", self.secret_path)
         return secret
 
     @property
@@ -994,7 +1104,6 @@ def getpath(path):
 
 
 def gensecret():
-    from .log import configure_cli_logging
     from .log import threadlog as log
     from .main import CommandRunner
     from .main import Fatal
@@ -1005,22 +1114,22 @@ def gensecret():
             add_help=False)
         parser.add_help_option()
         parser.add_configfile_option()
+        parser.add_logging_options()
         parser.add_secretfile_option()
         config = runner.get_config(sys.argv, parser=parser)
-        configure_cli_logging(config.args)
+        runner.configure_logging(config.args)
         if config.args.secretfile is None:
             raise Fatal("You need to provide a location for the secret file.")
-        if not config.secretfile.exists():
-            with config.secretfile.open("wb") as f:
-                f.write(new_secret())
-            log.info("New secret written to '%s'" % config.secretfile)
+        if not config.secret_path.exists():
+            config.secret_path.write_bytes(new_secret())
+            log.info("New secret written to '%s'" % config.secret_path)
             if sys.platform != "win32":
-                mode = config.secretfile.stat().mode
+                mode = config.secret_path.stat().st_mode
                 if mode & stat.S_IRWXG or mode & stat.S_IRWXO:
-                    config.secretfile.chmod(0o600)
+                    config.secret_path.chmod(0o600)
                     log.info("Changed file mode to 0600 to adjust access permissions.")
         else:
-            log.info("Checking existing secret at '%s'" % config.secretfile)
+            log.info("Checking existing secret at '%s'" % config.secret_path)
         # run checks
         config.get_validated_secret()
         log.info("Permissions of secret file look good.")