cBench Python package

Submodules

cbench.client module

class cbench.client.ThreadedHTTPServer(server_address, RequestHandlerClass, bind_and_activate=True)

Bases: socketserver.ThreadingMixIn, http.server.HTTPServer

cbench.client.process_web_request(i)

Input: {

http - Python http object

}

Output: { None }

cbench.client.process_web_request_post_via_tunnel(i)

class cbench.client.server_handler(request, client_address, server)

Bases: http.server.BaseHTTPRequestHandler

Input: Python http handler Output: None

do_GET()

do_POST()

log_error(format, *args)

Log an error.

This is called when a request cannot be fulfilled. By default it passes the message on to log_message().

Arguments are the same as for log_message().

XXX This should go to the separate error log.

log_request(code='-', size='-')

Log an accepted request.

This is called by send_response().

cbench.client.start(i)

cbench.client.web_err(i)

Input: {

http - http object type - content type bin - bytes to output

}

Output: {

return - 0

}

cbench.client.web_out(i)

Input: {

http - http object type - content type bin - bytes to output (filename) - if !=’’, substitute filename in headers

}

Output: {

return - 0

}

cbench.comm module

cbench.comm.access(i)

Input: {

(filename) [str] - load JSON from this file

or

(json) [str] - parse JSON string from command line (use ‘ instead of “)

or

(dict) [dict] - dictionary to send to the cK API

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.comm.download_file(i)

Input: {

url [str] - full URL for a file to download file [dict] - file to save

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

file_size - size of retreived file

}

cbench.comm.send(i)

Input: {

action [str] - remote API action name config [dict] - configuration for remote server dict [dict] - dict to send to remote server ownership [dict] - info about user ownership

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.comm_min module

cbench.comm_min.send(i)

Input: {

action [str] - remote API action name url [str] - URL dict [dict] - dict to send to remote server

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.config module

cbench.config.get_work_dir(i)

Input: {

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

path [str] - path to work dir

}

cbench.config.load(i)

Input: {

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

dict [dict] - configuration dictionary path [str] - path to CK cfg entry

}

cbench.config.update(i)

Input: {

(force) [bool] - if True, force update

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.graph module

cbench.graph.init(i)

Input: {

uid [str] - graph identifyer (version) [str] - graph version (desc_file) [str] - file with graph description (tags) [str] - tags separated by comma

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

dict [dict] - configuration dictionary path [str] - path to CK cfg entry

}

cbench.graph.push(i)

Input: {

uid [str] - graph identifyer (version) [str] - graph version (filename) [str] - JSON file with results (json) [str] - JSON string from command line (use ‘ instead of “) (point) [str] - specific point name to add/update

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

dict [dict] - configuration dictionary path [str] - path to CK cfg entry

}

cbench.main module

cbench.main.process_error(r)

cbench.obj module

cbench.obj.delete(i)

Input: {

cid [str] - CK CID of format (repo UOA:)module UOA:data UOA

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.obj.download(i)

Input: {

components - pre-loaded components from bootstrapping

or

cid [str] - CK CID of format (repo UOA:)module UOA:data UOA

(can use wildcards)

(version) [str] - assign version (force) [bool] - if True, force download even if components already exists

(tags) [str] - can search by tags (usually soft/package)

(all) [bool] - if True, download dependencies (without force!)

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.obj.open_page(i)

Input: {

cid [str] - CK CID of format (repo UOA:)module UOA:data UOA

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.obj.publish(i)

Input: {

cid [str] - CK CID of format (repo UOA:)module UOA:data UOA

(can use wildcards)

(tags) [str] - search multiple CK components by these tags separated by comma (version) [str] - assign version

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.obj.versions(i)

Input: {

cid [str] - CK CID of format (repo UOA:)module UOA:data UOA

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.setup module

cbench.setup.login(i)

Input: {

(username) [str] (api_key) [str] (server_url) [str] (server_user) [str] (server_pass) [str] (server_skip_validation) [str]

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.setup.setup(i)

Input: {

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution module

cbench.solution.activate(i)

Input: {

uid [str] - portal identifier of the solution

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution.benchmark(i)

Input: {

uid [str] - Portal identifier of the solution

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution.deps_summary(i)

Input: {

deps - resolved deps

}

Output: {

return - return code = 0, if successful

> 0, if error

(error) - error text if return > 0

deps_summary - summary of deps

}

cbench.solution.find(i)

Input: {

uid [str] - Portal identifier of the solution

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution.get_platform_desc(i)

cbench.solution.get_solution_dir(i)

cbench.solution.init(i)

Input: {

uid [str] - platform identifier of the solution

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution.ls(i)

Input: {

(uid) [str] - portal identifier of the solution (can have wiledcards)

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution.publish_result(i)

Input: {

uid [str] - portal identifier of the solution

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution.rm(i)

Input: {

uid [str] - Portal identifier of the solution

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

cbench.solution.run(i)

Input: {

uid [str] - Portal identifier of the solution

}

Output: {

return [int] - return code = 0 if success or >0 if error (error) [str] - error string if return>0

}

Module contents