wandb 0.13.10__py3-none-any.whl → 0.14.0__py3-none-any.whl

wandb/sdk/lib/_settings_toposort_generated.py

@@ -0,0 +1,201 @@
+# DO NOT EDIT -- GENERATED BY: `generate-tool.py --generate`
+__all__ = ("SETTINGS_TOPOLOGICALLY_SORTED", "_Setting")
+
+import sys
+from typing import Tuple
+
+if sys.version_info >= (3, 8):
+    from typing import Final, Literal
+else:
+    from typing_extensions import Final, Literal
+
+
+_Setting = Literal[
+    "_args",
+    "_cli_only_mode",
+    "_colab",
+    "_config_dict",
+    "_console",
+    "_cuda",
+    "_disable_meta",
+    "_disable_service",
+    "_disable_stats",
+    "_disable_viewer",
+    "_except_exit",
+    "_executable",
+    "_flow_control_custom",
+    "_flow_control_disabled",
+    "_internal_check_process",
+    "_internal_queue_timeout",
+    "_jupyter",
+    "_jupyter_name",
+    "_jupyter_path",
+    "_jupyter_root",
+    "_kaggle",
+    "_live_policy_rate_limit",
+    "_live_policy_wait_time",
+    "_log_level",
+    "_network_buffer",
+    "_noop",
+    "_offline",
+    "_sync",
+    "_os",
+    "_platform",
+    "_python",
+    "_runqueue_item_id",
+    "_save_requirements",
+    "_service_transport",
+    "_service_wait",
+    "_start_datetime",
+    "_start_time",
+    "_stats_pid",
+    "_stats_sample_rate_seconds",
+    "_stats_samples_to_average",
+    "_stats_join_assets",
+    "_stats_neuron_monitor_config_path",
+    "_stats_open_metrics_endpoints",
+    "_stats_open_metrics_filters",
+    "_tmp_code_dir",
+    "_tracelog",
+    "_unsaved_keys",
+    "_windows",
+    "allow_val_change",
+    "anonymous",
+    "api_key",
+    "base_url",
+    "code_dir",
+    "config_paths",
+    "console",
+    "deployment",
+    "disable_code",
+    "disable_git",
+    "disable_hints",
+    "disable_job_creation",
+    "disabled",
+    "docker",
+    "email",
+    "entity",
+    "files_dir",
+    "force",
+    "git_commit",
+    "git_remote",
+    "git_remote_url",
+    "git_root",
+    "heartbeat_seconds",
+    "host",
+    "ignore_globs",
+    "init_timeout",
+    "is_local",
+    "label_disable",
+    "launch",
+    "launch_config_path",
+    "log_dir",
+    "log_internal",
+    "log_symlink_internal",
+    "log_symlink_user",
+    "log_user",
+    "login_timeout",
+    "magic",
+    "mode",
+    "notebook_name",
+    "problem",
+    "program",
+    "program_relpath",
+    "project",
+    "project_url",
+    "quiet",
+    "reinit",
+    "relogin",
+    "resume",
+    "resume_fname",
+    "resumed",
+    "root_dir",
+    "run_group",
+    "run_id",
+    "run_job_type",
+    "run_mode",
+    "run_name",
+    "run_notes",
+    "run_tags",
+    "run_url",
+    "sagemaker_disable",
+    "save_code",
+    "settings_system",
+    "settings_workspace",
+    "show_colors",
+    "show_emoji",
+    "show_errors",
+    "show_info",
+    "show_warnings",
+    "silent",
+    "start_method",
+    "strict",
+    "summary_errors",
+    "summary_timeout",
+    "summary_warnings",
+    "sweep_id",
+    "sweep_param_path",
+    "sweep_url",
+    "symlink",
+    "sync_dir",
+    "sync_file",
+    "sync_symlink_latest",
+    "system_sample",
+    "system_sample_seconds",
+    "table_raise_on_max_row_limit_exceeded",
+    "timespec",
+    "tmp_dir",
+    "username",
+    "wandb_dir",
+]
+
+SETTINGS_TOPOLOGICALLY_SORTED: Final[Tuple[_Setting, ...]] = (
+    "_service_wait",
+    "_stats_sample_rate_seconds",
+    "_stats_samples_to_average",
+    "anonymous",
+    "api_key",
+    "base_url",
+    "console",
+    "mode",
+    "problem",
+    "project",
+    "start_method",
+    "_colab",
+    "_console",
+    "_jupyter",
+    "_kaggle",
+    "_noop",
+    "disabled",
+    "_offline",
+    "_network_buffer",
+    "_flow_control_disabled",
+    "_flow_control_custom",
+    "_stats_neuron_monitor_config_path",
+    "run_id",
+    "run_mode",
+    "_start_datetime",
+    "timespec",
+    "root_dir",
+    "wandb_dir",
+    "tmp_dir",
+    "_tmp_code_dir",
+    "_windows",
+    "is_local",
+    "deployment",
+    "files_dir",
+    "log_dir",
+    "log_internal",
+    "log_symlink_internal",
+    "log_symlink_user",
+    "log_user",
+    "project_url",
+    "resume_fname",
+    "run_url",
+    "settings_system",
+    "settings_workspace",
+    "sweep_url",
+    "sync_dir",
+    "sync_file",
+    "sync_symlink_latest",
+)

wandb/sdk/lib/apikey.py

@@ -1,6 +1,4 @@
-"""
-apikey util.
-"""
+"""apikey util."""
 
 import os
 import stat
@@ -151,7 +149,7 @@ def prompt_api_key(  # noqa: C901
 
 
 def write_netrc(host, entity, key):
-    """Add our host and key to .netrc"""
+    """Add our host and key to .netrc."""
     key_prefix, key_suffix = key.split("-", 1) if "-" in key else ("", key)
     if len(key_suffix) != 40:
         wandb.termerror(

wandb/sdk/lib/config_util.py

@@ -1,6 +1,7 @@
 import json
 import logging
 import os
+from typing import Any, Dict, Optional
 
 import yaml
 
@@ -93,7 +94,9 @@ def save_config_file_from_dict(config_filename, config_dict):
         conf_file.write(data)
 
 
-def dict_from_config_file(filename, must_exist=False):
+def dict_from_config_file(
+    filename: str, must_exist: bool = False
+) -> Optional[Dict[str, Any]]:
     if not os.path.exists(filename):
         if must_exist:
             raise ConfigError("config file %s doesn't exist" % filename)

wandb/sdk/lib/console.py

@@ -1,6 +1,4 @@
-"""
-console.
-"""
+"""console."""
 
 import os
 

wandb/sdk/lib/deprecate.py

@@ -21,9 +21,9 @@ def deprecate(
     warning_message: str,
     run: Optional["wandb_run.Run"] = None,
 ) -> None:
-    """
-    Warn the user that a feature has been deprecated
-    and store the information about the event in telemetry.
+    """Warn the user that a feature has been deprecated.
+
+    Also stores the information about the event in telemetry.
 
     Args:
         field_name: The name of the feature that has been deprecated.

wandb/sdk/lib/file_stream_utils.py

@@ -5,14 +5,16 @@ from typing import Any, Dict, Iterable
 def split_files(
     files: Dict[str, Any], max_bytes: int = 10 * 1024 * 1024
 ) -> Iterable[Dict[str, Dict]]:
-    """
-    Splits a files dict (see `files` arg) into smaller dicts of at most `MAX_BYTES` size.
-    This method is used in `FileStreamAPI._send()` to limit the size of post requests sent
-    to wandb server.
+    """Split a file's dict (see `files` arg) into smaller dicts.
+
+    Each smaller dict will have at most `MAX_BYTES` size.
+
+    This method is used in `FileStreamAPI._send()` to limit the size of post requests
+    sent to wandb server.
 
     Arguments:
     files (dict): `dict` of form {file_name: {'content': ".....", 'offset': 0}}
-                The key `file_name` can also be mapped to a List [{"offset": int, "content": str}]
+        The key `file_name` can also be mapped to a List [{"offset": int, "content": str}]
     `max_bytes`: max size for chunk in bytes
     """
     current_volume: Dict[str, Dict] = {}

wandb/sdk/lib/filenames.py

@@ -31,7 +31,7 @@ def is_wandb_file(name: str) -> bool:
 def filtered_dir(
     root: str, include_fn: Callable[[str], bool], exclude_fn: Callable[[str], bool]
 ) -> Generator[str, None, None]:
-    """Simple generator to walk a directory"""
+    """Simple generator to walk a directory."""
     for dirpath, _, files in os.walk(root):
         for fname in files:
             file_path = os.path.join(dirpath, fname)

wandb/sdk/lib/filesystem.py

@@ -1,21 +1,32 @@
+import logging
 import os
+import platform
 import re
+import shutil
+import stat
 import threading
 from typing import BinaryIO, Union
 
-AnyPath = Union[str, bytes, os.PathLike]
+StrPath = Union[str, "os.PathLike[str]"]
 
+logger = logging.getLogger(__name__)
 
-def mkdir_exists_ok(dir_name: AnyPath) -> None:
+WRITE_PERMISSIONS = stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH | stat.S_IWRITE
+
+
+def mkdir_exists_ok(dir_name: StrPath) -> None:
     """Create `dir_name` and any parent directories if they don't exist.
 
     Raises:
         FileExistsError: if `dir_name` exists and is not a directory.
         PermissionError: if `dir_name` is not writable.
     """
-    os.makedirs(dir_name, exist_ok=True)
-    if not os.access(dir_name, os.W_OK):
-        raise PermissionError(f"{dir_name!s} is not writable")
+    try:
+        os.makedirs(dir_name, exist_ok=True)
+    except FileExistsError as e:
+        raise FileExistsError(f"{dir_name!s} exists and is not a directory") from e
+    except PermissionError as e:
+        raise PermissionError(f"{dir_name!s} is not writable") from e
 
 
 class WriteSerializingFile:
@@ -68,3 +79,48 @@ class CRDedupedFile(WriteSerializingFile):
         if self._buff:
             super().write(self._buff)
         super().close()
+
+
+def copy_or_overwrite_changed(source_path: StrPath, target_path: StrPath) -> StrPath:
+    """Copy source_path to target_path, unless it already exists with the same mtime.
+
+    We liberally add write permissions to deal with the case of multiple users needing
+    to share the same cache or run directory.
+
+    Args:
+        source_path: The path to the file to copy.
+        target_path: The path to copy the file to.
+
+    Returns:
+        The path to the copied file (which may be different from target_path).
+    """
+    return_type = type(target_path)
+
+    if platform.system() == "Windows":
+        head, tail = os.path.splitdrive(str(target_path))
+        if ":" in tail:
+            logger.warning("Replacing ':' in %s with '-'", tail)
+            target_path = os.path.join(head, tail.replace(":", "-"))
+
+    need_copy = (
+        not os.path.isfile(target_path)
+        or os.stat(source_path).st_mtime != os.stat(target_path).st_mtime
+    )
+
+    permissions_plus_write = os.stat(source_path).st_mode | WRITE_PERMISSIONS
+    if need_copy:
+        mkdir_exists_ok(os.path.dirname(target_path))
+        try:
+            # Use copy2 to preserve file metadata (including modified time).
+            shutil.copy2(source_path, target_path)
+        except PermissionError:
+            # If the file is read-only try to make it writable.
+            try:
+                os.chmod(target_path, permissions_plus_write)
+                shutil.copy2(source_path, target_path)
+            except PermissionError as e:
+                raise PermissionError("Unable to overwrite '{target_path!s}'") from e
+        # Prevent future permissions issues by universal write permissions now.
+        os.chmod(target_path, permissions_plus_write)
+
+    return return_type(target_path)  # type: ignore  # 'os.PathLike' is abstract.

wandb/sdk/lib/git.py

@@ -137,7 +137,6 @@ class GitRepo:
         if parsed.port is not None:
             hostname += ":" + str(parsed.port)
         if parsed.password is not None:
-
             return urlunparse(parsed._replace(netloc=f"{parsed.username}:@{hostname}"))
         return urlunparse(parsed._replace(netloc=hostname))
 
@@ -148,8 +147,7 @@ class GitRepo:
         return self.repo.git.rev_parse("--show-toplevel")
 
     def get_upstream_fork_point(self):
-        """Get the most recent ancestor of HEAD that occurs on an upstream
-        branch.
+        """Get the most recent ancestor of HEAD that occurs on an upstream branch.
 
         First looks at the current branch's tracking branch, if applicable. If
         that doesn't work, looks at every other branch to find the most recent

wandb/sdk/lib/import_hooks.py

@@ -1,11 +1,10 @@
-"""
+"""Implements a post-import hook mechanism.
+
+Styled as per PEP-369. Note that it doesn't cope with modules being reloaded.
+
 Note: This file is based on
 https://github.com/GrahamDumpleton/wrapt/blob/1.12.1/src/wrapt/importer.py
 (with slight modifications).
-
-This module implements a post import hook mechanism styled after what is
-described in PEP-369. Note that it doesn't cope with modules being reloaded.
-
 """
 
 import functools
@@ -92,7 +91,6 @@ def register_post_import_hook(hook: Callable, hook_id: str, name: str) -> None:
         module = sys.modules.get(name)
 
         if module is not None:
-
             _post_import_hooks[name] = {}
             if hook:  # type: ignore
                 hook(module)
@@ -230,7 +228,6 @@ class ImportHookFinder:
         # Now call back into the import system again.
 
         try:
-
             # For Python 3 we need to use find_spec().loader
             # from the importlib.util module. It doesn't actually
             # import the target module and only finds the

wandb/sdk/lib/ipython.py

@@ -1,5 +1,6 @@
 import logging
 import sys
+import warnings
 from typing import Optional
 
 import wandb
@@ -39,7 +40,7 @@ def in_jupyter() -> bool:
 
 
 def display_html(html: str):  # type: ignore
-    """Displays HTML in notebooks, is a noop outside of a jupyter context"""
+    """Display HTML in notebooks, is a noop outside of a jupyter context."""
     if wandb.run and wandb.run._settings.silent:
         return
     try:
@@ -51,7 +52,7 @@ def display_html(html: str):  # type: ignore
 
 
 def display_widget(widget):
-    """Displays ipywidgets in notebooks, is a noop outside of a jupyter context"""
+    """Display ipywidgets in notebooks, is a noop outside of a jupyter context."""
     if wandb.run and wandb.run._settings.silent:
         return
     try:
@@ -65,7 +66,7 @@ def display_widget(widget):
 
 
 class ProgressWidget:
-    """A simple wrapper to render a nice progress bar with a label"""
+    """A simple wrapper to render a nice progress bar with a label."""
 
     def __init__(self, widgets, min, max):
         self.widgets = widgets
@@ -98,12 +99,14 @@ class ProgressWidget:
 
 
 def jupyter_progress_bar(min: float = 0, max: float = 1.0) -> Optional[ProgressWidget]:
-    """Returns an ipywidget progress bar or None if we can't import it"""
+    """Return an ipywidget progress bar or None if we can't import it."""
     widgets = wandb.util.get_module("ipywidgets")
     try:
         if widgets is None:
             # TODO: this currently works in iPython but it's deprecated since 4.0
-            from IPython.html import widgets  # type: ignore
+            with warnings.catch_warnings():
+                warnings.simplefilter("ignore")
+                from IPython.html import widgets  # type: ignore
 
         assert hasattr(widgets, "VBox")
         assert hasattr(widgets, "Label")

wandb/sdk/lib/lazyloader.py

@@ -1,6 +1,4 @@
-"""
-module lazyloader
-"""
+"""module lazyloader."""
 
 
 import importlib

wandb/sdk/lib/mailbox.py

@@ -1,6 +1,4 @@
-"""
-mailbox.
-"""
+"""mailbox."""
 
 import secrets
 import string
@@ -8,7 +6,7 @@ import threading
 import time
 from typing import TYPE_CHECKING, Callable, Dict, List, Optional, Tuple
 
-from wandb.errors import MailboxError
+from wandb.errors import Error
 from wandb.proto import wandb_internal_pb2 as pb
 
 if TYPE_CHECKING:
@@ -22,6 +20,18 @@ def _generate_address(length: int = 12) -> str:
     return address
 
 
+class MailboxError(Error):
+    """Generic Mailbox Exception."""
+
+    pass
+
+
+class ContextCancelledError(MailboxError):
+    """Context cancelled Exception."""
+
+    pass
+
+
 class _MailboxWaitAll:
     _event: threading.Event
     _lock: threading.Lock

wandb/sdk/lib/proto_util.py

@@ -72,7 +72,8 @@ def settings_dict_from_pbmap(
     for k in pbmap:
         v_obj = pbmap[k]
         v_type = v_obj.WhichOneof("value_type")
-        v: Union[int, str, float, None, tuple, datetime] = None
+
+        v: Union[int, str, float, None, tuple, dict, datetime] = None
         if v_type == "int_value":
             v = v_obj.int_value
         elif v_type == "string_value":
@@ -85,6 +86,13 @@ def settings_dict_from_pbmap(
             v = None
         elif v_type == "tuple_value":
             v = tuple(v_obj.tuple_value.string_values)
+        elif v_type == "map_value":
+            v = dict(v_obj.map_value.map_values)
+        elif v_type == "nested_map_value":
+            v = {
+                k: dict(vv.map_values)
+                for k, vv in dict(v_obj.nested_map_value.nested_map_values).items()
+            }
         elif v_type == "timestamp_value":
             v = datetime.strptime(v_obj.timestamp_value, "%Y%m%d_%H%M%S")
         d[k] = v
@@ -94,10 +102,7 @@ def settings_dict_from_pbmap(
 def message_to_dict(
     message: "Message",
 ) -> Dict[str, Any]:
-    """
-    Converts a protobuf message into a dictionary.
-    """
-
+    """Convert a protobuf message into a dictionary."""
     from google.protobuf.json_format import MessageToDict
 
     return MessageToDict(message, preserving_proto_field_name=True)

wandb/sdk/lib/redirect.py

@@ -104,9 +104,7 @@ def _get_char(code):
 
 
 class Char:
-    """
-    Class encapsulating a single character, its foreground, background and style attributes
-    """
+    """Class encapsulating a single character, its foreground, background and style attributes."""
 
     __slots__ = (
         "data",
@@ -174,17 +172,17 @@ _defchar = Char()
 
 
 class Cursor:
-    """
-    2D cursor
+    """A 2D cursor.
+
+    Attributes:
+        x: x-coordinate.
+        y: y-coordinate.
+        char: the character to inherit colors and styles from.
     """
 
     __slots__ = ("x", "y", "char")
 
     def __init__(self, x=0, y=0, char=None):
-        """
-        x, y - 2D coordinates
-        char - Next character to be written will inherit colors and styles from this character
-        """
         if char is None:
             char = Char()
         self.x = x
@@ -193,8 +191,9 @@ class Cursor:
 
 
 class TerminalEmulator:
-    """
-    An FSM emulating a terminal. Characters are stored in a 2D matrix (buffer) indexed by the cursor.
+    """An FSM emulating a terminal.
+
+    Characters are stored in a 2D matrix (buffer) indexed by the cursor.
     """
 
     _MAX_LINES = 100
@@ -488,8 +487,7 @@ _MIN_CALLBACK_INTERVAL = 2  # seconds
 
 class RedirectBase:
     def __init__(self, src, cbs=()):
-        """
-        # Arguments
+        """# Arguments.
 
         `src`: Source stream to be redirected. "stdout" or "stderr".
         `cbs`: tuple/list of callbacks. Each callback should take exactly 1 argument (bytes).
@@ -527,9 +525,7 @@ class RedirectBase:
 
 
 class StreamWrapper(RedirectBase):
-    """
-    Patches the write method of current sys.stdout/sys.stderr
-    """
+    """Patches the write method of current sys.stdout/sys.stderr."""
 
     def __init__(self, src, cbs=()):
         super().__init__(src=src, cbs=cbs)
@@ -620,8 +616,7 @@ class StreamWrapper(RedirectBase):
 
 
 class StreamRawWrapper(RedirectBase):
-    """
-    Patches the write method of current sys.stdout/sys.stderr
+    """Patches the write method of current sys.stdout/sys.stderr.
 
     Captures data in a raw form rather than using the emulator
     """
@@ -697,7 +692,7 @@ class _WindowSizeChangeHandler:
             win_size = fcntl.ioctl(0, termios.TIOCGWINSZ, "\0" * 8)
             rows, cols, xpix, ypix = struct.unpack("HHHH", win_size)
         # Note: IOError not subclass of OSError in python 2.x
-        except OSError:  # eg. in MPI we can't do this. # noqa
+        except OSError:  # eg. in MPI we can't do this.
             return
         if cols == 0:
             return
@@ -710,9 +705,7 @@ _WSCH = _WindowSizeChangeHandler()
 
 
 class Redirect(RedirectBase):
-    """
-    Redirects low level file descriptors.
-    """
+    """Redirect low level file descriptors."""
 
     def __init__(self, src, cbs=()):
         super().__init__(src=src, cbs=cbs)

wandb/sdk/lib/reporting.py

@@ -1,6 +1,4 @@
-"""
-reporting.
-"""
+"""reporting."""
 
 import logging