wandb 0.21.4__py3-none-win32.whl → 0.22.1__py3-none-win32.whl

wandb/sdk/wandb_login.py

@@ -77,7 +77,7 @@ def login(
         UsageError: If `api_key` cannot be configured and no tty.
     """
     _handle_host_wandb_setting(host)
-    return _login(
+    logged_in, _ = _login(
         anonymous=anonymous,
         key=key,
         relogin=relogin,
@@ -87,6 +87,7 @@ def login(
         verify=verify,
         referrer=referrer,
     )
+    return logged_in
 
 
 class ApiKeyStatus(enum.Enum):
@@ -245,24 +246,6 @@ class _WandbLogin:
 
         return key, status
 
-    def _verify_login(self, key: str) -> None:
-        api = InternalApi(api_key=key)
-
-        try:
-            is_api_key_valid = api.validate_api_key()
-        except ConnectionError:
-            raise AuthenticationError(
-                "Unable to connect to server to verify API token."
-            )
-        except Exception:
-            raise AuthenticationError("An error occurred while verifying the API key.")
-
-        if not is_api_key_valid:
-            raise AuthenticationError(
-                f"API key verification failed for host {self._settings.base_url}."
-                " Make sure your API key is valid."
-            )
-
 
 def _login(
     *,
@@ -277,11 +260,30 @@ def _login(
     update_api_key: bool = True,
     _silent: Optional[bool] = None,
     _disable_warning: Optional[bool] = None,
-) -> bool:
+) -> (bool, Optional[str]):
+    """Logs in to W&B.
+
+    This is the internal implementation of wandb.login(),
+    with many of the same arguments as wandb.login().
+    Additional arguments are documented below.
+
+    Args:
+        update_api_key: If true, the api key will be saved or updated
+            in the users .netrc file.
+        _silent: If true, will not print any messages to the console.
+        _disable_warning: If true, no warning will be displayed
+            when calling wandb.login() after wandb.init().
+
+    Returns:
+        bool: If the login was successful
+            or the user is assumed to be already be logged in.
+        str: The API key used to log in,
+            or None if the api key was not verified during the login process.
+    """
     if wandb.run is not None:
         if not _disable_warning:
             wandb.termwarn("Calling wandb.login() after wandb.init() has no effect.")
-        return True
+        return True, None
 
     wlogin = _WandbLogin(
         anonymous=anonymous,
@@ -293,19 +295,19 @@ def _login(
     )
 
     if wlogin._settings._noop:
-        return True
+        return True, None
 
     if wlogin._settings._offline and not wlogin._settings.x_cli_only_mode:
         wandb.termwarn("Unable to verify login in offline mode.")
-        return False
+        return False, None
     elif wandb.util._is_kaggle() and not wandb.util._has_internet():
         wandb.termerror(
             "To use W&B in kaggle you must enable internet in the settings panel on the right."
         )
-        return False
+        return False, None
 
     if wlogin._settings.identity_token_file:
-        return True
+        return True, None
 
     key_is_pre_configured = False
     key_status = None
@@ -318,7 +320,7 @@ def _login(
             key, key_status = wlogin.prompt_api_key(referrer=referrer)
 
     if verify:
-        wlogin._verify_login(key)
+        _verify_login(key, wlogin._settings.base_url)
 
     if not key_is_pre_configured:
         if update_api_key:
@@ -329,4 +331,28 @@ def _login(
     if key and not _silent:
         wlogin._print_logged_in_message()
 
-    return key is not None
+    return key is not None, key
+
+
+def _verify_login(key: str, base_url: str) -> None:
+    api = InternalApi(
+        api_key=key,
+        default_settings={"base_url": base_url},
+    )
+
+    try:
+        is_api_key_valid = api.validate_api_key()
+    except ConnectionError:
+        raise AuthenticationError(
+            "Unable to connect to server to verify API token."
+        ) from None
+    except Exception as e:
+        raise AuthenticationError(
+            "An error occurred while verifying the API key."
+        ) from e
+
+    if not is_api_key_valid:
+        raise AuthenticationError(
+            f"API key verification failed for host {base_url}."
+            " Make sure your API key is valid."
+        )

wandb/sdk/wandb_run.py

@@ -33,6 +33,7 @@ from wandb.errors import CommError, UsageError
 from wandb.errors.links import url_registry
 from wandb.integration.torch import wandb_torch
 from wandb.plot import CustomChart, Visualize
+from wandb.proto import wandb_internal_pb2 as pb
 from wandb.proto.wandb_deprecated import Deprecated
 from wandb.proto.wandb_internal_pb2 import (
     MetricRecord,
@@ -41,7 +42,6 @@ from wandb.proto.wandb_internal_pb2 import (
     RunRecord,
 )
 from wandb.sdk.artifacts._internal_artifact import InternalArtifact
-from wandb.sdk.artifacts._validators import is_artifact_registry_project
 from wandb.sdk.artifacts.artifact import Artifact
 from wandb.sdk.internal import job_builder
 from wandb.sdk.lib import asyncio_compat, wb_logging
@@ -2698,7 +2698,9 @@ class Run:
             assert self._backend and self._backend.interface
 
             while True:
-                handle = self._backend.interface.deliver_poll_exit()
+                handle = await self._backend.interface.deliver_async(
+                    pb.Record(request=pb.Request(poll_exit=pb.PollExitRequest()))
+                )
 
                 time_start = time.monotonic()
                 last_result = await handle.wait_async(timeout=None)
@@ -3004,7 +3006,7 @@ class Run:
         # the target entity to the run's entity.  Instead, delegate to
         # Artifact.link() to resolve the required org entity.
         target = ArtifactPath.from_str(target_path)
-        if not (target.project and is_artifact_registry_project(target.project)):
+        if not target.is_registry_path():
             target = target.with_defaults(prefix=self.entity, project=self.project)
 
         return artifact.link(target.to_str(), aliases)

wandb/sdk/wandb_settings.py

@@ -160,6 +160,7 @@ CLIENT_ONLY_SETTINGS = (
     "reinit",
     "max_end_of_run_history_metrics",
     "max_end_of_run_summary_metrics",
+    "x_sync_dir_suffix",
 )
 """Python-only keys that are not fields on the settings proto."""
 
@@ -941,6 +942,13 @@ class Settings(BaseModel, validate_assignment=True):
     <!-- lazydoc-ignore-class-attributes -->
     """
 
+    x_sync_dir_suffix: str = ""
+    """Suffix to add to the run's directory name (sync_dir).
+
+    This is set in wandb.init() to avoid naming conflicts.
+    If set, it is joined to the default name with a dash.
+    """
+
     x_update_finish_state: bool = True
     """Flag to indicate whether this process can update the run's final state on the server.
 
@@ -954,6 +962,8 @@ class Settings(BaseModel, validate_assignment=True):
         """Check if a private field is provided and assign to the corresponding public one.
 
         This is a compatibility layer to handle previous versions of the settings.
+
+        <!-- lazydoc-ignore: internal -->
         """
         new_values = {}
         for key in values:
@@ -988,6 +998,10 @@ class Settings(BaseModel, validate_assignment=True):
 
         @model_validator(mode="after")
         def validate_skip_transaction_log(self):
+            """Validate x_skip_transaction_log.
+
+            <!-- lazydoc-ignore: internal -->
+            """
             if self._offline and self.x_skip_transaction_log:
                 raise ValueError("Cannot skip transaction log in offline mode")
             return self
@@ -1445,6 +1459,8 @@ class Settings(BaseModel, validate_assignment=True):
         - Converts single string values to tuple format
         - Preserves None values
 
+        <!-- lazydoc-ignore-classmethod: internal -->
+
         Args:
             value: A string, list, tuple, or None representing tags
 
@@ -1453,8 +1469,6 @@ class Settings(BaseModel, validate_assignment=True):
 
         Raises:
             ValueError: If any tag is empty or exceeds 64 characters
-
-        <!-- lazydoc-ignore-classmethod: internal -->
         """
         if value is None:
             return None
@@ -1733,10 +1747,12 @@ class Settings(BaseModel, validate_assignment=True):
     @property
     def sync_dir(self) -> str:
         """The directory for storing the run's files."""
-        return _path_convert(
-            self.wandb_dir,
-            f"{self.run_mode}-{self.timespec}-{self.run_id}",
-        )
+        name = f"{self.run_mode}-{self.timespec}-{self.run_id}"
+
+        if self.x_sync_dir_suffix:
+            name += f"-{self.x_sync_dir_suffix}"
+
+        return _path_convert(self.wandb_dir, name)
 
     @computed_field  # type: ignore[prop-decorator]
     @property
@@ -1776,7 +1792,10 @@ class Settings(BaseModel, validate_assignment=True):
     # wandb/sdk/wandb_setup.py::_WandbSetup._settings_setup.
 
     def update_from_system_config_file(self):
-        """Update settings from the system config file."""
+        """Update settings from the system config file.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if not self.settings_system or not os.path.exists(self.settings_system):
             return
         for key, value in self._load_config_file(self.settings_system).items():
@@ -1784,7 +1803,10 @@ class Settings(BaseModel, validate_assignment=True):
                 setattr(self, key, value)
 
     def update_from_workspace_config_file(self):
-        """Update settings from the workspace config file."""
+        """Update settings from the workspace config file.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if not self.settings_workspace or not os.path.exists(self.settings_workspace):
             return
         for key, value in self._load_config_file(self.settings_workspace).items():
@@ -1792,7 +1814,10 @@ class Settings(BaseModel, validate_assignment=True):
                 setattr(self, key, value)
 
     def update_from_env_vars(self, environ: Dict[str, Any]):
-        """Update settings from environment variables."""
+        """Update settings from environment variables.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         env_prefix: str = "WANDB_"
         private_env_prefix: str = env_prefix + "_"
         special_env_var_names = {
@@ -1829,7 +1854,10 @@ class Settings(BaseModel, validate_assignment=True):
                 setattr(self, key, value)
 
     def update_from_system_environment(self):
-        """Update settings from the system environment."""
+        """Update settings from the system environment.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         # For code saving, only allow env var override if value from server is true, or
         # if no preference was specified.
         if (self.save_code is True or self.save_code is None) and (
@@ -1909,13 +1937,19 @@ class Settings(BaseModel, validate_assignment=True):
         self.program = program
 
     def update_from_dict(self, settings: Dict[str, Any]) -> None:
-        """Update settings from a dictionary."""
+        """Update settings from a dictionary.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         for key, value in dict(settings).items():
             if value is not None:
                 setattr(self, key, value)
 
     def update_from_settings(self, settings: Settings) -> None:
-        """Update settings from another instance of `Settings`."""
+        """Update settings from another instance of `Settings`.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         d = {field: getattr(settings, field) for field in settings.model_fields_set}
         if d:
             self.update_from_dict(d)
@@ -1923,7 +1957,10 @@ class Settings(BaseModel, validate_assignment=True):
     # Helper methods.
 
     def to_proto(self) -> wandb_settings_pb2.Settings:
-        """Generate a protobuf representation of the settings."""
+        """Generate a protobuf representation of the settings.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         settings_proto = wandb_settings_pb2.Settings()
         for k, v in self.model_dump(exclude_none=True).items():
             if k in CLIENT_ONLY_SETTINGS:

wandb/sync/sync.py

@@ -193,7 +193,7 @@ class SyncThread(threading.Thread):
             x_start_time=time.time(),
         )
 
-        settings_static = SettingsStatic(settings.to_proto())
+        settings_static = SettingsStatic(dict(settings))
 
         handle_manager = handler.HandleManager(
             settings=settings_static,
@@ -207,7 +207,12 @@ class SyncThread(threading.Thread):
 
         filesystem.mkdir_exists_ok(settings.files_dir)
         send_manager.send_run(record, file_dir=settings.files_dir)
-        watcher = tb_watcher.TBWatcher(settings, proto_run, new_interface, True)
+        watcher = tb_watcher.TBWatcher(
+            settings_static,
+            proto_run,
+            new_interface,
+            True,
+        )
 
         for tb in tb_logdirs:
             watcher.add(tb, True, tb_root)

wandb/util.py

@@ -229,7 +229,7 @@ def import_module_lazy(name: str) -> types.ModuleType:
 
 def get_module(
     name: str,
-    required: Optional[Union[str, bool]] = None,
+    required: Optional[str] = None,
     lazy: bool = True,
 ) -> Any:
     """Return module or None. Absolute import is required.

wandb/wandb_agent.py

@@ -42,11 +42,42 @@ class AgentProcess:
         if command:
             if platform.system() == "Windows":
                 kwargs = dict(creationflags=subprocess.CREATE_NEW_PROCESS_GROUP)
+                env.pop(wandb.env.SERVICE, None)
+                # TODO: Determine if we need the same stdin workaround as POSIX case below.
+                self._popen = subprocess.Popen(command, env=env, **kwargs)
             else:
-                kwargs = dict(preexec_fn=os.setpgrp)
-            if env.get(wandb.env.SERVICE):
-                env.pop(wandb.env.SERVICE)
-            self._popen = subprocess.Popen(command, env=env, **kwargs)
+                if sys.version_info >= (3, 11):
+                    # preexec_fn=os.setpgrp is not thread-safe; process_group was introduced in
+                    # python 3.11 to replace it, so use that when possible
+                    kwargs = dict(process_group=0)
+                else:
+                    kwargs = dict(preexec_fn=os.setpgrp)
+                env.pop(wandb.env.SERVICE, None)
+                # Upon spawning the subprocess in a new process group, the child's process group is
+                # not connected to the controlling terminal's stdin. If it tries to access stdin,
+                # it gets a SIGTTIN and blocks until we give it the terminal, which we don't want
+                # to do.
+                #
+                # By using subprocess.PIPE, we give it an independent stdin. However, it will still
+                # block if it tries to read from stdin, because we're not writing anything to it.
+                # We immediately close the subprocess's stdin here so it can fail fast and get an
+                # EOF.
+                #
+                # (One situation that makes this relevant is that importing `readline` even
+                # indirectly can cause the child to attempt to access stdin, which can trigger the
+                # deadlock. In Python 3.13, `import torch` indirectly imports `readline` via `pdb`,
+                # meaning `import torch` in a run script can deadlock unless we override stdin.
+                # See https://github.com/wandb/wandb/pull/10489 description for more details.)
+                #
+                # Also, we avoid spawning a new session because that breaks preempted child process
+                # handling.
+                self._popen = subprocess.Popen(
+                    command,
+                    env=env,
+                    stdin=subprocess.PIPE,
+                    **kwargs,
+                )
+                self._popen.stdin.close()
         elif function:
             self._proc = multiprocessing.Process(
                 target=self._start,

{wandb-0.21.4.dist-info → wandb-0.22.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: wandb
-Version: 0.21.4
+Version: 0.22.1
 Summary: A CLI and library for interacting with the Weights & Biases API.
 Project-URL: Source, https://github.com/wandb/wandb
 Project-URL: Bug Reports, https://github.com/wandb/wandb/issues