Rename "context" to "service_context"

benhoyt · Jul 11, 2023 · 273330e · 273330e
1 parent c38729e
commit 273330e
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/ops/model.py b/ops/model.py
@@ -2366,7 +2366,7 @@ def exec(  # noqa
         self,
         command: List[str],
         *,
-        context: Optional[str] = None,
+        service_context: Optional[str] = None,
         environment: Optional[Dict[str, str]] = None,
         working_dir: Optional[str] = None,
         timeout: Optional[float] = None,
@@ -2388,7 +2388,7 @@ def exec(  # noqa
         self,
         command: List[str],
         *,
-        context: Optional[str] = None,
+        service_context: Optional[str] = None,
         environment: Optional[Dict[str, str]] = None,
         working_dir: Optional[str] = None,
         timeout: Optional[float] = None,
@@ -2408,7 +2408,7 @@ def exec(
         self,
         command: List[str],
         *,
-        context: Optional[str] = None,
+        service_context: Optional[str] = None,
         environment: Optional[Dict[str, str]] = None,
         working_dir: Optional[str] = None,
         timeout: Optional[float] = None,
@@ -2429,7 +2429,7 @@ def exec(
         """
         return self._pebble.exec(
             command,
-            context=context,
+            service_context=service_context,
             environment=environment,
             working_dir=working_dir,
             timeout=timeout,

diff --git a/ops/pebble.py b/ops/pebble.py
@@ -99,7 +99,7 @@
                            total=False)
 ExecDict = typing.TypedDict('ExecDict',
                             {'command': str,
-                             'context': str,
+                             'service-context': str,
                              'environment': Dict[str, str],
                              'user-id': Optional[int],
                              'user': str,
@@ -2154,7 +2154,7 @@ def exec(  # noqa
         self,
         command: List[str],
         *,
-        context: Optional[str] = None,
+        service_context: Optional[str] = None,
         environment: Optional[Dict[str, str]] = None,
         working_dir: Optional[str] = None,
         timeout: Optional[float] = None,
@@ -2176,7 +2176,7 @@ def exec(  # noqa
         self,
         command: List[str],
         *,
-        context: Optional[str] = None,
+        service_context: Optional[str] = None,
         environment: Optional[Dict[str, str]] = None,
         working_dir: Optional[str] = None,
         timeout: Optional[float] = None,
@@ -2196,7 +2196,7 @@ def exec(
         self,
         command: List[str],
         *,
-        context: Optional[str] = None,
+        service_context: Optional[str] = None,
         environment: Optional[Dict[str, str]] = None,
         working_dir: Optional[str] = None,
         timeout: Optional[float] = None,
@@ -2281,8 +2281,8 @@ def exec(
         Args:
             command: Command to execute: the first item is the name (or path)
                 of the executable, the rest of the items are the arguments.
-            context: If specified, run the command in the context of this
-                service. Specifically, inherit its environment variables,
+            service_context: If specified, run the command in the context of
+                this service. Specifically, inherit its environment variables,
                 user/group settings, and working directory. The other exec
                 options will override the service context; ``environment``
                 will be merged on top of the service's.
@@ -2351,7 +2351,7 @@ def exec(
 
         body = {
             'command': command,
-            'context': context,
+            'service-context': service_context,
             'environment': environment or {},
             'working-dir': working_dir,
             'timeout': _format_timeout(timeout) if timeout is not None else None,

diff --git a/test/pebble_cli.py b/test/pebble_cli.py
@@ -197,7 +197,7 @@ def main():
 
             process = client.exec(
                 args.exec_command,
-                context=args.context,
+                service_context=args.context,
                 environment=environment,
                 working_dir=args.working_dir,
                 timeout=args.timeout,

diff --git a/test/test_model.py b/test/test_model.py
@@ -1781,7 +1781,7 @@ def test_exec(self):
         self.pebble.responses.append('fake_exec_process')
         p = self.container.exec(
             ['echo', 'foo'],
-            context='srv1',
+            service_context='srv1',
             environment={'K1': 'V1', 'K2': 'V2'},
             working_dir='WD',
             timeout=10.5,
@@ -1797,7 +1797,7 @@ def test_exec(self):
         )
         self.assertEqual(self.pebble.requests, [
             ('exec', ['echo', 'foo'], dict(
-                context='srv1',
+                service_context='srv1',
                 environment={'K1': 'V1', 'K2': 'V2'},
                 working_dir='WD',
                 timeout=10.5,

diff --git a/test/test_pebble.py b/test/test_pebble.py
@@ -2642,11 +2642,11 @@ def add_responses(self, change_id, exit_code, change_err=None):
         return (stdio, stderr, control)
 
     def build_exec_data(
-            self, command, context=None, environment=None, working_dir=None, timeout=None,
+            self, command, service_context=None, environment=None, working_dir=None, timeout=None,
             user_id=None, user=None, group_id=None, group=None, combine_stderr=False):
         return {
             'command': command,
-            'context': context,
+            'service-context': service_context,
             'environment': environment or {},
             'working-dir': working_dir,
             'timeout': f'{timeout:.3f}s' if timeout is not None else None,