eric7.RemoteServerInterface.EricServerProfile

Module implementing a dataclass for an eric-ide server profile.

Global Attributes

None

Classes

EricServerProfile

Class implementing a data structure for storing an eric-ide server profile.

Functions

None

EricServerProfile

Class implementing a data structure for storing an eric-ide server profile.

Derived from

None

Class Attributes

clientId

hostname

port

timeout

Class Methods

fromDict	Class method to create a server profile from a given profile dictionary.
fromJSON	Class method to create a profile instance given a JSON string.

Methods

defaultPort	Public method defining the default port property.
defaultTimeout	Public method defining the default connection timeout.
toDict	Public method to convert the profile data to a dictionary.
toJSON	Public method to convert the profile data to a JSON string.

Static Methods

None

EricServerProfile.fromDict (class method)

fromDict(data)

Class method to create a server profile from a given profile dictionary.

data (dict): dictionary containing the profile data

Return:: instantiated server profile object

Return Type:: EricServerProfile

EricServerProfile.fromJSON (class method)

fromJSON(jsonStr)

Class method to create a profile instance given a JSON string.

jsonStr (str): JSON string containing the encoded profile data

Return:: server profile data instance

Return Type:: EricServerProfile

EricServerProfile.defaultPort

defaultPort()

Public method defining the default port property.

Return:: default connection port

Return Type:: int

EricServerProfile.defaultTimeout

defaultTimeout()

Public method defining the default connection timeout.

Return:: default connection timeout

Return Type:: int

EricServerProfile.toDict

toDict()

Public method to convert the profile data to a dictionary.

Return:: dictionary with keys "hostname", "port", "timeout" and "client_id" containing the profile data

Return Type:: dict

EricServerProfile.toJSON

toJSON()

Public method to convert the profile data to a JSON string.

Return:: string containing the JSON encoded profile data

Return Type:: str