Login
Back to bricks list
Introduction Version

InPort

IntPort class representing input port

Attributes

name: str

Functions

__INIT__

Initialize self. See help(type(self)) for accurate signature.

Parameters:
NameTypeDefault valueDescription
namestr
_resource_specIOSpec
GET_DEFAULT_RESOURCE_TYPE
Return type:
Type
GET_RESOURCE
Parameters:
NameTypeDefault valueDescription
new_instancebool False
Return type:
Resource
RESET
RESOURCE_TYPE_IS_COMPATIBLE

Sets the resource of the port.

Parameters:
NameTypeDefault valueDescription
resource_typeType
Return type:
bool
TO_DTO
Return type:
PortDTO
CLASSNAME - @classmethod

Returns the name of the class

Parameters:
NameTypeDefault valueDescription
slugifybool False True to slugify the class name if true, defaults to false , optional
snakefybool False True to snakefy the class name if true, defaults to false , optional
replace_uppercasebool False Replace upper cases by "-" if true, defaults to false , optional
Return type:
str
DECORATED_METHOD_NAMES - @classmethod
Parameters:
NameTypeDefault valueDescription
decorator_nameAny
FULL_CLASSNAME - @classmethod

Returns the full name of the class

Parameters:
NameTypeDefault valueDescription
slugifybool False Slugify the returned class name if true, defaults to false , optional
snakefybool False Snakefy the returned class name if true, defaults to false ``
Return type:
str
INHERITORS - @classmethod

Get all the classes that inherit this class

Return type:
List
LOAD_FROM_DTO - @classmethod
Parameters:
NameTypeDefault valueDescription
dtoPortDTO
namestr
Return type:
Port
METHOD_NAMES - @classmethod

Returns the list of the methods

Return type:
List
MODULE_NAME - @classmethod

Returns the module name of the class

Return type:
str
PROPERTY_METHOD_NAMES - @classmethod
PROPERTY_NAMES - @classmethod

Retrieves the property names

Parameters:
NameTypeDefault valueDescription
instancetype The s of the properties to retrieve. set `none` to retrieve all. `type` or `union[type]`
excludetype
Return type:
List