labbench.paramattr.value

class labbench.paramattr.value.NetworkAddress(*args, **kws)

Bases: Value, NetworkAddress

defines a value attribute that casts to a network address

ROLE
accept_port: bool
allow_none: bool | None
cache: bool
case: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.Path(*args, **kws)

Bases: Value, Path

defines a value attribute that casts to python pathlib.Path

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
must_exist: bool

does the path need to exist when set?

name
only: tuple
sets: bool
class labbench.paramattr.value.any(*args, **kws)

Bases: Value, Any

defines a value attribute that validates any python object

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.bool(*args, **kws)

Bases: Value, Bool

defines a value attribute that casts to python builtin bool

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.bytes(*args, **kws)

Bases: Value, Bytes

defines a value attribute that casts to python builtin bytes

ROLE
allow_none: bool | None
cache: bool
case: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.complex(*args, **kws)

Bases: Value, Complex

defines a value attribute that casts to python complex

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.dict(*args, **kws)

Bases: Value, Dict

defines a value attribute that casts to python builtin dict

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.float(*args, **kws)

Bases: Value, Float

defines a value attribute that casts to python builtin float

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
index_lookup_attr
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
max: T | None
min: T | None
name
only: tuple
path_attr
sets: bool
step: float | None
table_index_column
class labbench.paramattr.value.int(*args, **kws)

Bases: Value, Int

defines a value attribute that casts to python builtin int

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
index_lookup_attr
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
max: T | None
min: T | None
name
only: tuple
path_attr
sets: bool
table_index_column
class labbench.paramattr.value.list(*args, **kws)

Bases: Value, List

defines a value attribute that casts to python builtin list

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.str(*args, **kws)

Bases: Value, Unicode

defines a value attribute that casts to python builtin str

ROLE
allow_none: bool | None
cache: bool
case: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.value.tuple(*args, **kws)

Bases: Value, Tuple

defines a value attribute that casts to python builtin tuple

ROLE
allow_none: bool | None
cache: bool
default: T
gets: bool
help: str
inherit: bool
key: Any
kw_only: bool
label: str
log: bool
name
only: tuple
sets: bool