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

wandb/sdk/interface/interface.py

@@ -1,4 +1,4 @@
-"""Interface base class - Used to send messages to the internal process
+"""Interface base class - Used to send messages to the internal process.
 
 InterfaceBase: The abstract class
 InterfaceGrpc: Use gRPC to send and receive messages
@@ -267,7 +267,6 @@ class InterfaceBase:
             A new tree of dict's with large objects replaced with dictionaries
             with "_type" entries that say which type the original data was.
         """
-
         # Constructs a new `dict` tree in `json_value` that discards and/or
         # encodes objects that aren't JSON serializable.
 
@@ -396,7 +395,7 @@ class InterfaceBase:
         obj: Optional[pb.ArtifactManifest] = None,
     ) -> pb.ArtifactManifest:
         proto_manifest = obj or pb.ArtifactManifest()
-        proto_manifest.version = artifact_manifest.version()  # type: ignore
+        proto_manifest.version = artifact_manifest.version()
         proto_manifest.storage_policy = artifact_manifest.storage_policy.name()
 
         for k, v in artifact_manifest.storage_policy.config().items() or {}.items():

wandb/sdk/interface/interface_grpc.py

@@ -1,4 +1,4 @@
-"""Backend Sender - Send to internal process
+"""Backend Sender - Send to internal process.
 
 Manage backend sender.
 

wandb/sdk/interface/interface_queue.py

@@ -1,4 +1,4 @@
-"""InterfaceQueue - Derived from InterfaceShared using queues to send to internal thread
+"""InterfaceQueue - Derived from InterfaceShared using queues to send to internal thread.
 
 See interface.py for how interface classes relate to each other.
 

wandb/sdk/interface/interface_relay.py

@@ -1,4 +1,4 @@
-"""InterfaceRelay - Derived from InterfaceQueue using RelayRouter to preserve uuid req/resp
+"""InterfaceRelay - Derived from InterfaceQueue using RelayRouter to preserve uuid req/resp.
 
 See interface.py for how interface classes relate to each other.
 

wandb/sdk/interface/interface_shared.py

@@ -1,4 +1,4 @@
-"""InterfaceShared - Derived from InterfaceBase - shared with InterfaceQueue and InterfaceSock
+"""InterfaceShared - Derived from InterfaceBase - shared with InterfaceQueue and InterfaceSock.
 
 See interface.py for how interface classes relate to each other.
 
@@ -380,7 +380,6 @@ class InterfaceShared(InterfaceBase):
         Returns:
             RunRecord object
         """
-
         req = self._make_record(run=run)
         resp = self._communicate(req, timeout=timeout)
         if resp is None:

wandb/sdk/interface/interface_sock.py

@@ -1,4 +1,4 @@
-"""InterfaceSock - Derived from InterfaceShared using a socket to send to internal thread
+"""InterfaceSock - Derived from InterfaceShared using a socket to send to internal thread.
 
 See interface.py for how interface classes relate to each other.
 

wandb/sdk/interface/message_future.py

@@ -1,4 +1,4 @@
-"""MessageFuture - represents a message result of an asynchronous operation
+"""MessageFuture - represents a message result of an asynchronous operation.
 
 Base class MessageFuture for MessageFutureObject and MessageFuturePoll
 

wandb/sdk/interface/message_future_poll.py

@@ -1,4 +1,4 @@
-"""MessageFuturePoll - Derived from MessageFuture but implementing polling loop
+"""MessageFuturePoll - Derived from MessageFuture but implementing polling loop.
 
 MessageFuture represents a message result of an asynchronous operation.
 

wandb/sdk/interface/router.py

@@ -1,4 +1,4 @@
-"""Router - handle message router (base class)
+"""Router - handle message router (base class).
 
 Router to manage responses.
 

wandb/sdk/interface/router_queue.py

@@ -1,4 +1,4 @@
-"""Router - handle message router (queue)
+"""Router - handle message router (queue).
 
 Router to manage responses from a queue.
 

wandb/sdk/interface/router_relay.py

@@ -1,4 +1,4 @@
-"""Router - handle message router (relay)
+"""Router - handle message router (relay).
 
 Router to manage responses from a queue with relay.
 

wandb/sdk/interface/router_sock.py

@@ -1,4 +1,4 @@
-"""Router - handle message router (sock)
+"""Router - handle message router (sock).
 
 Router to manage responses from a socket client.
 

wandb/sdk/interface/summary_record.py

@@ -8,7 +8,7 @@ import typing as t
 
 
 class SummaryRecord:
-    """Encodes a diff -- analogous to the SummaryRecord protobuf message"""
+    """Encodes a diff -- analogous to the SummaryRecord protobuf message."""
 
     update: t.List["SummaryItem"]
     remove: t.List["SummaryItem"]

wandb/sdk/internal/artifacts.py

@@ -80,7 +80,7 @@ class ArtifactSaver:
         self._api = api
         self._file_pusher = file_pusher
         self._digest = digest
-        self._manifest = ArtifactManifest.from_manifest_json(None, manifest_json)
+        self._manifest = ArtifactManifest.from_manifest_json(manifest_json)
         self._is_user_created = is_user_created
         self._server_artifact = None
 

wandb/sdk/internal/datastore.py

@@ -112,8 +112,7 @@ class DataStore:
         return offset
 
     def in_last_block(self):
-        """When reading, we want to know if we're in the last block to
-        handle in progress writes"""
+        """Determine if we're in the last block to handle in-progress writes."""
         return self._index > self._size_bytes - LEVELDBLOG_DATA_LEN
 
     def scan_record(self):
@@ -260,7 +259,7 @@ class DataStore:
             # write middles (if any)
             while data_left > LEVELDBLOG_DATA_LEN:
                 self._write_record(
-                    s[data_used : data_used + LEVELDBLOG_DATA_LEN],  # noqa: E203
+                    s[data_used : data_used + LEVELDBLOG_DATA_LEN],
                     LEVELDBLOG_MIDDLE,
                 )
                 data_used += LEVELDBLOG_DATA_LEN

wandb/sdk/internal/file_pusher.py

@@ -27,10 +27,11 @@ logger = logging.getLogger(__name__)
 
 class FilePusher:
     """Parallel file upload class.
+
     This manages uploading multiple files in parallel. It will restart a given file's
-    upload job if it receives a notification that that file has been modified.
-    The finish() method will block until all events have been processed and all
-    uploads are complete.
+    upload job if it receives a notification that that file has been modified. The
+    finish() method will block until all events have been processed and all uploads are
+    complete.
     """
 
     MAX_UPLOAD_JOBS = 64
@@ -117,6 +118,7 @@ class FilePusher:
         copy: bool = True,
     ):
         """Tell the file pusher that a file's changed and should be uploaded.
+
         Arguments:
             save_name: string logical location of the file relative to the run
                 directory.

wandb/sdk/internal/file_stream.py

@@ -103,8 +103,9 @@ class SummaryFilePolicy(DefaultFilePolicy):
 
 
 class StreamCRState:
-    """There are two streams: stdout and stderr.
-    We create two instances for each stream.
+    r"""Stream state that tracks carriage returns.
+
+    There are two streams: stdout and stderr. We create two instances for each stream.
     An instance holds state about:
         found_cr:       if a carriage return has been found in this stream.
         cr:             most recent offset (line number) where we found \r.
@@ -124,17 +125,16 @@ class StreamCRState:
 
 
 class CRDedupeFilePolicy(DefaultFilePolicy):
-    """File stream policy that removes characters that would be erased by
-    carriage returns.
+    r"""File stream policy for removing carriage-return erased characters.
 
-    This is what a terminal does. We use it for console output to reduce the
-    amount of data we need to send over the network (eg. for progress bars),
-    while preserving the output's appearance in the web app.
+    This is what a terminal does. We use it for console output to reduce the amount of
+    data we need to send over the network (eg. for progress bars), while preserving the
+    output's appearance in the web app.
 
-    CR stands for "carriage return", for the character \r. It tells the terminal
-    to move the cursor back to the start of the current line. Progress bars
-    (like tqdm) use \r repeatedly to overwrite a line with newer updates.
-    This gives the illusion of the progress bar filling up in real-time.
+    CR stands for "carriage return", for the character \r. It tells the terminal to move
+    the cursor back to the start of the current line. Progress bars (like tqdm) use \r
+    repeatedly to overwrite a line with newer updates. This gives the illusion of the
+    progress bar filling up in real-time.
     """
 
     def __init__(self, start_chunk_id: int = 0) -> None:
@@ -148,7 +148,8 @@ class CRDedupeFilePolicy(DefaultFilePolicy):
 
     @staticmethod
     def get_consecutive_offsets(console: Dict[int, str]) -> List[List[int]]:
-        """
+        """Compress consecutive line numbers into an interval.
+
         Args:
             console: Dict[int, str] which maps offsets (line numbers) to lines of text.
             It represents a mini version of our console dashboard on the UI.
@@ -176,13 +177,14 @@ class CRDedupeFilePolicy(DefaultFilePolicy):
 
     @staticmethod
     def split_chunk(chunk: Chunk) -> Tuple[str, str]:
-        """
+        r"""Split chunks.
+
         Args:
             chunk: object with two fields: filename (str) & data (str)
             `chunk.data` is a str containing the lines we want. It usually contains \n or \r or both.
             `chunk.data` has two possible formats (for the two streams - stdout and stderr):
                 - "2020-08-25T20:38:36.895321 this is my line of text\nsecond line\n"
-                - "ERROR 2020-08-25T20:38:36.895321 this is my line of text\nsecond line\nthird\n"
+                - "ERROR 2020-08-25T20:38:36.895321 this is my line of text\nsecond line\nthird\n".
 
                 Here's another example with a carriage return \r.
                 - "ERROR 2020-08-25T20:38:36.895321 \r progress bar\n"
@@ -206,7 +208,8 @@ class CRDedupeFilePolicy(DefaultFilePolicy):
         return prefix, rest
 
     def process_chunks(self, chunks: List) -> List["ProcessedChunk"]:
-        """
+        r"""Process chunks.
+
         Args:
             chunks: List of Chunk objects. See description of chunk above in `split_chunk(...)`.
 
@@ -268,7 +271,7 @@ class CRDedupeFilePolicy(DefaultFilePolicy):
 
         intervals = self.get_consecutive_offsets(console)
         ret = []
-        for (a, b) in intervals:
+        for a, b in intervals:
             processed_chunk: "ProcessedChunk" = {
                 "offset": a,
                 "content": [console[i] for i in range(a, b + 1)],
@@ -495,7 +498,7 @@ class FileStreamApi:
             raise e
 
     def _handle_response(self, response: Union[Exception, "requests.Response"]) -> None:
-        """Logs dropped chunks and updates dynamic settings"""
+        """Log dropped chunks and updates dynamic settings."""
         if isinstance(response, Exception):
             wandb.termerror(
                 "Dropped streaming file chunk (see wandb/debug-internal.log)"
@@ -575,7 +578,7 @@ class FileStreamApi:
         self._queue.put(Chunk(filename, data))
 
     def push_success(self, artifact_id: str, save_name: str) -> None:
-        """Notification that a file upload has been successfully completed
+        """Notification that a file upload has been successfully completed.
 
         Arguments:
             artifact_id: ID of artifact
@@ -584,7 +587,7 @@ class FileStreamApi:
         self._queue.put(self.PushSuccess(artifact_id, save_name))
 
     def finish(self, exitcode: int) -> None:
-        """Cleans up.
+        """Clean up.
 
         Anything pushed after finish will be dropped.
 

wandb/sdk/internal/handler.py

@@ -413,7 +413,7 @@ class HandleManager:
             self._step += 1
 
     def _history_define_metric(self, hkey: str) -> Optional[MetricRecord]:
-        """check for hkey match in glob metrics, return defined metric."""
+        """Check for hkey match in glob metrics and return the defined metric."""
         # Dont define metric for internal metrics
         if hkey.startswith("_"):
             return None
@@ -478,7 +478,6 @@ class HandleManager:
         history: HistoryRecord,
         history_dict: Dict[str, Any],
     ) -> None:
-
         #  if syncing an old run, we can skip this logic
         if history_dict.get("_step") is None:
             self._history_assign_step(history, history_dict)
@@ -825,8 +824,10 @@ class HandleManager:
         self._dispatch_record(record, always_send=True)
 
     def handle_request_keepalive(self, record: Record) -> None:
-        """keepalive is a noop, we just want to verify transport is alive."""
-        pass
+        """Handle a keepalive request.
+
+        Keepalive is a noop, we just want to verify transport is alive.
+        """
 
     def handle_request_run_status(self, record: Record) -> None:
         self._dispatch_record(record, always_send=True)

wandb/sdk/internal/internal.py

@@ -177,7 +177,7 @@ def wandb_internal(
             traceback.print_exception(*exc_info)
             sentry_exc(exc_info, delay=True)
             wandb.termerror("Internal wandb error: file data was not synced")
-            if settings.get("_require_service"):
+            if not settings.get("_disable_service"):
                 # TODO: We can make this more graceful by returning an error to streams.py
                 # and potentially just fail the one stream.
                 os._exit(-1)