mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-15 22:13:00 +00:00
9eb30f6ff6
- Allows us to standardize this on the spawner base class, so there's a consistent interface for different spawners to implement this. - Specify the supported suffixes and various units we accept for memory and cpu units. - Standardize the way we expose resource limit / guarantees to single-user servers
68 lines
2.0 KiB
Python
68 lines
2.0 KiB
Python
"""
|
|
Traitlets that are used in JupyterHub
|
|
"""
|
|
# Copyright (c) Jupyter Development Team.
|
|
# Distributed under the terms of the Modified BSD License.
|
|
|
|
from traitlets import List, Unicode, Integer, TraitError
|
|
|
|
class URLPrefix(Unicode):
|
|
def validate(self, obj, value):
|
|
u = super().validate(obj, value)
|
|
if not u.startswith('/'):
|
|
u = '/' + u
|
|
if not u.endswith('/'):
|
|
u = u + '/'
|
|
return u
|
|
|
|
class Command(List):
|
|
"""Traitlet for a command that should be a list of strings,
|
|
but allows it to be specified as a single string.
|
|
"""
|
|
def __init__(self, default_value=None, **kwargs):
|
|
kwargs.setdefault('minlen', 1)
|
|
if isinstance(default_value, str):
|
|
default_value = [default_value]
|
|
super().__init__(Unicode(), default_value, **kwargs)
|
|
|
|
def validate(self, obj, value):
|
|
if isinstance(value, str):
|
|
value = [value]
|
|
return super().validate(obj, value)
|
|
|
|
|
|
class MemorySpecification(Integer):
|
|
"""
|
|
Allow easily specifying memory in units of 1024 with suffixes
|
|
|
|
Suffixes allowed are:
|
|
- K -> Kilobyte
|
|
- M -> Megabyte
|
|
- G -> Gigabyte
|
|
- T -> Terabyte
|
|
"""
|
|
|
|
UNIT_SUFFIXES = {
|
|
'K': 1024,
|
|
'M': 1024 * 1024,
|
|
'G': 1024 * 1024 * 1024,
|
|
'T': 1024 * 1024 * 1024 * 1024
|
|
}
|
|
|
|
def validate(self, obj, value):
|
|
"""
|
|
Validate that the passed in value is a valid memory specification
|
|
|
|
It could either be a pure int, when it is taken as a byte value.
|
|
If it has one of the suffixes, it is converted into the appropriate
|
|
pure byte value.
|
|
"""
|
|
if isinstance(value, int):
|
|
return value
|
|
num = value[:-1]
|
|
suffix = value[-1]
|
|
if not num.isdigit() and suffix not in MemorySpecification.UNIT_SUFFIXES:
|
|
raise TraitError('{val} is not a valid memory specification. Must be an int or a string with suffix K, M, G, T'.format(val=value))
|
|
else:
|
|
return int(num) * MemorySpecification.UNIT_SUFFIXES[suffix]
|