meta
FoundResponseInfo
A class to store information about a found response class (type).
Source code in horde_sdk/meta.py
__init__
__init__(
*,
response: type[HordeResponse],
api_model_name: str | None,
parent_request: type[HordeRequest],
http_status_code: HTTPStatusCode,
endpoint: str,
http_method: HTTPMethod
) -> None
Initialize the FoundResponseInfo object.
Parameters:
-
response(type[HordeResponse]) –The response class.
-
api_model_name(str | None) –The API model name
-
parent_request(type[HordeRequest]) –The parent request class.
-
http_status_code(HTTPStatusCode) –The HTTP status code.
-
endpoint(str) –The endpoint.
-
http_method(HTTPMethod) –The HTTP method.
Source code in horde_sdk/meta.py
__eq__
Source code in horde_sdk/meta.py
FoundMixinInfo
A class to store information about a found mixin class (type).
Source code in horde_sdk/meta.py
__init__
Initialize the FoundMixinInfo object.
Parameters:
-
mixin(type) –The mixin class.
-
api_model_name(str | None) –The API model name
Source code in horde_sdk/meta.py
__eq__
find_subclasses
cached
Find all subclasses of a given type in a module or package.
Parameters:
-
module_or_package(ModuleType) –The module or package to search in.
-
super_type(type) –The super type of the classes to search for.
Returns:
-
list[type]–list[type]: A list of all the subclasses of the super type in the module or package.
Source code in horde_sdk/meta.py
find_subclasses_and_dependency_imports
cached
find_subclasses_and_dependency_imports(
module_or_package: ModuleType, super_type: type
) -> list[tuple[type, list[str]]]
Find all subclasses of a given type in a module or package.
Parameters:
-
module_or_package(ModuleType) –The module or package to search in.
-
super_type(type) –The super type of the classes to search for.
Returns:
-
list[tuple[type, list[str]]]–list[tuple[type, list[str]]]: A list of tuples of all the subclasses of the super type in the module or package
-
list[tuple[type, list[str]]]–and all of the imported symbols in the module.
Source code in horde_sdk/meta.py
any_unimported_classes
Check if any classes in the module are not imported in the __init__.py of the apimodels namespace.
Parameters:
-
module(ModuleType) –The module to check.
-
super_type(type) –The super type of the classes to check.
Returns:
-
bool–tuple[bool, set[type]]: A tuple with a boolean indicating if there are any unimported classes and a set of the
-
set[type]–unimported classes.
Source code in horde_sdk/meta.py
all_undefined_classes
Return all of the models defined on the API but not in the SDK.
Source code in horde_sdk/meta.py
all_undefined_classes_for_endpoints
Return all of the models defined on the API but not in the SDK.
Source code in horde_sdk/meta.py
all_unknown_endpoints_ai_horde
Return all of the endpoints defined on the API but not known by the SDK.
Source code in horde_sdk/meta.py
all_unaddressed_endpoints_ai_horde
Return all of the endpoints known by the SDK but with no corresponding request.
Source code in horde_sdk/meta.py
all_models_missing_docstrings
Return all of the models that do not have docstrings.
Source code in horde_sdk/meta.py
all_model_and_fields_missing_docstrings
Return all of the models' fields that do not have docstrings.
Source code in horde_sdk/meta.py
all_models_non_conforming_docstrings
Return all of the models that do not have a v2 API model.
Source code in horde_sdk/meta.py
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 | |