1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
|
# --------------------------------------------------------------------------------------
# Copyright (c) 2021-2025, Nucleic Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file LICENSE, distributed with this software.
# --------------------------------------------------------------------------------------
from enum import IntEnum, IntFlag
from typing import (
Any,
Callable,
Dict,
Generic,
List,
Literal,
Optional,
Sequence,
Set,
Tuple,
Type,
TypeVar,
overload,
)
from typing_extensions import Self
from .atom import Atom
from .property import Property
from .typing_utils import ChangeDict
class ChangeType(IntFlag):
CREATE = ...
UPDATE = ...
DELETE = ...
EVENT = ...
PROPERTY = ...
CONTAINER = ...
ANY = ...
def reset_property(prop: Property[Any, Any], owner: Atom) -> None: ...
class CAtom:
def __init__(self, **kwargs: Any) -> None: ...
def freeze(self) -> None: ...
def get_member(self, member: str) -> Member[Any, Any]: ...
def has_observer(
self, member: str, func: Callable[[Dict[str, Any]], None]
) -> bool: ...
def has_observers(self, member: str) -> bool: ...
def notifications_enabled(self) -> bool: ...
def notify(self, member_name: str, *args: Any, **kwargs: Any) -> None: ...
def observe(
self,
member: str,
func: Callable[[ChangeDict], None],
change_types: ChangeType = ChangeType.ANY,
) -> None: ...
def set_notifications_enabled(self, enabled: bool) -> bool: ...
def unobserve(self, member: str, func: Callable[[ChangeDict], None]) -> None: ...
def __sizeof__(self) -> int: ...
T = TypeVar("T")
S = TypeVar("S")
class Member(Generic[T, S]):
index: int = ...
metadata: Optional[Dict[str, Any]] = ...
name: str = ...
# Mode accessors
default_value_mode: Tuple[DefaultValue, Any] = ...
delattr_mode: Tuple[DelAttr, Any] = ...
getattr_mode: Tuple[GetAttr, Any] = ...
post_getattr_mode: Tuple[PostGetAttr, Any] = ...
post_setattr_mode: Tuple[PostSetAttr, Any] = ...
post_validate_mode: Tuple[PostValidate, Any] = ...
setattr_mode: Tuple[SetAttr, Any] = ...
validate_mode: Tuple[Validate, Any] = ...
getstate_mode: Tuple[GetState, Any] = ...
def __init__(self) -> None: ...
@overload
def __get__(self, instance: None, owner: Type[Atom]) -> Self: ...
@overload
def __get__(self, instance: Atom, owner: Type[Atom]) -> T: ...
def __set__(self, instance: Atom, value: S) -> None: ...
def __delete__(self, instance: Atom) -> None: ...
def tag(self, **kwargs: Any) -> Self: ...
def clone(self) -> Self: ...
def add_static_observer(
self,
observer: str | Callable[[ChangeDict], None],
change_types: ChangeType = ChangeType.ANY,
) -> Any: ...
def remove_static_observer(
self, observer: str | Callable[[ChangeDict], None]
) -> Any: ...
def static_observers(self) -> Tuple[str | Callable[[ChangeDict], None], ...]: ...
def has_observer(
self,
observer: str | Callable[[ChangeDict], None],
change_types: ChangeType = ChangeType.ANY,
) -> Any: ...
def has_observers(self, change_types: ChangeType = ChangeType.ANY) -> bool: ...
def copy_static_observers(self, other: Member[Any, Any]) -> None: ...
def notify(self, owner: CAtom, *args: Any, **kwargs: Any) -> None: ...
def get_slot(self, owner: CAtom) -> Any: ...
def set_slot(self, owner: CAtom, value: Any) -> None: ...
def del_slot(self, owner: CAtom) -> None: ...
# Manual operation of the member
def do_default_value(self, owner: CAtom) -> Any: ...
def do_delattr(self, owner: CAtom) -> None: ...
def do_full_validate(self, owner: CAtom, old: T, new: Any) -> T: ...
def do_getattr(self, owner: CAtom) -> Any: ...
def do_post_getattr(self, owner: CAtom, value: Any) -> T: ...
def do_post_setattr(self, owner: CAtom, old: T, new: T) -> None: ...
def do_post_validate(self, owner: CAtom, old: T, new: T) -> T: ...
def do_setattr(self, owner: CAtom, value: Any) -> Any: ...
def do_validate(self, owner: CAtom, old: T, new: Any) -> T: ...
def do_should_getstate(self, owner: CAtom) -> bool: ...
# Setter for the member
def set_index(self, index: int) -> None: ...
def set_name(self, name: str) -> None: ...
# Default value mode
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.List], context: list[Any]
) -> None: ...
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.Set], context: set[Any]
) -> None: ...
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.Dict], context: dict[Any, Any]
) -> None: ...
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.CallObject], context: Callable[[], Any]
) -> None: ...
@overload
def set_default_value_mode(
self,
mode: Literal[DefaultValue.CallObject_Object],
context: Callable[[CAtom], Any],
) -> None: ...
@overload
def set_default_value_mode(
self,
mode: Literal[DefaultValue.CallObject_ObjectName],
context: Callable[[CAtom, str], Any],
) -> None: ...
@overload
def set_default_value_mode(
self,
mode: Literal[DefaultValue.ObjectMethod]
| Literal[DefaultValue.ObjectMethod_Name]
| Literal[DefaultValue.MemberMethod_Object],
context: str,
) -> None: ...
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.Static], context: Any
) -> None: ...
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.NonOptional], context: None
) -> None: ...
@overload
def set_default_value_mode(
self, mode: Literal[DefaultValue.NoOp], context: None
) -> None: ...
# Delattr mode
@overload
def set_delattr_mode(
self, mode: Literal[DelAttr.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_delattr_mode(
self,
mode: Literal[DelAttr.Property],
context: Optional[Callable[[CAtom], None]],
) -> None: ...
@overload
def set_delattr_mode(
self,
mode: Literal[DelAttr.Constant]
| Literal[DelAttr.Event]
| Literal[DelAttr.NoOp]
| Literal[DelAttr.ReadOnly]
| Literal[DelAttr.Signal]
| Literal[DelAttr.Slot],
context: None,
) -> None: ...
# Getattr mode
@overload
def set_getattr_mode(
self, mode: Literal[GetAttr.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_getattr_mode(
self,
mode: Literal[GetAttr.Property] | Literal[GetAttr.CachedProperty],
context: Optional[Callable[[CAtom], Any]],
) -> None: ...
@overload
def set_getattr_mode(
self, mode: Literal[GetAttr.CallObject_Object], context: Callable[[CAtom], Any]
) -> None: ...
@overload
def set_getattr_mode(
self,
mode: Literal[GetAttr.CallObject_ObjectName],
context: Callable[[CAtom, str], Any],
) -> None: ...
@overload
def set_getattr_mode(
self,
mode: Literal[GetAttr.ObjectMethod]
| Literal[GetAttr.ObjectMethod_Name]
| Literal[GetAttr.MemberMethod_Object],
context: str,
) -> None: ...
@overload
def set_getattr_mode(
self,
mode: Literal[GetAttr.Event]
| Literal[GetAttr.NoOp]
| Literal[GetAttr.Signal]
| Literal[GetAttr.Slot],
context: str,
) -> None: ...
# Post getattr mode
@overload
def set_post_getattr_mode(
self, mode: Literal[PostGetAttr.NoOp], context: None
) -> None: ...
@overload
def set_post_getattr_mode(
self, mode: Literal[PostGetAttr.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_post_getattr_mode(
self,
mode: Literal[PostGetAttr.ObjectMethod_Value]
| Literal[PostGetAttr.ObjectMethod_NameValue]
| Literal[PostGetAttr.MemberMethod_ObjectValue],
context: str,
) -> None: ...
# Post setattr mode
@overload
def set_post_setattr_mode(
self, mode: Literal[PostSetAttr.NoOp], context: None
) -> None: ...
@overload
def set_post_setattr_mode(
self, mode: Literal[PostSetAttr.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_post_setattr_mode(
self,
mode: Literal[PostSetAttr.ObjectMethod_OldNew]
| Literal[PostSetAttr.ObjectMethod_NameOldNew]
| Literal[PostSetAttr.MemberMethod_ObjectOldNew],
context: str,
) -> None: ...
# Post validate mode
@overload
def set_post_validate_mode(
self, mode: Literal[PostValidate.NoOp], context: None
) -> None: ...
@overload
def set_post_validate_mode(
self, mode: Literal[PostValidate.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_post_validate_mode(
self,
mode: Literal[PostValidate.ObjectMethod_OldNew]
| Literal[PostValidate.ObjectMethod_NameOldNew]
| Literal[PostValidate.MemberMethod_ObjectOldNew],
context: str,
) -> None: ...
# Setattr mode
@overload
def set_setattr_mode(
self,
mode: Literal[SetAttr.Constant]
| Literal[SetAttr.Event]
| Literal[SetAttr.NoOp]
| Literal[SetAttr.ReadOnly]
| Literal[SetAttr.Signal]
| Literal[SetAttr.Slot],
context: None,
) -> None: ...
@overload
def set_setattr_mode(
self, mode: Literal[SetAttr.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_setattr_mode(
self,
mode: Literal[SetAttr.Property],
context: Optional[Callable[[CAtom], Any]],
) -> None: ...
@overload
def set_setattr_mode(
self,
mode: Literal[SetAttr.CallObject_ObjectValue],
context: Callable[[CAtom, Any], Any],
) -> None: ...
@overload
def set_setattr_mode(
self,
mode: Literal[SetAttr.CallObject_ObjectNameValue],
context: Callable[[CAtom, str, Any], Any],
) -> None: ...
@overload
def set_setattr_mode(
self,
mode: Literal[SetAttr.ObjectMethod_Value]
| Literal[SetAttr.ObjectMethod_NameValue]
| Literal[SetAttr.MemberMethod_ObjectValue],
context: str,
) -> None: ...
# Validate mode
@overload
def set_validate_mode(
self,
mode: Literal[Validate.Bool]
| Literal[Validate.Bytes]
| Literal[Validate.BytesPromote]
| Literal[Validate.Callable]
| Literal[Validate.Float]
| Literal[Validate.FloatPromote]
| Literal[Validate.Int]
| Literal[Validate.IntPromote]
| Literal[Validate.NoOp]
| Literal[Validate.Str]
| Literal[Validate.StrPromote],
context: None,
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.Tuple]
| Literal[Validate.List]
| Literal[Validate.ContainerList]
| Literal[Validate.Set],
context: Optional[Member[Any, Any]],
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.Dict],
context: Tuple[Optional[Member[Any, Any]], Optional[Member[Any, Any]]],
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.Instance]
| Literal[Validate.OptionalInstance]
| Literal[Validate.Subclass],
context: type | Tuple[type, ...],
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.Typed] | Literal[Validate.OptionalTyped],
context: type,
) -> None: ...
@overload
def set_validate_mode(
self, mode: Literal[Validate.Enum], context: Sequence[Any]
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.FloatRange],
context: Tuple[Optional[float], Optional[float]],
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.Range],
context: Tuple[Optional[int], Optional[int]],
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.Coerced],
context: Tuple[Type[T], Callable[[Any], T]],
) -> None: ...
@overload
def set_validate_mode(
self, mode: Literal[Validate.Delegate], context: Member[T, S]
) -> None: ...
@overload
def set_validate_mode(
self,
mode: Literal[Validate.ObjectMethod_OldNew]
| Literal[Validate.ObjectMethod_NameOldNew]
| Literal[Validate.MemberMethod_ObjectOldNew],
context: str,
) -> None: ...
# Getstate mode
@overload
def set_getstate_mode(
self,
mode: Literal[GetState.Exclude]
| Literal[GetState.Include]
| Literal[GetState.IncludeNonDefault]
| Literal[GetState.Property],
context: None,
) -> None: ...
@overload
def set_getstate_mode(
self,
mode: Literal[GetState.MemberMethod_Object]
| Literal[GetState.ObjectMethod_Name],
context: str,
) -> None: ...
KT = TypeVar("KT")
VT = TypeVar("VT")
class atomlist(List[T]): ...
class atomclist(atomlist[T]): ...
class atomset(Set[T]): ...
class atomdict(Dict[KT, VT]): ...
class defaultatomdict(Dict[KT, VT]): ...
A = TypeVar("A", bound=CAtom)
class atomref(Generic[A]):
def __new__(cls, atom: A) -> atomref[A]: ...
def __bool__(self) -> bool: ...
def __call__(self) -> Optional[A]: ...
def __sizeof__(self) -> int: ...
class SignalConnector:
def __call__(self, *args: Any, **kwargs: Any) -> None: ...
def emit(self, *args: Any, **kwargs: Any) -> None: ...
def connect(self, slot: Callable[..., Any]) -> None: ...
def disconnect(self, slot: Callable[..., Any]) -> None: ...
class EventBinder:
def bind(self, observer: Callable[[Dict[str, Any]], None]) -> None: ...
def unbind(self, observer: Callable[[Dict[str, Any]], None]) -> None: ...
class DefaultValue(IntEnum):
CallObject = ...
CallObject_Object = ...
CallObject_ObjectName = ...
Delegate = ...
Dict = ...
DefaultDict = ...
List = ...
MemberMethod_Object = ...
NonOptional = ...
NoOp = ...
ObjectMethod = ...
ObjectMethod_Name = ...
Set = ...
Static = ...
class DelAttr(IntEnum):
Constant = ...
Delegate = ...
Event = ...
NoOp = ...
Property = ...
ReadOnly = ...
Signal = ...
Slot = ...
class GetAttr(IntEnum):
CachedProperty = ...
CallObject_Object = ...
CallObject_ObjectName = ...
Delegate = ...
Event = ...
MemberMethod_Object = ...
NoOp = ...
ObjectMethod = ...
ObjectMethod_Name = ...
Property = ...
Signal = ...
Slot = ...
class PostGetAttr(IntEnum):
Delegate = ...
MemberMethod_ObjectValue = ...
NoOp = ...
ObjectMethod_NameValue = ...
ObjectMethod_Value = ...
class PostSetAttr(IntEnum):
Delegate = ...
MemberMethod_ObjectOldNew = ...
NoOp = ...
ObjectMethod_NameOldNew = ...
ObjectMethod_OldNew = ...
class PostValidate(IntEnum):
Delegate = ...
MemberMethod_ObjectOldNew = ...
NoOp = ...
ObjectMethod_NameOldNew = ...
ObjectMethod_OldNew = ...
class SetAttr(IntEnum):
CallObject_ObjectNameValue = ...
CallObject_ObjectValue = ...
Constant = ...
Delegate = ...
Event = ...
MemberMethod_ObjectValue = ...
NoOp = ...
ObjectMethod_NameValue = ...
ObjectMethod_Value = ...
Property = ...
ReadOnly = ...
Signal = ...
Slot = ...
class Validate(IntEnum):
Bool = ...
Bytes = ...
BytesPromote = ...
Callable = ...
Coerced = ...
ContainerList = ...
Delegate = ...
Dict = ...
DefaultDict = ...
Enum = ...
FixedTuple = ...
Float = ...
FloatPromote = ...
FloatRange = ...
Instance = ...
Int = ...
IntPromote = ...
List = ...
MemberMethod_ObjectOldNew = ...
OptionalInstance = ...
OptionalTyped = ...
NoOp = ...
ObjectMethod_NameOldNew = ...
ObjectMethod_OldNew = ...
Range = ...
Set = ...
Str = ...
StrPromote = ...
Subclass = ...
Tuple = ...
Typed = ...
class GetState(IntEnum):
Exclude = ...
Include = ...
IncludeNonDefault = ...
Property = ...
MemberMethod_Object = ...
ObjectMethod_Name = ...
|