bosdyn-orbit 4.1.1__py3-none-any.whl → 5.0.1__py3-none-any.whl

bosdyn/orbit/client.py

@@ -6,6 +6,7 @@
 
 """ The client uses a web API to send HTTPs requests to a number of REStful endpoints using the Requests library.
 """
+import warnings
 from typing import Dict, Iterable
 
 import requests
@@ -231,7 +232,7 @@ class Client():
             Returns:
                 requests.Response: the response associated with the get request
         """
-        return self.get_resource(f"site_walks/archive", params={"uuids": uuid}, **kwargs)
+        return self.get_resource("site_walks/archive", params={"uuids": uuid}, **kwargs)
 
     def get_site_elements(self, **kwargs) -> requests.Response:
         """ Returns site elements on the specified instance.
@@ -381,6 +382,17 @@ class Client():
         """
         return self.get_resource(f'runs/{uuid}', **kwargs)
 
+    def get_run_log(self, uuid: str, **kwargs) -> requests.Response:
+        """ Retrieves the log of a run.
+
+            Args:
+                uuid: the ID of the run.
+                kwargs(**): a variable number of keyword arguments for the get request.
+            Returns:
+                requests.Response: the response associated with the get request.
+        """
+        return self.get_resource(f'runs/{uuid}/log', **kwargs)
+
     def get_run_archives_by_id(self, uuid: str, **kwargs) -> requests.Response:
         """ Given a runUuid, returns run archives.
 
@@ -472,6 +484,67 @@ class Client():
         """
         return self.get_resource(f'robot-session/{robot_nickname}/session', **kwargs)
 
+    def get_anomalies(self, **kwargs) -> requests.Response:
+        """ Given a dictionary of query params, returns anomalies.
+
+            Args:
+                kwargs(**): a variable number of keyword arguments for the get request.
+            Raises:
+                RequestExceptions: exceptions thrown by the Requests library.
+                UnauthenticatedClientError:  indicates that the client is not authenticated properly.
+            Returns:
+                requests.Response: the response associated with the get request.
+        """
+        return self.get_resource("anomalies", **kwargs)
+
+    def get_backup(self, task_id: str, **kwargs):
+        """ Retrieves a *.zip containing an Orbit backup.
+
+            Args:
+                task_id: the task ID returned from the post_backup_task method.
+                kwargs(**): a variable number of keyword arguments for the get request.
+            Raises:
+                RequestExceptions: exceptions thrown by the Requests library.
+                UnauthenticatedClientError:  indicates that the client is not authenticated properly.
+            Returns:
+                requests.Response: the response associated with the get request.
+        """
+        return self.get_resource(f'backups/{task_id}', headers=OCTET_HEADER, **kwargs)
+
+    def get_backup_task(self, task_id: str, **kwargs):
+        """ Retrieves the status of a backup task started by the post_backup_task method.
+
+            Args:
+                task_id: the task ID returned from the post_backup_task method.
+                kwargs(**): a variable number of keyword arguments for the get request.
+            Raises:
+                RequestExceptions: exceptions thrown by the Requests library.
+                UnauthenticatedClientError:  indicates that the client is not authenticated properly.
+            Returns:
+                requests.Response: the response associated with the get request.
+        """
+        return self.get_resource(f'backup_tasks/{task_id}', **kwargs)
+
+    def get_run_statistics(self, **kwargs) -> requests.Response:
+        """ Retrieves session statistics.
+
+            Args:
+                kwargs(**): a variable number of keyword arguments for the get request.
+            Returns:
+                requests.Response: the response associated with the get request.
+        """
+        return self.get_resource("run_statistics/sessions", **kwargs)
+
+    def get_run_statistics_session_summary(self, **kwargs) -> requests.Response:
+        """ Retrieves session summary.
+
+            Args:
+                kwargs(**): a variable number of keyword arguments for the get request.
+            Returns:
+                requests.Response: the response associated with the get request.
+        """
+        return self.get_resource("run_statistics/sessions_summary", **kwargs)
+
     def post_export_as_walk(self, site_walk_uuid: str, **kwargs) -> requests.Response:
         """ Given a SiteWalk uuid, it exports the walks_pb2.Walk equivalent.
 
@@ -484,7 +557,7 @@ class Client():
             Returns:
                 requests.Response: The response associated with the post request.
         """
-        return self.post_resource(f'site_walks/export_as_walk',
+        return self.post_resource('site_walks/export_as_walk',
                                   json={"siteWalkUuid": site_walk_uuid}, **kwargs)
 
     def post_import_from_walk(self, **kwargs) -> requests.Response:
@@ -720,26 +793,51 @@ class Client():
             "siteDockUuid": site_dock_uuid
         }, **kwargs)
 
-    def post_dispatch_mission_to_robot(self, robot_nickname: str, driver_id: str, mission_uuid: str,
-                                       delete_mission: bool, force_acquire_estop: bool,
-                                       skip_initialization: bool, **kwargs) -> requests.Response:
+    def post_dispatch_mission_to_robot(self, robot_nickname: str, driver_id: str,
+                                       mission_uuid: str = None, delete_mission: bool = False,
+                                       force_acquire_estop: bool = False,
+                                       skip_initialization: bool = True, walk=None,
+                                       **kwargs) -> requests.Response:
         """ Dispatch the robot to a mission given a mission uuid.
 
             Args:
                 robot_nickname: the nickname of the robot.
                 driver_id: the current driver ID of the mission.
-                mission_uuid: uuid of the mission(also known as SiteWalk) to dispatch.
-                delete_mission: whether to delete the mission after playback.
+                mission_uuid: Deprecated. Use 'walk' instead.
+                delete_mission: DEPRECATED and no longer supported. Instead, use a temporary walk file that will not be reused.
                 force_acquire_estop: whether to force acquire E-stop from the previous client.
                 skip_initialization: whether to skip initialization when starting the return to dock mission.
+                walk: the walk to dispatch the robot to. If this is set, mission_uuid should be None.
                 kwargs(**): a variable number of keyword arguments for the post request.
             Raises:
+                ValueError: if neither or both of mission_uuid and walk are set.
+                AssertionError: if delete_mission is set to True.
                 RequestExceptions: exceptions thrown by the Requests library.
                 UnauthenticatedClientError:  indicates that the client is not authenticated properly.
             Returns:
                 requests.Response: The response associated with the post request.
         """
         # Payload required for dispatching a mission
+        if (mission_uuid is not None and walk is not None) or (mission_uuid is None and
+                                                               walk is None):
+            raise ValueError(
+                "Exactly one of mission_uuid or walk must be set (not both or neither).")
+
+        if delete_mission:
+            raise AssertionError(
+                "'delete_mission' is deprecated and no longer supported. "
+                "Instead, pass in a 'walk' object that only temporarily exists and will not be reused."
+            )
+
+        dispatch_target = {}
+        if mission_uuid is not None:
+            warnings.warn(
+                "'mission_uuid' is deprecated and will be removed in a future release. "
+                "Please use 'walk' instead.", DeprecationWarning, stacklevel=2)
+            dispatch_target["missionId"] = mission_uuid
+        if walk is not None:
+            dispatch_target["walk"] = walk
+
         payload = {
             "agent": {
                 "nickname": robot_nickname
@@ -757,15 +855,14 @@ class Client():
                 }
             },
             "task": {
-                "missionId": mission_uuid,
+                "dispatchTarget": dispatch_target,
                 "forceAcquireEstop": force_acquire_estop,
-                "deleteMission": delete_mission,
                 "requireDocked": False,
                 "skipInitialization": skip_initialization
             },
             "eventMetadata": {
-                "name": "API Triggered Mission"
-            }
+                "name": f"Driver Triggered Mission ({driver_id})"
+            },
         }
         return self.post_resource(
             f'calendar/mission/dispatch/{robot_nickname}?currentDriverId={driver_id}', json=payload,
@@ -789,7 +886,7 @@ class Client():
             "includeMissions": include_missions,
             "includeCaptures": include_captures,
         }
-        return self.post_resource(f'backup_tasks/', json=payload, **kwargs)
+        return self.post_resource('backup_tasks/', json=payload, **kwargs)
 
     def patch_bulk_close_anomalies(self, element_ids: list[str], **kwargs) -> requests.Response:
         """ Bulk close Anomalies by Element ID.
@@ -912,8 +1009,14 @@ def create_client(options: 'argparse.Namespace') -> 'bosdyn.orbit.client.Client'
             .format(options.verify))
         verify = options.verify
 
+    # Sanitize the format of the cert option. Requests handles None, a single pathname,
+    # or a sequence of pathnames with two or more elements.
+    cert = options.cert
+    if isinstance(cert, (list, tuple)) and len(cert) == 1:
+        cert = cert[0]
+
     # A client object represents a single instance.
-    client = Client(hostname=options.hostname, verify=verify, cert=options.cert)
+    client = Client(hostname=options.hostname, verify=verify, cert=cert)
 
     # The client needs to be authenticated before using its functions
     client.authenticate_with_api_token()

bosdyn/orbit/utils.py

@@ -36,6 +36,29 @@ def get_api_token() -> str:
     return api_token
 
 
+def add_base_arguments(parser):
+    """ Adds the most common arguments to the parser
+
+        This includes the hostname, verify, and cert arguments.
+
+        Args:
+            parser: the argument parser
+    """
+    parser.add_argument('--hostname', help='IP address associated with the Orbit instance',
+                        required=True, type=str)
+    parser.add_argument(
+        '--verify',
+        help=
+        "verify(path to a CA bundle or Boolean): controls whether we verify the server's TLS certificate",
+        default=True,
+    )
+    parser.add_argument(
+        '--cert', help=
+        "a client certificate file for authentication (a .pem file containing the certificate and "
+        "key pair, or two separate files containing the certificate and key respectively and in "
+        "that order)", nargs='+', default=None)
+
+
 def get_latest_created_at_for_run_events(client: 'bosdyn.orbit.client.Client',
                                          params: Dict = {}) -> datetime.datetime:
     """ Given a dictionary of query params, returns the max created at time for run events

{bosdyn_orbit-4.1.1.dist-info → bosdyn_orbit-5.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bosdyn-orbit
-Version: 4.1.1
+Version: 5.0.1
 Summary: Boston Dynamics API Orbit Client
 Home-page: https://dev.bostondynamics.com/docs/orbit/
 Author: Boston Dynamics

bosdyn_orbit-5.0.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+bosdyn/__init__.py,sha256=CMQioQKK1NlMk3kZuY49b_Aw-JyvDeOtuqOCAul1I0s,330
+bosdyn/orbit/__init__.py,sha256=L_VSEXjtWZNHVHs3Jdr_TF2pJ2ju2yysAi0-YZsbJoU,266
+bosdyn/orbit/client.py,sha256=GQc2J79FTjAZPsHT3yZZOHs3NoEgpw5tOcvNiPJt2fc,50308
+bosdyn/orbit/exceptions.py,sha256=eaeHSlGh27JlZUEjcpLKxR1CNdW6Twp4e685pUgEjyQ,711
+bosdyn/orbit/utils.py,sha256=n6tQFcII6JJ5aQt7lzNvXnLKM_Oc7l7VZT7gZp6CM1k,15178
+bosdyn_orbit-5.0.1.dist-info/METADATA,sha256=nyNfMzItOUnm77ZTNFkrIuaoTMwYVctnJpS-5h7fZjc,1894
+bosdyn_orbit-5.0.1.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
+bosdyn_orbit-5.0.1.dist-info/top_level.txt,sha256=an2OWgx1ej2jFjmBjPWNQ68ZglvUfKhmXWW-WhTtDmA,7
+bosdyn_orbit-5.0.1.dist-info/RECORD,,

bosdyn_orbit-4.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-bosdyn/__init__.py,sha256=CMQioQKK1NlMk3kZuY49b_Aw-JyvDeOtuqOCAul1I0s,330
-bosdyn/orbit/__init__.py,sha256=L_VSEXjtWZNHVHs3Jdr_TF2pJ2ju2yysAi0-YZsbJoU,266
-bosdyn/orbit/client.py,sha256=aoAlBKjygn2x9rXySjQzTxtWz7CcHkv6FqjMf8jhv5I,45471
-bosdyn/orbit/exceptions.py,sha256=eaeHSlGh27JlZUEjcpLKxR1CNdW6Twp4e685pUgEjyQ,711
-bosdyn/orbit/utils.py,sha256=Vhgdxa9dVjua2LteszF3rgsoKcF7Sb0c5AqsArtYRWk,14333
-bosdyn_orbit-4.1.1.dist-info/METADATA,sha256=G3qHTd_8jxL8VAuhyZFwqEMGPAbeFz37WhU62jwErlw,1894
-bosdyn_orbit-4.1.1.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
-bosdyn_orbit-4.1.1.dist-info/top_level.txt,sha256=an2OWgx1ej2jFjmBjPWNQ68ZglvUfKhmXWW-WhTtDmA,7
-bosdyn_orbit-4.1.1.dist-info/RECORD,,