Back to bricks list

Research documentation

Getting Started

Developer guide

Release

CLI

Technical Documentation

InPort

IntPort class representing input port

Attributes

name: str

Functions

__INIT__

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

Parameters:

Name	Type	Default value	Description
name	`str`
_resource_spec	`IOSpec`

GET_DEFAULT_RESOURCE_TYPE

Return type:

Type

GET_RESOURCE

Parameters:

Name	Type	Default value	Description
new_instance	`bool`	False

Return type:

Resource

GET_RESOURCE_MODEL

Return type:

Optional

GET_RESOURCE_MODEL_ID

Return type:

Optional

RESET

RESOURCE_TYPE_IS_COMPATIBLE

Sets the resource of the port.

Parameters:

Name	Type	Default value	Description
resource_type	`Type`

Return type:

bool

SET_RESOURCE_MODEL

Parameters:

Name	Type	Default value	Description
resource_model	`Optional`

SET_RESOURCE_MODEL_ID

Sets the resource of the port.

Parameters:

Name	Type	Default value	Description
resource_id	`Optional`

TO_DTO

Return type:

PortDTO

CLASSNAME - @classmethod

Returns the name of the class

Parameters:

Name	Type	Default value	Description
slugify	`bool`	False	True to slugify the class name if true, defaults to false , optional
snakefy	`bool`	False	True to snakefy the class name if true, defaults to false , optional
replace_uppercase	`bool`	False	Replace upper cases by "-" if true, defaults to false , optional

Return type:

str

DECORATED_METHOD_NAMES - @classmethod

Parameters:

Name	Type	Default value	Description
decorator_name	`Any`

FULL_CLASSNAME - @classmethod

Returns the full name of the class

Parameters:

Name	Type	Default value	Description
slugify	`bool`	False	Slugify the returned class name if true, defaults to false , optional
snakefy	`bool`	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:

Name	Type	Default value	Description
dto	`PortDTO`
name	`str`

Return type:

PortType

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:

Name	Type	Default value	Description
instance	`type`		The s of the properties to retrieve. set `none` to retrieve all. `type` or `union[type]`
exclude	`type`

Return type:

List