dtmc.DTMC.DTMC Class Reference

DTMC Class contents main functional of DTMC application, class inherits from foundation.CementApp. More...

Inheritance diagram for dtmc.DTMC.DTMC:

Collaboration diagram for dtmc.DTMC.DTMC:

Classes
class	Meta

Public Member Functions
def	__init__ (self, connectionBuilder=None)
	constructor initialise all class variable and recieve connectionBuilder as param(not mandatory) More...
def	fillError (self, errorStr, errorCode, isLogging=True)
	fillError method calls from error-code point from main processing (...from event handlers) errorStr - external errorMessage errorCode - external errorCode More...
def	connectionInit (self)
	connectionInit method initializes internal variables that containts network connections/communications More...
def	taskProcessingDeserialize (self, task, fileName, task_id)
	taskProcessingDeserialize method Reads task from file and deserializes it. More...
def	generateEmptyResponse (self, task)
	generateEmptyResponse method If here was some critical error, we generate empty response here , instead real response task - task arg More...
def	taskProcessingSerialize (self, task, eventObj)
	taskProcessingDeserialize method Method serializes incoming task to the JSON string task - task arg eventObj - response event object More...
def	transportCommunications (self, task, eventObj)
	taskProcessingDeserialize method Method serializes incoming task to the JSON string task - task arg eventObj - response event object More...
def	configReader (self)
	configReader method Method try to read config file by prereared paths, return count of readed configs More...
def	loadLogConfigFile (self)
	load logging load logging configuration (log file, log level, filters) More...
def	setup (self)
	setup method Method calls before run application More...
def	run (self)
	run method Method contains main application functionality More...
def	close (self)
	close method Method calls after application run More...

Public Attributes
	config
	connectionBuilder
	localConnection
	eventBuilder
	dTMCObjectsSerializator
	errorCode
	errorStr

Static Public Attributes
	label = CONSTANTS.APP_NAME

Detailed Description

DTMC Class contents main functional of DTMC application, class inherits from foundation.CementApp.

Definition at line 39 of file DTMC.py.

Constructor & Destructor Documentation

__init__()

def dtmc.DTMC.DTMC.__init__	(		self,
			connectionBuilder = None
	)

constructor initialise all class variable and recieve connectionBuilder as param(not mandatory)

Definition at line 47 of file DTMC.py.

  def __init__(self, connectionBuilder=None):
    foundation.CementApp.__init__(self)
    self.config = ConfigParser.ConfigParser()
    self.connectionBuilder = connectionBuilder
    self.localConnection = None
    self.eventBuilder = EventBuilder()
    self.dTMCObjectsSerializator = DTMCObjectsSerializator()
    self.errorCode = CONSTANTS.ERROR_NOERROR
    self.errorStr = ""

Member Function Documentation

close()

def dtmc.DTMC.DTMC.close

(

self

)

close method Method calls after application run

Definition at line 337 of file DTMC.py.

  def close(self):
    foundation.CementApp.close(self)

configReader()

def dtmc.DTMC.DTMC.configReader

(

self

)

configReader method Method try to read config file by prereared paths, return count of readed configs

Definition at line 241 of file DTMC.py.

  def configReader(self):
    configReadList = []
    if self.pargs.config == None:
      configReadList = self.config.read(CONSTANTS.DEFAULT_CONFIG_NAME1)
      if len(configReadList) == 0:
        configReadList = self.config.read(CONSTANTS.DEFAULT_CONFIG_NAME2)
    else:
      configReadList = self.config.read(self.pargs.config)
    return len(configReadList)

Here is the caller graph for this function:

connectionInit()

def dtmc.DTMC.DTMC.connectionInit

(

self

)

connectionInit method initializes internal variables that containts network connections/communications

Definition at line 71 of file DTMC.py.

  def connectionInit(self):
    if self.connectionBuilder == None:
      self.connectionBuilder = ConnectionBuilderLight()
    host = str(self.config.get(CONSTANTS.APP_NAME, CONSTANTS.DTM_HOST))
    if len(host) > 1 and host[0] == "\"":
      host = host[1:]
    if host[-1] == "\"":
      host = host[0:-1]
    port = str(self.config.get(CONSTANTS.APP_NAME, CONSTANTS.DTM_PORT))
    addr = host + ":" + port
    self.localConnection = self.connectionBuilder.build(transport.Consts.CLIENT_CONNECT, addr,
                          transport.Consts.TCP_TYPE)

Here is the caller graph for this function:

fillError()

def dtmc.DTMC.DTMC.fillError	(		self,
			errorStr,
			errorCode,
			isLogging = True
	)

fillError method calls from error-code point from main processing (...from event handlers) errorStr - external errorMessage errorCode - external errorCode

Definition at line 62 of file DTMC.py.

  def fillError(self, errorStr, errorCode, isLogging=True):
    self.errorCode = errorCode
    self.errorStr = errorStr
    if isLogging:
      logger.error(self.errorStr)

Here is the caller graph for this function:

generateEmptyResponse()

def dtmc.DTMC.DTMC.generateEmptyResponse	(		self,
			task
	)

generateEmptyResponse method If here was some critical error, we generate empty response here , instead real response task - task arg

Definition at line 119 of file DTMC.py.

  def generateEmptyResponse(self, task):
    obj = None
    jsonString = None
    if task == None:
      obj = dtm.EventObjects.GeneralResponse()
    elif task == CONSTANTS.TASKS[0]:
      obj = dtm.EventObjects.GeneralResponse()
    elif task == CONSTANTS.TASKS[1]:
      obj = dtm.EventObjects.EEResponseData(0)
    elif task == CONSTANTS.TASKS[2]:
      obj = dtm.EventObjects.GeneralResponse()
    elif task == CONSTANTS.TASKS[3]:
      obj = dtm.EventObjects.EEResponseData(0)
    elif task == CONSTANTS.TASKS[4]:
      obj = []
    elif task == CONSTANTS.TASKS[5]:
      obj = dtm.EventObjects.GeneralResponse(0)
    elif task == CONSTANTS.TASKS[6]:
      obj = dtm.EventObjects.AvailableTaskIds([])
    else:
      obj = dtm.EventObjects.GeneralResponse()
      self.errorCode = CONSTANTS.ERROR_UNKNOWN_TASK
      self.errorStr = CONSTANTS.ERROR_STR14
    if type(obj) == type([]):
      jsonString = json.dumps(obj)
    else:
      obj.errorCode = self.errorCode
      obj.errorMessage = self.errorStr
      jsonString = obj.toJSON()
    return jsonString

Here is the caller graph for this function:

loadLogConfigFile()

def dtmc.DTMC.DTMC.loadLogConfigFile

(

self

)

load logging load logging configuration (log file, log level, filters)

Definition at line 255 of file DTMC.py.

  def loadLogConfigFile(self):
    global logger  # pylint: disable=W0603
    try:
      logIniFileName = self.config.get(CONSTANTS.LOG_CONFIG_SECTION_NAME, CONSTANTS.LOG_CONFIG_OPTION_NAME)
      if logIniFileName != None:
        logging.config.fileConfig(logIniFileName)
    except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
      self.errorStr = CONSTANTS.ERROR_STR10
      self.errorCode = CONSTANTS.ERROR_LOG_SECTION_ERROR
    except Exception, err:
      self.errorStr = CONSTANTS.ERROR_STR11 + ': ' + str(err)
      self.errorCode = CONSTANTS.ERROR_LOG_INIT
    logger = Utils.MPLogger().getLogger()

Here is the call graph for this function:

Here is the caller graph for this function:

run()

def dtmc.DTMC.DTMC.run

(

self

)

run method Method contains main application functionality

Definition at line 278 of file DTMC.py.

  def run(self):
    foundation.CementApp.run(self)
    isHelpArg = False
    if '-h' in self.argv or '--help' in self.argv:
      isHelpArg = True
    eventObj = None
    retEventObj = None
    jsonBuf = None

    if self.configReader() > 0:
      self.loadLogConfigFile()

      if self.errorCode == CONSTANTS.ERROR_NOERROR:
        try:
          self.connectionInit()
        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
          self.fillError(CONSTANTS.ERROR_STR13, CONSTANTS.ERROR_CONFIG_SECTION)
        except Exception:
          self.fillError(CONSTANTS.ERROR_STR12, CONSTANTS.ERROR_CONNECTION)
        else:
          if self.localConnection != None:
            if isHelpArg == False and self.pargs.task == None:
              self.fillError(CONSTANTS.ERROR_STR1, CONSTANTS.ERROR_ARGS1)
            elif self.pargs.task != None:
              if self.pargs.task in CONSTANTS.TASKS:
                if self.pargs.file != None:
                  try:
                    eventObj = self.taskProcessingDeserialize(self.pargs.task, self.pargs.file, self.pargs.id)
                  except IOError:
                    self.fillError(CONSTANTS.ERROR_STR4, CONSTANTS.ERROR_BAD_FILE_NAME)
                  except ValueError:
                    self.fillError(CONSTANTS.ERROR_STR5, CONSTANTS.ERROR_BAD_JSON)
                  except Exceptions.DeserilizeException as excp:
                    self.fillError(CONSTANTS.ERROR_STR6.format(excp.message), CONSTANTS.ERROR_DTMC)
                  if eventObj != None:
                    retEventObj = self.transportCommunications(self.pargs.task, eventObj)
                    if retEventObj != None:
                      try:
                        jsonBuf = self.taskProcessingSerialize(self.pargs.task, retEventObj)
                      except Exceptions.WrongEventObjectTypeException as excp:
                        self.fillError(excp.message, CONSTANTS.ERROR_WRONG_RESPONSE)
                else:
                  self.fillError(CONSTANTS.ERROR_STR2, CONSTANTS.ERROR_ARGS2)
              else:
                self.fillError(CONSTANTS.ERROR_STR3, CONSTANTS.ERROR_BAD_TASK)
          else:
            self.fillError(CONSTANTS.ERROR_STR12, CONSTANTS.ERROR_CONNECTION)
    else:
      self.fillError(CONSTANTS.ERROR_STR9, CONSTANTS.ERROR_NO_CONFIG, False)

    if jsonBuf == None:
      jsonBuf = self.generateEmptyResponse(self.pargs.task)
    sys.stdout.write(jsonBuf)
    # Finish logging
    logger.info(APP_CONSTS.LOGGER_DELIMITER_LINE)

Here is the call graph for this function:

setup()

def dtmc.DTMC.DTMC.setup

(

self

)

setup method Method calls before run application

Definition at line 272 of file DTMC.py.

  def setup(self):
    foundation.CementApp.setup(self)

taskProcessingDeserialize()

def dtmc.DTMC.DTMC.taskProcessingDeserialize	(		self,
			task,
			fileName,
			task_id
	)

taskProcessingDeserialize method Reads task from file and deserializes it.

task - task arg fileName - json filename task_id - task id, seeetd by args

Definition at line 90 of file DTMC.py.

  def taskProcessingDeserialize(self, task, fileName, task_id):
    ffile = open(fileName, "r")    data = ffile.read()
    ffile.close()
    jsonData = json.loads(data)
    self.dTMCObjectsSerializator = DTMCObjectsSerializator()
    eventObj = None
    if task == CONSTANTS.TASKS[0]:
      eventObj = self.dTMCObjectsSerializator.newDeserialize(jsonData)
      if task_id != None:
        eventObj.id = task_id
    elif task == CONSTANTS.TASKS[1]:
      eventObj = self.dTMCObjectsSerializator.checkDeserialize(jsonData)
    elif task == CONSTANTS.TASKS[2]:
      eventObj = self.dTMCObjectsSerializator.terminateDeserialize(jsonData)
    elif task == CONSTANTS.TASKS[3]:
      eventObj = self.dTMCObjectsSerializator.getDeserialize(jsonData)
    elif task == CONSTANTS.TASKS[4]:
      eventObj = self.dTMCObjectsSerializator.statusDeserialize(jsonData)
    elif task == CONSTANTS.TASKS[5]:
      eventObj = self.dTMCObjectsSerializator.cleanupDeserialize(jsonData)
    elif task == CONSTANTS.TASKS[6]:
      eventObj = self.dTMCObjectsSerializator.getTasksDeserialize(jsonData)
    return eventObj

taskProcessingSerialize()

def dtmc.DTMC.DTMC.taskProcessingSerialize	(		self,
			task,
			eventObj
	)

taskProcessingDeserialize method Method serializes incoming task to the JSON string task - task arg eventObj - response event object

Definition at line 155 of file DTMC.py.

  def taskProcessingSerialize(self, task, eventObj):
    jsonString = None
    eventObjClassName = eventObj.__class__.__name__
    if task == CONSTANTS.TASKS[0]:
      if eventObjClassName != dtm.EventObjects.GeneralResponse().__class__.__name__:
        raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task, "GeneralResponse"))
    elif task == CONSTANTS.TASKS[1]:
      if eventObjClassName != dtm.EventObjects.EEResponseData(0).__class__.__name__:
        raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task, "EEResponseData"))
    elif task == CONSTANTS.TASKS[2]:
      if eventObjClassName != dtm.EventObjects.GeneralResponse().__class__.__name__:
        raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task, "GeneralResponse"))
    elif task == CONSTANTS.TASKS[3]:
      if eventObjClassName != dtm.EventObjects.EEResponseData(0).__class__.__name__:
        raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task, "EEResponseData"))
    elif task == CONSTANTS.TASKS[4]:
      if eventObjClassName != [].__class__.__name__:
        raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task, "list[]"))
      i = 0
      for listElement in eventObj:
        i += 1
        eventObjClassName = listElement.__class__.__name__
        #TODO: replace with isinstance() usage
        if eventObjClassName != dtm.EventObjects.TaskManagerFields(0).__class__.__name__:
          raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task,
                              "list(TaskManagerFields)[" + str(i) + "]"))
    elif task == CONSTANTS.TASKS[5]:
      if eventObjClassName != dtm.EventObjects.GeneralResponse().__class__.__name__:
        raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task, "GeneralResponse"))
    elif task == CONSTANTS.TASKS[6]:
      if eventObjClassName != dtm.EventObjects.AvailableTaskIds(0).__class__.__name__:
        raise Exceptions.WrongEventObjectTypeException(CONSTANTS.ERROR_STR8.format(task, "AvailableTaskIds"))
    if type(eventObj) == type([]):
      jsonString = json.dumps(eventObj, default=JsonSerializable.json_serial, sort_keys=True, indent=4)
    else:
      try:
        jsonString = eventObj.toJSON()
      except UnicodeDecodeError, err:
        ExceptionLog.handler(logger, err, "<-------------- DECODE Error ---------------->", (eventObj))

    return jsonString

Here is the caller graph for this function:

transportCommunications()

def dtmc.DTMC.DTMC.transportCommunications	(		self,
			task,
			eventObj
	)

taskProcessingDeserialize method Method serializes incoming task to the JSON string task - task arg eventObj - response event object

Definition at line 202 of file DTMC.py.

  def transportCommunications(self, task, eventObj):
    timeout = None
    retEvent = None
    ret = None
    try:
      timeout = self.config.get(CONSTANTS.APP_NAME, CONSTANTS.TCP_TIMEOUT_CONFIG_NAME)
    except ConfigParser.NoSectionError:
      timeout = CONSTANTS.TCP_TIMEOUT
    except ConfigParser.NoOptionError:
      timeout = CONSTANTS.TCP_TIMEOUT
    eventType = None
    if task == CONSTANTS.TASKS[0]:
      eventType = EVENT_TYPES.NEW_TASK
    elif task == CONSTANTS.TASKS[1]:
      eventType = EVENT_TYPES.CHECK_TASK_STATE
    elif task == CONSTANTS.TASKS[2]:
      eventType = EVENT_TYPES.DELETE_TASK
    elif task == CONSTANTS.TASKS[3]:
      eventType = EVENT_TYPES.FETCH_TASK_RESULTS
    elif task == CONSTANTS.TASKS[4]:
      eventType = EVENT_TYPES.GET_TASK_STATUS
    elif task == CONSTANTS.TASKS[5]:
      eventType = EVENT_TYPES.DELETE_TASK_RESULTS
    elif task == CONSTANTS.TASKS[6]:
      eventType = EVENT_TYPES.FETCH_AVAILABLE_TASK_IDS
    event = self.eventBuilder.build(eventType, eventObj)
    self.localConnection.send(event)

    if self.localConnection.poll(timeout) == 0:
      self.fillError(CONSTANTS.ERROR_STR7.format(str(timeout)), CONSTANTS.ERROR_NETWORK)
    else:
      retEvent = self.localConnection.recv()
    if retEvent != None:
      ret = retEvent.eventObj
    return ret

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

config

dtmc.DTMC.DTMC.config

Definition at line 49 of file DTMC.py.

connectionBuilder

dtmc.DTMC.DTMC.connectionBuilder

Definition at line 50 of file DTMC.py.

dTMCObjectsSerializator

dtmc.DTMC.DTMC.dTMCObjectsSerializator

Definition at line 53 of file DTMC.py.

errorCode

dtmc.DTMC.DTMC.errorCode

Definition at line 54 of file DTMC.py.

errorStr

dtmc.DTMC.DTMC.errorStr

Definition at line 55 of file DTMC.py.

eventBuilder

dtmc.DTMC.DTMC.eventBuilder

Definition at line 52 of file DTMC.py.

label

dtmc.DTMC.DTMC.label = CONSTANTS.APP_NAME

static

Definition at line 42 of file DTMC.py.

localConnection

dtmc.DTMC.DTMC.localConnection

Definition at line 51 of file DTMC.py.

---

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

• sources/hce/dtmc/DTMC.py

• dtmc
• DTMC
• DTMC
• Generated on Fri Nov 24 2017 18:55:01 for HCE Project Python language Distributed Tasks Manager Application, Distributed Crawler Application and client API bindings. by 1.8.13