Skip to content

Commit a5da91d

Browse files
committed
Change on_*_create to configure_*
1 parent e1dfe5c commit a5da91d

File tree

3 files changed

+20
-19
lines changed

3 files changed

+20
-19
lines changed

temporalio/client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ async def connect(
189189
)
190190

191191
root_plugin: Plugin = _RootPlugin()
192-
for plugin in reversed(list(plugins)):
192+
for plugin in reversed(plugins):
193193
root_plugin = plugin.init_client_plugin(root_plugin)
194194

195195
service_client = await root_plugin.connect_service_client(connect_config)
@@ -233,10 +233,10 @@ def __init__(
233233
)
234234

235235
root_plugin: Plugin = _RootPlugin()
236-
for plugin in reversed(list(plugins)):
236+
for plugin in reversed(plugins):
237237
root_plugin = plugin.init_client_plugin(root_plugin)
238238

239-
self._init_from_config(root_plugin.on_create_client(config))
239+
self._init_from_config(root_plugin.configure_client(config))
240240

241241
def _init_from_config(self, config: ClientConfig):
242242
self._config = config
@@ -7433,7 +7433,7 @@ def init_client_plugin(self, next: Plugin) -> Plugin:
74337433
self.next_client_plugin = next
74347434
return self
74357435

7436-
def on_create_client(self, config: ClientConfig) -> ClientConfig:
7436+
def configure_client(self, config: ClientConfig) -> ClientConfig:
74377437
"""Hook called when creating a client to allow modification of configuration.
74387438
74397439
This method is called during client creation and allows plugins to modify
@@ -7446,7 +7446,7 @@ def on_create_client(self, config: ClientConfig) -> ClientConfig:
74467446
Returns:
74477447
The modified client configuration.
74487448
"""
7449-
return self.next_client_plugin.on_create_client(config)
7449+
return self.next_client_plugin.configure_client(config)
74507450

74517451
async def connect_service_client(
74527452
self, config: temporalio.service.ConnectConfig
@@ -7467,7 +7467,7 @@ async def connect_service_client(
74677467

74687468

74697469
class _RootPlugin(Plugin):
7470-
def on_create_client(self, config: ClientConfig) -> ClientConfig:
7470+
def configure_client(self, config: ClientConfig) -> ClientConfig:
74717471
return config
74727472

74737473
async def connect_service_client(

temporalio/worker/_worker.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def init_worker_plugin(self, next: Plugin) -> Plugin:
128128
self.next_worker_plugin = next
129129
return self
130130

131-
def on_create_worker(self, config: WorkerConfig) -> WorkerConfig:
131+
def configure_worker(self, config: WorkerConfig) -> WorkerConfig:
132132
"""Hook called when creating a worker to allow modification of configuration.
133133
134134
This method is called during worker creation and allows plugins to modify
@@ -142,7 +142,7 @@ def on_create_worker(self, config: WorkerConfig) -> WorkerConfig:
142142
Returns:
143143
The modified worker configuration.
144144
"""
145-
return self.next_worker_plugin.on_create_worker(config)
145+
return self.next_worker_plugin.configure_worker(config)
146146

147147
async def run_worker(self, worker: Worker) -> None:
148148
"""Hook called when running a worker to allow interception of execution.
@@ -158,7 +158,7 @@ async def run_worker(self, worker: Worker) -> None:
158158

159159

160160
class _RootPlugin(Plugin):
161-
def on_create_worker(self, config: WorkerConfig) -> WorkerConfig:
161+
def configure_worker(self, config: WorkerConfig) -> WorkerConfig:
162162
return config
163163

164164
async def run_worker(self, worker: Worker) -> None:
@@ -449,9 +449,9 @@ def __init__(
449449
plugins = plugins_from_client + list(plugins)
450450

451451
root_plugin: Plugin = _RootPlugin()
452-
for plugin in reversed(list(plugins)):
452+
for plugin in reversed(plugins):
453453
root_plugin = plugin.init_worker_plugin(root_plugin)
454-
config = root_plugin.on_create_worker(config)
454+
config = root_plugin.configure_worker(config)
455455
self._plugin = root_plugin
456456

457457
self._init_from_config(config)

tests/test_plugins.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,31 @@
44

55
import temporalio.client
66
import temporalio.worker
7-
from temporalio.client import Client, ClientConfig, OutboundInterceptor, Plugin
7+
from temporalio.client import Client, ClientConfig, OutboundInterceptor
88
from temporalio.testing import WorkflowEnvironment
99
from temporalio.worker import Worker, WorkerConfig
1010
from tests.worker.test_worker import never_run_activity
1111

1212

1313
class TestClientInterceptor(temporalio.client.Interceptor):
14+
__test__ = False
1415
intercepted = False
1516

1617
def intercept_client(self, next: OutboundInterceptor) -> OutboundInterceptor:
1718
self.intercepted = True
1819
return super().intercept_client(next)
1920

2021

21-
class MyClientPlugin(Plugin):
22+
class MyClientPlugin(temporalio.client.Plugin):
2223
def __init__(self):
2324
self.interceptor = TestClientInterceptor()
2425

25-
def on_create_client(self, config: ClientConfig) -> ClientConfig:
26+
def configure_client(self, config: ClientConfig) -> ClientConfig:
2627
config["namespace"] = "replaced_namespace"
2728
config["interceptors"] = list(config.get("interceptors") or []) + [
2829
self.interceptor
2930
]
30-
return super().on_create_client(config)
31+
return super().configure_client(config)
3132

3233
async def connect_service_client(
3334
self, config: temporalio.service.ConnectConfig
@@ -55,15 +56,15 @@ async def test_client_plugin(client: Client, env: WorkflowEnvironment):
5556

5657

5758
class MyCombinedPlugin(temporalio.client.Plugin, temporalio.worker.Plugin):
58-
def on_create_worker(self, config: WorkerConfig) -> WorkerConfig:
59+
def configure_worker(self, config: WorkerConfig) -> WorkerConfig:
5960
config["task_queue"] = "combined"
60-
return super().on_create_worker(config)
61+
return super().configure_worker(config)
6162

6263

6364
class MyWorkerPlugin(temporalio.worker.Plugin):
64-
def on_create_worker(self, config: WorkerConfig) -> WorkerConfig:
65+
def configure_worker(self, config: WorkerConfig) -> WorkerConfig:
6566
config["task_queue"] = "replaced_queue"
66-
return super().on_create_worker(config)
67+
return super().configure_worker(config)
6768

6869
async def run_worker(self, worker: Worker) -> None:
6970
await super().run_worker(worker)

0 commit comments

Comments
 (0)