player.md

Player

petstore_api.components.schema.player

type: schemas.Schema

Description

a model that includes a self reference this forces properties and additionalProperties to be lazy loaded in python models because the Player class has not fully loaded when defining properties

validate method

Input Type	Return Type	Notes
PlayerDictInput, PlayerDict	PlayerDict

PlayerDictInput

type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]

Key	Type	Description	Notes
name	str		[optional]
enemyPlayer	PlayerDictInput, PlayerDict		[optional]
any_string_name	dict, schemas.immutabledict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.FileIO	any string name can be used but the value must be the correct type	[optional]

PlayerDict

base class: schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES]

__new__ method

Keyword Argument	Type	Description	Notes
name	str, schemas.Unset		[optional]
enemyPlayer	PlayerDictInput, PlayerDict, schemas.Unset		[optional]
kwargs	schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO	any string name can be used but the value must be the correct type a model that includes a self reference this forces properties and additionalProperties to be lazy loaded in python models because the Player class has not fully loaded when defining properties	[optional] typed value is accessed with the get_additional_property_ method

properties

Property	Type	Description	Notes
name	str, schemas.Unset		[optional]
enemyPlayer	PlayerDict, schemas.Unset		[optional]

methods

Method	Input Type	Return Type	Notes
from_dict_	PlayerDictInput, PlayerDict	PlayerDict	a constructor
get_additional_property_	str	schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO, schemas.Unset	provides type safety for additional properties

[Back to top] [Back to Component Schemas] [Back to README]