# eric7.RemoteServerInterface.EricServerCoverageInterface

Module implementing the code coverage interface to the eric-ide server.

### Global Attributes

None

### Classes

EricServerCoverageError | Class defining a substitute exception for coverage errors of the server.
EricServerCoverageInterface | Class implementing the code coverage interface to the eric-ide server.

### Functions

None

## EricServerCoverageError

Class defining a substitute exception for coverage errors of the server.

### Derived from

Exception

### Class Attributes

None

### Class Methods

None

### Methods

None

### Static Methods

None

Up

## EricServerCoverageInterface

Class implementing the code coverage interface to the eric-ide server.

### Derived from

QObject

### Class Attributes

None

### Class Methods

None

### Methods

EricServerCoverageInterface | Constructor
analyzeDirectory | Public method to analyze the code coverage of a directory.
analyzeFile | Public method to analyze the code coverage of one file.
analyzeFiles | Public method to analyze the code coverage of a list of files.
callback | Function to handle the server reply
loadCoverageData | Public method to tell the server to load the coverage data for a later analysis.

### Static Methods

None

#### EricServerCoverageInterface (Constructor)

EricServerCoverageInterface(serverInterface)

Constructor

serverInterface (EricServerInterface)
  reference to the eric-ide server interface

#### EricServerCoverageInterface.analyzeDirectory

analyzeDirectory(directory)

Public method to analyze the code coverage of a directory.

directory (str)
  directory name to be analyzed

Return:
  lists containing coverage results as reported by Coverage.analysis2()

Return Type:
  list of [list of [str, list of int, list of int, list of int, str]]

Raises EricServerCoverageError:
  raised to indicate a coverage exception
Raises OSError:
  raised to indicate that server is not connected

#### EricServerCoverageInterface.analyzeFile

analyzeFile(filename)

Public method to analyze the code coverage of one file.

filename (str)
  name of the file to be analyzed

Return:
  list containing coverage result as reported by Coverage.analysis2()

Return Type:
  list of [str, list of int, list of int, list of int, str]

Raises EricServerCoverageError:
  raised to indicate a coverage exception
Raises OSError:
  raised to indicate that server is not connected

#### EricServerCoverageInterface.analyzeFiles

analyzeFiles(filenames)

Public method to analyze the code coverage of a list of files.

filenames (str)
  list of file names to be analyzed

Return:
  lists containing coverage results as reported by Coverage.analysis2()

Return Type:
  list of [list of [str, list of int, list of int, list of int, str]]

Raises EricServerCoverageError:
  raised to indicate a coverage exception
Raises OSError:
  raised to indicate that server is not connected

#### EricServerCoverageInterface.callback

callback(params)

Function to handle the server reply

reply (str)
  name of the server reply
params (dict)
  dictionary containing the reply data

#### EricServerCoverageInterface.loadCoverageData

loadCoverageData(dataFile, excludePattern="")

Public method to tell the server to load the coverage data for a later analysis.

dataFile (str)
  name of the data file to be loaded
excludePattern (str (optional))
  regular expression determining files to be excluded (defaults to "")

Return:
  tuple containing a success flag and an error message

Return Type:
  tuple of (bool, str)

Up