bosdyn-core 3.3.2__py3-none-any.whl → 4.0.1__py3-none-any.whl

bosdyn/bddf/file_indexer.py

@@ -83,7 +83,7 @@ class FileIndexer:
 
         Args:
          series_type:   the kind of spec, corresponding to the set of keys expected in series_spec.
-         series_spec:   dict of {key (string) -> value (string)| describing the series.
+         series_spec:   dict of {key (string) -> value (string)} describing the series.
          message_type:  MessageTypeDescriptor (need EITHER this OR pod_type)
          pod_type:      PodTypeDescriptor (need EITHER this OR pod_type)
          annotations:   optional dict of key (string) -> value (string) pairs to
@@ -138,7 +138,7 @@ class FileIndexer:
 
     def index_data_block(  # pylint: disable=too-many-arguments
             self, series_index, timestamp_nsec, file_offset, nbytes, additional_indexes):
-        """Add a an entry to the data block index of the series identified by series_index."""
+        """Add an entry to the data block index of the series identified by series_index."""
         series_block_index = self._series_block_indexes[series_index]
         block_entry = series_block_index.block_entries.add(file_offset=file_offset)
         block_entry.timestamp.FromNanoseconds(timestamp_nsec)

bosdyn/deprecated.py

@@ -0,0 +1,47 @@
+# Copyright (c) 2023 Boston Dynamics, Inc.  All rights reserved.
+#
+# Downloading, reproducing, distributing or otherwise using the SDK Software
+# is subject to the terms and conditions of the Boston Dynamics Software
+# Development Kit License (20191101-BDSDK-SL).
+
+from functools import wraps
+
+from deprecated.sphinx import deprecated
+
+
+def moved_to(new_func, **deprecation_kwargs):
+    """Deprecate a function because it was moved to another location."""
+    deprecation_kwargs.setdefault(
+        'reason', f'This has been moved to {new_func.__module__}. '
+        f'Please use {new_func.__module__}.{new_func.__name__} instead.')
+    return _deprecate_to_new(new_func, **deprecation_kwargs)
+
+
+def renamed_to(new_func, **deprecation_kwargs):
+    """Deprecate a function because it was renamed."""
+    deprecation_kwargs.setdefault(
+        'reason',
+        f'This has been renamed to {new_func.__name__}.  Please use {new_func.__name__} instead.')
+    return _deprecate_to_new(new_func, **deprecation_kwargs)
+
+
+def _deprecate_to_new(new_func, **deprecation_kwargs):
+    """Deprecation helper that creates a wrapper with a new docstring that deprecated() can modify.
+    When using deprecated.sphinx.deprecated, it modifies the docstring of the wrapped function.
+    For cases where we have moved a function and want to deprecate the old location, we would often
+    write
+
+        old_name = deprecated(reason = ...)(new_name)
+
+    which has the unfortunate side effect of modifying the new name to say in its docstring that it
+    is deprecated.
+
+    This alternate version will prevent the original's docstring from being modified, only modifying
+    the wrapper's docstring."""
+    deprecation_kwargs.setdefault('action', 'always')
+
+    @wraps(new_func)
+    def wrapper(*args, **kwargs):
+        return new_func(*args, **kwargs)
+
+    return deprecated(**deprecation_kwargs)(wrapper)

bosdyn/util.py

@@ -5,27 +5,34 @@
 # Development Kit License (20191101-BDSDK-SL).
 
 """Common utilities for API Python code."""
-from __future__ import division
-
 import datetime
+import os
 import re
 import sys
 import time
+from typing import Callable
 
 from google.protobuf.duration_pb2 import Duration
 from google.protobuf.timestamp_pb2 import Timestamp
 
-if sys.version_info[0] >= 3:
-    LONG = int
-else:
-    LONG = long
-
 THOUSAND = 10**3
 MILLION = 10**6
 BILLION = 10**9
 
 NSEC_PER_SEC = BILLION
 
+# Returns the time in seconds.
+ClockFn = Callable[[], float]
+
+# Global variable representing the current clock source.
+_clock_source_fn: ClockFn = time.time
+
+
+def set_clock_source(clock_fn: ClockFn) -> None:
+    """Set the clock source to use the input clock source."""
+    global _clock_source_fn
+    _clock_source_fn = clock_fn
+
 
 def duration_str(duration):
     """Return a formatted string for a duration proto.
@@ -95,14 +102,14 @@ def timestamp_str(timestamp):
 
 
 def sec_to_nsec(secs):
-    """Convert time in seconds as from time.time() to a timestamp in nanoseconds.
+    """Convert time in seconds as from _clock_source_fn() to a timestamp in nanoseconds.
 
     Args:
      secs: Time in seconds
     Returns:
      The time in nanoseconds, as an integer.
     """
-    return LONG(secs * NSEC_PER_SEC)
+    return int(secs * NSEC_PER_SEC)
 
 
 def nsec_to_sec(secs):
@@ -118,12 +125,12 @@ def nsec_to_sec(secs):
 
 def now_nsec():
     """Returns nanoseconds from dawn of unix epoch until when this is called."""
-    return sec_to_nsec(time.time())
+    return sec_to_nsec(now_sec())
 
 
 def now_sec():
     """Returns seconds from dawn of unix epoch until when this is called."""
-    return time.time()
+    return _clock_source_fn()
 
 
 def set_timestamp_from_now(timestamp_proto):
@@ -221,7 +228,7 @@ def secs_to_hms(seconds):
 
 
 def distance_str(meters):
-    """Convert a distance in meters to a either xxx.xx m or xxx.xx km
+    """Convert a distance in meters to either xxx.xx m or xxx.xx km
 
     Args:
       meters (float/int):   distance in meters

{bosdyn_core-3.3.2.dist-info → bosdyn_core-4.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bosdyn-core
-Version: 3.3.2
+Version: 4.0.1
 Summary: Boston Dynamics API Core code and interfaces
 Home-page: https://dev.bostondynamics.com/
 Author: Boston Dynamics
@@ -15,7 +15,7 @@ Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
-Requires-Dist: bosdyn-api (==3.3.2)
+Requires-Dist: bosdyn-api (==4.0.1)
 Requires-Dist: Deprecated (~=1.2.10)
 
 <!--

{bosdyn_core-3.3.2.dist-info → bosdyn_core-4.0.1.dist-info}/RECORD

@@ -1,6 +1,7 @@
 bosdyn/__init__.py,sha256=CMQioQKK1NlMk3kZuY49b_Aw-JyvDeOtuqOCAul1I0s,330
+bosdyn/deprecated.py,sha256=ND0eBVsxvEhosH1IN-IhQu5lCDO4_OXtWVUG53uutGI,1889
 bosdyn/geometry.py,sha256=usWzbOUc_NgqtBdEZSnMklTO5CmxNAuiaGQjgp6ZY24,2384
-bosdyn/util.py,sha256=jYDtjQmhQ1qZGzGh6jc94UMKd8GFibA79kVqgQGSZ5I,12940
+bosdyn/util.py,sha256=M29e8lFxGT2w5WxRAexYtmYkRRl0tBVzzDDqSMpeGDw,13218
 bosdyn/bddf/__init__.py,sha256=m-3eQsJOfmkTN7h5g_hcPZOLcFocLAxbaQVHLM8NTYw,1828
 bosdyn/bddf/base_data_reader.py,sha256=GXCkUni96550zIeRQ7CgBI6ToPMZimjQ-s3XEo3TlCE,7665
 bosdyn/bddf/block_writer.py,sha256=OB5Qu6syp6TDD72mFxTBLsuYY7O_KNv53YrdZPS-qJw,3300
@@ -8,7 +9,7 @@ bosdyn/bddf/bosdyn.py,sha256=WZBouAEu9kQ5zXayv9S0wM7NeJMVaNoIQaXlk34LY-4,1439
 bosdyn/bddf/common.py,sha256=sGi96F7e1-JuQo3KG7qTs-Uh3S61QL8jxNFTAYljhPk,2498
 bosdyn/bddf/data_reader.py,sha256=jhDF_i2EZ7DZXQFXtRjnAsyuGgL4wjooI7nn0-ePTGg,4732
 bosdyn/bddf/data_writer.py,sha256=c1576ZZ0XsCf0mhnZOuu41jUYSMK2xtDxD_j8rzanss,6464
-bosdyn/bddf/file_indexer.py,sha256=-Pph70DR9ZlmTt3E-TfkJ5OlC71NiHyu91Skzb3ZDHo,8437
+bosdyn/bddf/file_indexer.py,sha256=NE-rxVHM_ILz_O48LBfxk24OId1I5HraZK-hW6UK7BM,8435
 bosdyn/bddf/grpc_proto_reader.py,sha256=F7KXOD1IQdCsvaZA3YRiL2_mM7UCH6KRe0fs1xqG1lE,1527
 bosdyn/bddf/grpc_reader.py,sha256=XenmqrlHCdvgerGYAYNmDNw4rhYuod-nJJEafVa2XgE,3446
 bosdyn/bddf/grpc_service_reader.py,sha256=ZE8QNiL60xji5-eNTyJb8kl-k22zoRzORqcvJZszn0I,1412
@@ -20,7 +21,7 @@ bosdyn/bddf/protobuf_channel_reader.py,sha256=mf1VnVZe28CMoLLWQ0hs8HKGBeaCNYTAaV
 bosdyn/bddf/protobuf_reader.py,sha256=nHY5hTJ7HVAvLmKu0jtkEvkxLuo5LX5nNH7T0ZTaZcE,1356
 bosdyn/bddf/protobuf_series_writer.py,sha256=TnbBHwG-xxPnOLAbKqsC0ea_ULd-BW-FJylnyTg9J5Q,2361
 bosdyn/bddf/stream_data_reader.py,sha256=RC_5wf_xfFMtvTeYXy0oaUbNup06uHc76SRwYYAMis8,4374
-bosdyn_core-3.3.2.dist-info/METADATA,sha256=5BVGOsFZ540HY4ZkEH6wLaHrU-w8XJzld_0OH7SBxWE,1704
-bosdyn_core-3.3.2.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-bosdyn_core-3.3.2.dist-info/top_level.txt,sha256=an2OWgx1ej2jFjmBjPWNQ68ZglvUfKhmXWW-WhTtDmA,7
-bosdyn_core-3.3.2.dist-info/RECORD,,
+bosdyn_core-4.0.1.dist-info/METADATA,sha256=E1DGBXEPJrE2mpDiC4Iu-N0G2D-3w6azqrxMQqdugrA,1704
+bosdyn_core-4.0.1.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
+bosdyn_core-4.0.1.dist-info/top_level.txt,sha256=an2OWgx1ej2jFjmBjPWNQ68ZglvUfKhmXWW-WhTtDmA,7
+bosdyn_core-4.0.1.dist-info/RECORD,,

{bosdyn_core-3.3.2.dist-info → bosdyn_core-4.0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: bdist_wheel (0.41.0)
 Root-Is-Purelib: true
 Tag: py3-none-any