HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.utils.utils Namespace Reference

Functions

str CallExternalProcess (cmd)
 Calls an external process and returns stdout as a string.
Application Open (os.PathLike hdbPath)
 Opens a HyperX database for script access.
Generator[Application, None, None] OpenManagedDatabase (os.PathLike hdbPath)
 Opens a HyperX database for script access in with statement context managers.
 OpenWithDefault (str filepath)
 Opens a file in the default application for its file extension.
str RemoveCharacters (str s, str chars)
 Removes a set of characters from a string.
str ScrubFileName (str filename)
 Removes invalid characters from a windows file name.
str WriteCsv (list[list[Any]] data, list[str] headers, str title, str outputDir)
 Write tabular data to a csv file.

Variables

str C :\Dev\HyperX\HyperX\HyperX.Scripting\Python Docs>python custom_filter.py "C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/utils/utils.py"

Function Documentation

◆ CallExternalProcess()

str hyperx.utils.utils.CallExternalProcess ( cmd)

Calls an external process and returns stdout as a string.

◆ Open()

Application hyperx.utils.utils.Open ( os.PathLike hdbPath)

Opens a HyperX database for script access.

◆ OpenManagedDatabase()

Generator[Application, None, None] hyperx.utils.utils.OpenManagedDatabase ( os.PathLike hdbPath)

Opens a HyperX database for script access in with statement context managers.

◆ OpenWithDefault()

hyperx.utils.utils.OpenWithDefault ( str filepath)

Opens a file in the default application for its file extension.

◆ RemoveCharacters()

str hyperx.utils.utils.RemoveCharacters ( str s,
str chars )

Removes a set of characters from a string.

◆ ScrubFileName()

str hyperx.utils.utils.ScrubFileName ( str filename)

Removes invalid characters from a windows file name.

◆ WriteCsv()

str hyperx.utils.utils.WriteCsv ( list[list[Any]] data,
list[str] headers,
str title,
str outputDir )

Write tabular data to a csv file.

Returns the path that the file was written to.

Variable Documentation

◆ C

str hyperx.utils.utils.C :\Dev\HyperX\HyperX\HyperX.Scripting\Python Docs>python custom_filter.py "C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/utils/utils.py"