User functions. More...

Public Member Functions
def	__init__ (self, CFGFILE)

def	get_auth_string (self, with_project=False)

def	set_project (self, new_project)

def	print_credentials (self)

Public Attributes
	project

	username

	password

	CFGFILE

Detailed Description

User functions.

A user in the cloudFPGA world

Definition at line 39 of file cfsp_user.py.

Constructor & Destructor Documentation

◆ init()

def cFSPlib.cfsp_user.cFuser.__init__	(	self,
		CFGFILE
	)

Definition at line 42 of file cfsp_user.py.

     def __init__(self, CFGFILE):
         username, password, project = load_user_credentials(CFGFILE)
         self.project = project
         self.username = username
         self.password = password
         self.CFGFILE = CFGFILE
  
  

Here is the call graph for this function:

Member Function Documentation

◆ get_auth_string()

def cFSPlib.cfsp_user.cFuser.get_auth_string	(	self,
		with_project = `False`
	)

Definition at line 50 of file cfsp_user.py.

     def get_auth_string(self, with_project=False):
         if with_project:
             s = "username={0}&password={1}&project_name={2}".format(self.username, self.password, self.project)
             return requests.utils.requote_uri(s)
         else:
             s = "username={0}&password={1}".format(self.username, self.password)
             return requests.utils.requote_uri(s)
  

◆ print_credentials()

def cFSPlib.cfsp_user.cFuser.print_credentials ( self )

Definition at line 67 of file cfsp_user.py.

     def print_credentials(self):
         print("File     : " + self.CFGFILE)
         print("User     : " + self.username)
         print("Password : " + self.password)
         print("Project  : " + self.project)
  
  
  

◆ set_project()

def cFSPlib.cfsp_user.cFuser.set_project	(	self,
		new_project
	)

This method should be used if the cloudFPGA quota name that should be used for this handle is different from the
default or credentials file
:param new_project:
:return: nothing

Definition at line 58 of file cfsp_user.py.

     def set_project(self, new_project):
         """
         This method should be used if the cloudFPGA quota name that should be used for this handle is different from the
         default or credentials file
         :param new_project:
         :return: nothing
         """
         self.project = new_project
  

Member Data Documentation

◆ CFGFILE

cFSPlib.cfsp_user.cFuser.CFGFILE

Definition at line 47 of file cfsp_user.py.

◆ password

cFSPlib.cfsp_user.cFuser.password

Definition at line 46 of file cfsp_user.py.

◆ project

cFSPlib.cfsp_user.cFuser.project

Definition at line 44 of file cfsp_user.py.

◆ username

cFSPlib.cfsp_user.cFuser.username

Definition at line 45 of file cfsp_user.py.

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

repos_for_Dox/cFSP/cFSPlib/cfsp_user.py

Public Member Functions

Public Attributes