shared Namespace Reference

This file contains non-class functions used by the application. More...

Functions
def	escapeNewlineCharacters
	Escapes characters that represents (e.g.
def	breakLongQString
	Creates new String which has new line character (\n) in every n.
def	reprStartingProcess
	Returns representation of starting python process.
def	removeDir
	Removes directory specified by param.
def	copyDir
	Copies directory to specified location.

---

Detailed Description

This file contains non-class functions used by the application.

LICENSE

Copyright (c) HotFuzz Team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Authors: Stepan Henek (henes5am@gmail.com)

---

Function Documentation

def shared::breakLongQString	(		position,
			origString
	)

Creates new String which has new line character (\n) in every n.

position of original string

Parameters:

	position	index of every position where to insert \n (has to be >0)
	origString	original String

Returns:

modified copy of original QString

def shared::copyDir	(		dirSource,
			dirTarget
	)

Copies directory to specified location.

Parameters:

	dirSource	Path to directory to be copied.
	dirTarget	Path where to copy directory. (Note this path does not have to exist.)

Returns:

True on success, False otherwise

def shared::escapeNewlineCharacters

(

string

)

Escapes characters that represents (e.g.

new line) for better visualization.

("\n\t\f\v\r" -> "\\n\\t\\f\\v\\r")

Note no new String is created.

Parameters:

string

String to be modified.

Returns:

Original modified string.

def shared::removeDir

(

dirPath

)

Removes directory specified by param.

Parameters:

dirPath

Path to directory to be removed.

Returns:

True on success, False otherwise

def shared::reprStartingProcess	(		name,
			params
	)

Returns representation of starting python process.

"Server" , ['c:/process.py', '-u', 'xxx'] -> "Starting Server: python c:/process.py -u xxx"

Parameters:

	name	Representative name of the process. (e.g. Server, Client, ...)
	params	Params of python process. (First param is actually path to python script.)

Returns:

String that represents starting python process.