mirrors/granian
1
0
Fork 0
mirror of https://github.com/emmett-framework/granian.git synced 2025-08-04 17:08:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make Duration inherit from IntRange instead of ParamType

Browse source
This commit is contained in:
Reda Bouaida 2025-07-06 18:35:05 +02:00
parent b606e9f93c
commit 8f117120b9
3 changed files with 23 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -151,10 +151,10 @@ Options:
--blocking-threads INTEGER RANGE
Number of blocking threads (per worker)
[env var: GRANIAN_BLOCKING_THREADS; x>=1]
--blocking-threads-idle-timeout INTEGER RANGE
The maximum amount of time in seconds an
idle blocking thread will be kept alive
[env var:
--blocking-threads-idle-timeout DURATION
The maximum amount of time in seconds (or a
human-readable duration) an idle blocking
thread will be kept alive [env var:
GRANIAN_BLOCKING_THREADS_IDLE_TIMEOUT;
default: 30; 10<=x<=600]
--runtime-threads INTEGER RANGE
@ -221,8 +221,9 @@ Options:
connection alive [env var:
GRANIAN_HTTP2_KEEP_ALIVE_INTERVAL;
1<=x<=60000]
--http2-keep-alive-timeout INTEGER RANGE
Sets a timeout (in seconds) for receiving an
--http2-keep-alive-timeout DURATION
Sets a timeout (in seconds or a human-
readable duration) for receiving an
acknowledgement of the HTTP2 keep-alive ping
[env var: GRANIAN_HTTP2_KEEP_ALIVE_TIMEOUT;
default: 20; x>=1]
@ -280,13 +281,13 @@ Options:
--workers-lifetime DURATION The maximum amount of time in seconds (or a
human-readable duration) a worker will be
kept alive before respawn [env var:
GRANIAN_WORKERS_LIFETIME]
GRANIAN_WORKERS_LIFETIME; x>=60]
--workers-kill-timeout DURATION
The amount of time in seconds (or a human-
readable duration) to wait for killing
workers that refused to gracefully stop
[env var: GRANIAN_WORKERS_KILL_TIMEOUT;
default: (disabled)]
default: (disabled); 1<=x<=1800]
--factory / --no-factory Treat target as a factory function, that
should be invoked to build the actual target
[env var: GRANIAN_FACTORY; default:
@ -304,7 +305,8 @@ Options:
--static-path-expires DURATION Cache headers expiration (in seconds or a
human-readable duration) for static file
serving [env var:
GRANIAN_STATIC_PATH_EXPIRES; default: 86400]
GRANIAN_STATIC_PATH_EXPIRES; default: 86400;
x>=60]
--reload / --no-reload Enable auto reload on application's files
changes (requires granian[reload] extra)
[env var: GRANIAN_RELOAD; default:

23
granian/cli.py
View file

@ -17,7 +17,7 @@ _AnyCallable = Callable[..., Any]
FC = TypeVar('FC', bound=Union[_AnyCallable, click.Command])
class Duration(click.ParamType):
class Duration(click.IntRange):
"""Custom parameter type for duration strings like '24h', '6m', '2s', '1h30m', etc.
If the value is a plain number, it will be treated as seconds.
@ -27,9 +27,8 @@ class Duration(click.ParamType):
_multipliers = {'s': 1, 'm': 60, 'h': 60 * 60, 'd': 60 * 60 * 24}
_pattern = re.compile(r'^(?:(?P<d>\d+)d)?(?:(?P<h>\d+)h)?(?:(?P<m>\d+)m)?(?:(?P<s>\d+)s)?$')
def __init__(self, min_seconds: Optional[int] = None, max_seconds: Optional[int] = None) -> None:
self.min_seconds = min_seconds
self.max_seconds = max_seconds
def __init__(self, min: Optional[int] = None, max: Optional[int] = None) -> None:
super().__init__(min, max, min_open=False, max_open=False, clamp=False)
def convert(self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]) -> Any:
if value is None:
@ -52,11 +51,11 @@ class Duration(click.ParamType):
else:
self.fail(f'{value!r} is not a valid duration', param, ctx)
if self.min_seconds is not None and seconds < self.min_seconds:
self.fail(f'{value!r} is less than the minimum allowed value of {self.min_seconds} seconds', param, ctx)
if self.min is not None and seconds < self.min:
self.fail(f'{value!r} is less than the minimum allowed value of {self.min} seconds', param, ctx)
if self.max_seconds is not None and seconds > self.max_seconds:
self.fail(f'{value!r} is greater than the maximum allowed value of {self.max_seconds} seconds', param, ctx)
if self.max is not None and seconds > self.max:
self.fail(f'{value!r} is greater than the maximum allowed value of {self.max} seconds', param, ctx)
return seconds
@ -116,9 +115,9 @@ def option(*param_decls: str, cls: Optional[Type[click.Option]] = None, **attrs:
)
@option(
'--blocking-threads-idle-timeout',
type=click.IntRange(10, 600),
type=Duration(10, 600),
default=30,
help='The maximum amount of time in seconds an idle blocking thread will be kept alive',
help='The maximum amount of time in seconds (or a human-readable duration) an idle blocking thread will be kept alive',
)
@option('--runtime-threads', type=click.IntRange(1), default=1, help='Number of runtime threads (per worker)')
@option(
@ -198,9 +197,9 @@ def option(*param_decls: str, cls: Optional[Type[click.Option]] = None, **attrs:
)
@option(
'--http2-keep-alive-timeout',
type=click.IntRange(1),
type=Duration(1),
default=HTTP2Settings.keep_alive_timeout,
help='Sets a timeout (in seconds) for receiving an acknowledgement of the HTTP2 keep-alive ping',
help='Sets a timeout (in seconds or a human-readable duration) for receiving an acknowledgement of the HTTP2 keep-alive ping',
)
@option(
'--http2-max-concurrent-streams',

2
tests/test_cli.py
View file

@ -44,6 +44,6 @@ def test_duration_convert_invalid(value: str, error_message: str) -> None:
),
)
def test_duration_convert_out_of_range(value: str, error_message: str) -> None:
duration_type = Duration(min_seconds=10, max_seconds=100)
duration_type = Duration(10, 100)
with pytest.raises(click.BadParameter, match=error_message):
duration_type.convert(value, None, None)