Inheritance diagram for Model:

[legend]

Collaboration diagram for Model:

[legend]

Public Member Functions
	__init__ (self)

	all_subtypes (self)

	discriminator (self)

	extends (self)

	extends_lc (self)

	has_properties (self)

	has_subtypes (self)

	load (self, id, model_json, processor, context)

	properties (self)

	set_extends_type (self, extends_type)

	set_subtype_types (self, subtype_types)

Public Member Functions inherited from Stringify
	__repr__ (self)

Data Fields
	description

	id

	id_lc

	model_json

	notes

	required_fields

	subtypes

Static Public Attributes
list	required_fields = ['description', 'properties']

Detailed Description

Model of a Swagger model.

See https://github.com/wordnik/swagger-core/wiki/datatypes

Definition at line 499 of file swagger_model.py.

Constructor & Destructor Documentation

◆ init()

__init__ ( self )

Definition at line 507 of file swagger_model.py.

    def __init__(self):
        self.id = None
        self.id_lc = None
        self.subtypes = []
        self.__subtype_types = []
        self.notes = None
        self.description = None
        self.__properties = None
        self.__discriminator = None
        self.__extends_type = None
 

Member Function Documentation

◆ all_subtypes()

all_subtypes ( self )

Returns the full list of all subtypes, including sub-subtypes.

Definition at line 585 of file swagger_model.py.

    def all_subtypes(self):
        """Returns the full list of all subtypes, including sub-subtypes.
        """
        res = self.__subtype_types + \
              [subsubtypes for subtype in self.__subtype_types
               for subsubtypes in subtype.all_subtypes()]
        return sorted(res, key=lambda m: m.id)
 

References Model.__subtype_types.

◆ discriminator()

discriminator ( self )

Returns the discriminator, digging through base types if needed.

Definition at line 570 of file swagger_model.py.

    def discriminator(self):
        """Returns the discriminator, digging through base types if needed.
        """
        return self.__discriminator or \
            self.__extends_type and self.__extends_type.discriminator()
 

References Model.__discriminator, Model.__extends_type, and Model.discriminator().

Referenced by Model.discriminator().

◆ extends()

extends ( self )

Definition at line 558 of file swagger_model.py.

    def extends(self):
        return self.__extends_type and self.__extends_type.id
 

References Model.__extends_type.

◆ extends_lc()

extends_lc ( self )

Definition at line 561 of file swagger_model.py.

    def extends_lc(self):
        return self.__extends_type and self.__extends_type.id_lc
 

References Model.__extends_type.

◆ has_properties()

has_properties ( self )

Definition at line 582 of file swagger_model.py.

    def has_properties(self):
        return len(self.properties()) > 0
 

References len(), ast_channel_tech.properties, Model.properties(), and ast_rtp_instance.properties.

◆ has_subtypes()

has_subtypes ( self )

Returns True if type has any subtypes.

Definition at line 593 of file swagger_model.py.

    def has_subtypes(self):
        """Returns True if type has any subtypes.
        """
        return len(self.subtypes) > 0
 
 

References len(), and Model.subtypes.

◆ load()

load	(	self,
		id,
		model_json,
		processor,
		context
	)

Definition at line 518 of file swagger_model.py.

    def load(self, id, model_json, processor, context):
        context = context.next_stack(model_json, 'id')
        validate_required_fields(model_json, self.required_fields, context)
        # The duplication of the model's id is required by the Swagger spec.
        self.id = model_json.get('id')
        self.id_lc = self.id.lower() 
        if id != self.id:
            raise SwaggerError("Model id doesn't match name", context)
        self.subtypes = model_json.get('subTypes') or []
        if self.subtypes and context.version_less_than("1.2"):
            raise SwaggerError("Type extension support added in Swagger 1.2",
                               context)
        self.description = model_json.get('description')
        props = model_json.get('properties').items() or []
        self.__properties = [
            Property(k).load(j, processor, context) for (k, j) in props]
        self.__properties = sorted(self.__properties, key=lambda p: p.name)
 
        discriminator = model_json.get('discriminator')
 
        if discriminator:
            if context.version_less_than("1.2"):
                raise SwaggerError("Discriminator support added in Swagger 1.2",
                                   context)
 
            discr_props = [p for p in self.__properties if p.name == discriminator]
            if not discr_props:
                raise SwaggerError(
                    "Discriminator '%s' does not name a property of '%s'" % (
                        discriminator, self.id),
                    context)
 
            self.__discriminator = discr_props[0]
 
        self.model_json = json.dumps(model_json,
                                     indent=2, separators=(',', ': '))
 
        processor.process_model(self, context)
        return self
 

Referenced by ApiDeclaration.load_file(), and ResourceListing.load_file().

◆ properties()

properties ( self )

Definition at line 576 of file swagger_model.py.

    def properties(self):
        base_props = []
        if self.__extends_type:
            base_props = self.__extends_type.properties()
        return base_props + self.__properties
 

References Model.__extends_type, Model.__properties, and Model.properties().

Referenced by Model.has_properties(), and Model.properties().

◆ set_extends_type()

set_extends_type	(	self,
		extends_type
	)

Definition at line 564 of file swagger_model.py.

    def set_extends_type(self, extends_type):
        self.__extends_type = extends_type
 

References Model.__extends_type.

◆ set_subtype_types()

set_subtype_types	(	self,
		subtype_types
	)

Definition at line 567 of file swagger_model.py.

    def set_subtype_types(self, subtype_types):
        self.__subtype_types = subtype_types
 

References Model.__subtype_types.

Field Documentation

◆ description

description

Definition at line 513 of file swagger_model.py.

◆ id

id

Definition at line 508 of file swagger_model.py.

Referenced by Section.__cmp__(), Section.__eq__(), Section.__ge__(), Section.__gt__(), Section.__le__(), and Section.__lt__().

◆ id_lc

id_lc

Definition at line 509 of file swagger_model.py.

◆ model_json

model_json

Definition at line 552 of file swagger_model.py.

◆ notes

notes

Definition at line 512 of file swagger_model.py.

◆ required_fields [1/2]

list required_fields = ['description', 'properties']

static

Definition at line 505 of file swagger_model.py.

◆ required_fields [2/2]

required_fields

Definition at line 520 of file swagger_model.py.

◆ subtypes

subtypes

Definition at line 510 of file swagger_model.py.

Referenced by Model.has_subtypes().

The documentation for this class was generated from the following file:

swagger_model.py

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ all_subtypes()

◆ discriminator()

◆ extends()

◆ extends_lc()

◆ has_properties()

◆ has_subtypes()

◆ load()

◆ properties()

◆ set_extends_type()

◆ set_subtype_types()

Field Documentation

◆ description

◆ id

◆ id_lc

◆ model_json

◆ notes

◆ required_fields [1/2]

◆ required_fields [2/2]

◆ subtypes

◆ init()