Add DurationOption to store time duration values

[AlexTereshenkov]

Fixes #18698

I am not sure if this is what we need, but this is what I think what's necessary.

If I understand correctly, we want all options that declare time duration (e.g. https://www.pantsbuild.org/docs/reference-python_tests#codetimeoutcode or https://www.pantsbuild.org/docs/reference-global#remote_cache_read_timeout_millis) to use this type instead of IntOption. To unify the declaration, I suggest using a custom syntax that we publish in the docs:

1h2m3s4ms5us

with support for hours, minutes, seconds, milliseconds, and microseconds. I don't think it would be reasonable to support days (one can always use multiple hours for that anyway). Using a reg exp, a user value would be loaded into datetime.timedelta which will be used internally when passing the values to the scheduler (or any other place).

What I am not sure is how we'd like to use this type for an Option, e.g.

diff --git a/src/python/pants/option/global_options.py b/src/python/pants/option/global_options.py
index e7c4aca861..eb6e4677c9 100644
--- a/src/python/pants/option/global_options.py
+++ b/src/python/pants/option/global_options.py
@@ -1500,9 +1500,9 @@ class BootstrapOptions:
         removal_hint="Use the `remote_cache_rpc_timeout_millis` option instead.",
         help="Timeout value for remote cache lookups in milliseconds.",
     )
-    remote_cache_rpc_timeout_millis = IntOption(
+    remote_cache_rpc_timeout_millis = DurationOption(
         advanced=True,
-        default=DEFAULT_EXECUTION_OPTIONS.remote_cache_rpc_timeout_millis,
+        default=f"{DEFAULT_EXECUTION_OPTIONS.remote_cache_rpc_timeout_millis}ms",
         help="Timeout value for remote cache RPCs in milliseconds.",
     )
     remote_execution_address = StrOption(
~
~
~
~

[AlexTereshenkov]

@tdyas did you have something like this in mind?

[tdyas]

@tdyas did you have something like this in mind?

Yes seems like what I had in mind. Although I would also deprecate any option name with a time unit in its name and replace it with a new option without the time unit in the name. So remote_cache_rpc_timeout_millis would become remote_cache_rpc_timeout.