labbench.paramattr.property

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

Bases: Property, NetworkAddress

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

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.Path(*args, **kws)

Bases: Property, Path

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
inherit: bool
key: Any

when set, this defines the property 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
only: tuple
sets: bool
class labbench.paramattr.property.any(*args, **kws)

Bases: Property, Any

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.bool(*args, **kws)

Bases: Property, Bool

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.bytes(*args, **kws)

Bases: Property, Bytes

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

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.complex(*args, **kws)

Bases: Property, Complex

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.dict(*args, **kws)

Bases: Property, Dict

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.float(*args, **kws)

Bases: Property, Float

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
index_lookup_attr
inherit: bool
key: Any

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

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.property.int(*args, **kws)

Bases: Property, Int

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
index_lookup_attr
inherit: bool
key: Any

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

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

Bases: Property, List

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.str(*args, **kws)

Bases: Property, Unicode

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

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool
class labbench.paramattr.property.tuple(*args, **kws)

Bases: Property, Tuple

ROLE
allow_none: bool
cache: bool
get_on_set: bool

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

gets: bool
help: str
inherit: bool
key: Any

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

label: str
log: bool
name
only: tuple
sets: bool