Add --label option to dwave ping/sample (with a default)

Close #481.

Author: randomir

dwave/cloud/cli.py

@@ -441,11 +441,13 @@ def flush():
               help='Connection and read timeouts (in seconds) for all API requests')
 @click.option('--polling-timeout', default=None, type=float,
               help='Problem polling timeout in seconds (time-to-solution timeout)')
+@click.option('--label', default='dwave ping', type=str, help='Problem label')
 @click.option('--json', 'json_output', default=False, is_flag=True,
               help='JSON output')
 @standardized_output
 def ping(*, config_file, profile, endpoint, region, client_type, solver_def,
-         sampling_params, json_output, request_timeout, polling_timeout, output):
+         sampling_params, request_timeout, polling_timeout, label, json_output,
+         output):
     """Ping the QPU by submitting a single-qubit problem."""
 
     # parse params (TODO: move to click validator)
@@ -458,6 +460,9 @@ def ping(*, config_file, profile, endpoint, region, client_type, solver_def,
             raise CLIError("sampling parameters required as JSON-encoded "
                            "map of param names to values", code=99)
 
+    if label:
+        params.update(label=label)
+
     config = dict(
         config_file=config_file, profile=profile,
         endpoint=endpoint, region=region,
@@ -555,6 +560,7 @@ def solvers(config_file, profile, endpoint, region, client_type, solver_def,
               help='Submit a valid random problem using all qubits')
 @click.option('--num-reads', '-n', default=None, type=int,
               help='Number of reads/samples')
+@click.option('--label', default='dwave sample', type=str, help='Problem label')
 @click.option('--sampling-params', '-m', default=None,
               help='Sampling parameters, JSON encoded')
 @click.option('--verbose', '-v', default=False, is_flag=True,
@@ -563,7 +569,7 @@ def solvers(config_file, profile, endpoint, region, client_type, solver_def,
               help='JSON output')
 @standardized_output
 def sample(*, config_file, profile, endpoint, region, client_type, solver_def,
-           biases, couplings, random_problem, num_reads, sampling_params,
+           biases, couplings, random_problem, num_reads, label, sampling_params,
            verbose, json_output, output):
     """Submit Ising-formulated problem and return samples."""
 
@@ -583,6 +589,9 @@ def sample(*, config_file, profile, endpoint, region, client_type, solver_def,
     if num_reads is not None:
         params.update(num_reads=num_reads)
 
+    if label:
+        params.update(label=label)
+
     # TODO: add other params, like timeout?
     config = dict(
         config_file=config_file, profile=profile,

releasenotes/notes/cli-tweaks-687abaa266fe3a72.yaml

@@ -5,6 +5,9 @@ features:
   - |
     Add ``--sampling-params`` option to ``dwave sample``. ``--num-reads`` has
     been kept, and it now overwrites value given in sampling params.
+  - |
+    Add ``--label`` option to ``dwave ping`` and ``dwave sample``, with a
+    default value set. See `#481 <https://github.com/dwavesystems/dwave-cloud-client/issues/481>`_.
 fixes:
   - |
     Improved error and output handling in ``dwave sample``.

tests/test_cli.py

@@ -247,6 +247,7 @@ def test_ping(self, config_file_option):
         profile = 'profile'
         client_type = 'qpu'
         params = dict(num_reads=10)
+        label = 'label'
 
         with mock.patch('dwave.cloud.cli.Client') as m:
             # mock returned solver
@@ -262,7 +263,8 @@ def test_ping(self, config_file_option):
                                              '--client', client_type,
                                              '--sampling-params', json.dumps(params),
                                              '--request-timeout', '.5',
-                                             '--polling-timeout', '30'])
+                                             '--polling-timeout', '30',
+                                             '--label', label])
 
             # proper arguments passed to Client.from_config?
             m.from_config.assert_called_with(
@@ -276,7 +278,8 @@ def test_ping(self, config_file_option):
 
             # sampling method called on solver with correct params?
             solver = client.get_solver.return_value
-            solver.sample_ising.assert_called_with({3: 0}, {}, **params)
+            solver.sample_ising.assert_called_with(
+                {3: 0}, {}, label=label, **params)
 
         self.assertEqual(result.exit_code, 0)
 
@@ -293,6 +296,7 @@ def test_sample(self, config_file_option):
         biases = '[0]'
         couplings = '{(0, 4): 1}'
         num_reads = '10'
+        label = 'label'
 
         with mock.patch('dwave.cloud.cli.Client') as m:
 
@@ -304,6 +308,7 @@ def test_sample(self, config_file_option):
                                              '--profile', profile,
                                              '--client', client,
                                              '--solver', solver,
+                                             '--label', label,
                                              '-h', biases,
                                              '-j', couplings,
                                              '-n', num_reads])
@@ -320,7 +325,8 @@ def test_sample(self, config_file_option):
 
             # sampling method called on solver?
             s = c.get_solver.return_value
-            s.sample_ising.assert_called_with({0: 0}, {(0, 4): 1}, num_reads=10)
+            s.sample_ising.assert_called_with(
+                {0: 0}, {(0, 4): 1}, num_reads=10, label=label)
 
         self.assertEqual(result.exit_code, 0)