labbench.paramattr.method

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

Bases: Method[Any], NetworkAddress, Generic[P]

ROLE
accept_port: bool
allow_none: bool
cache: bool
case: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.Path(*args, **kws)

Bases: Method[Path], Path

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
must_exist: bool

does the path need to exist when set?

name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.any(*args, **kws)

Bases: Method[Any], Any

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.bool(*args, **kws)

Bases: Method[bool], Bool

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.bytes(*args, **kws)

Bases: Method[bytes], Bytes

ROLE
allow_none: bool
cache: bool
case: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.complex(*args, **kws)

Bases: Method[complex], Complex

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.dict(*args, **kws)

Bases: Method[dict], Dict

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.float(*args, **kws)

Bases: Method[float], Float

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
index_lookup_attr
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
max: V | None
min: V | None
name: str | None
only: Sequence
path_attr
sets: bool
step: float | None
table_index_column
class labbench.paramattr.method.int(*args, **kws)

Bases: Method[int], Int

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
index_lookup_attr
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
max: V | None
min: V | None
name: str | None
only: Sequence
path_attr
sets: bool
table_index_column
class labbench.paramattr.method.list(*args, **kws)

Bases: Method[list], List

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.str(*args, **kws)

Bases: Method[str], Unicode

ROLE
allow_none: bool
cache: bool
case: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool
class labbench.paramattr.method.tuple(*args, **kws)

Bases: Method[list], Tuple

ROLE
allow_none: bool
cache: bool
get_on_set: bool

if True, a property get follows immediately to log the “accepted” property value

gets: bool
help: str
inherit: bool
key: str | None

when set, this defines the method implementation based on a key adapter in the owner

label: str
log: bool
name: str | None
only: Sequence
sets: bool