dependency_locator Namespace Reference

Module with functionality for locating the Geometrize executable and other dependencies. More...

Functions
def	_get_geometrize_absolute_path ()
	Gets an absolute path to where we expect to find the Geometrize executable. More...
def	get_geometrize_executable_path ()
	Gets the absolute path to where we expect to find the Geometrize executable. More...
def	geometrize_executable_exists ()
	Checks if the Geometrize executable exists. More...
def	get_geometrize_image_folder_absolute_path ()
	Returns the absolute path the bot image data folder. More...
def	get_geometrize_image_file_absolute_path (filename)
	Composes an absolute path for an image file in the image data folder. More...
def	get_geometrize_script_folder_absolute_path ()
	Gets an absolute path to the bot scripts folder. More...
def	read_script_file (filepath)
	Reads a Chaiscript script file at the given location, returning the text content of the file. More...
def	read_geometrize_script (filename)
	Reads a Chaiscript script file out of the Twitter bot scripts folder, returning the text content of the file. More...

Detailed Description

Module with functionality for locating the Geometrize executable and other dependencies.

Function Documentation

_get_geometrize_absolute_path()

def dependency_locator._get_geometrize_absolute_path ( )

private

Gets an absolute path to where we expect to find the Geometrize executable.

def _get_geometrize_absolute_path():
    baseDir = os.path.normpath(os.path.join(os.path.dirname(__file__), "../geometrize/")).replace('\\', '/')
    
    possibleExecutables = [name for name in os.listdir(baseDir) if re.match(r'[G|g]eometrize.*', name)]
    
    if len(possibleExecutables) > 1:
        print("Warning, found multiple Geometrize executables: " + str(possibleExecutables))
    
    if not possibleExecutables:
        print("Failed to find a path to the Geometrize executable")    
    if platform == "linux" or platform == "linux2" or platform == "darwin" or platform == "win32":
        return baseDir + "/" + possibleExecutables[0]
    else:
        print("Warning, the Geometrize bot might not work on this OS")
        
    return baseDir + "/" + possibleExecutables[0]
        
 

Here is the caller graph for this function:

geometrize_executable_exists()

def dependency_locator.geometrize_executable_exists

(

)

Checks if the Geometrize executable exists.

Returns true if the Geometrize executable exists at the expected location, else false.

def geometrize_executable_exists():
    return os.path.exists(get_geometrize_executable_path())
 

Here is the call graph for this function:

get_geometrize_executable_path()

def dependency_locator.get_geometrize_executable_path

(

)

Gets the absolute path to where we expect to find the Geometrize executable.

def get_geometrize_executable_path():
    return _get_geometrize_absolute_path()
 

Here is the call graph for this function:

Here is the caller graph for this function:

get_geometrize_image_file_absolute_path()

def dependency_locator.get_geometrize_image_file_absolute_path

(

filename

)

Composes an absolute path for an image file in the image data folder.

def get_geometrize_image_file_absolute_path(filename):
    filepath = os.path.normpath(os.path.join(get_geometrize_image_folder_absolute_path(), filename)).replace('\\', '/')
    return filepath
 

Here is the call graph for this function:

Here is the caller graph for this function:

get_geometrize_image_folder_absolute_path()

def dependency_locator.get_geometrize_image_folder_absolute_path

(

)

Returns the absolute path the bot image data folder.

def get_geometrize_image_folder_absolute_path():
    baseDir = os.path.dirname(__file__)
    return os.path.normpath(os.path.join(baseDir, "../image_data/")).replace('\\', '/')
 

Here is the caller graph for this function:

get_geometrize_script_folder_absolute_path()

def dependency_locator.get_geometrize_script_folder_absolute_path

(

)

Gets an absolute path to the bot scripts folder.

def get_geometrize_script_folder_absolute_path():
    baseDir = os.path.dirname(__file__)
    return os.path.normpath(os.path.join(baseDir, "../script/")).replace('\\', '/')
 

Here is the caller graph for this function:

read_geometrize_script()

def dependency_locator.read_geometrize_script

(

filename

)

Reads a Chaiscript script file out of the Twitter bot scripts folder, returning the text content of the file.

:return An empty string if we failed to read the script.

def read_geometrize_script(filename):
    filepath = os.path.normpath(os.path.join(get_geometrize_script_folder_absolute_path(), filename)).replace('\\', '/')
    return read_script_file(filepath)

Here is the call graph for this function:

Here is the caller graph for this function:

read_script_file()

def dependency_locator.read_script_file

(

filepath

)

Reads a Chaiscript script file at the given location, returning the text content of the file.

:return An empty string if we failed to read the script.

def read_script_file(filepath):
    with open(filepath, 'r') as content_file:
        content = content_file.read()
        return content
    
    print("Failed to read Geometrize script at: " + filepath)
    return ""
 

Here is the caller graph for this function: