Core

Admin

Admin/utility helper.

7 public methods

Import

from Xenonix.Core import Admin

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

This object does not expose a public Config table.

Public methods

Create

Creates a new Admin instance.

Create(Executable=None, Args=None)

Arguments

Argument Default Accepted values What it does
Executable None Any valid value Executable value used by the operation.
Args None Any valid value Args value used by the operation.

Output

Creates a new Admin object.

Is

Runs the Is operation for Admin.

Is()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Run

Runs the main operation and returns the detected/calculated result.

Run(Executable=None, Args=None, Verb='runAs', Wait=False, Window_Style='Normal', Working_Dir=None)

Arguments

Argument Default Accepted values What it does
Executable None Any valid value Executable value used by the operation.
Args None Any valid value Args value used by the operation.
Verb 'runAs' Any valid value Verb value used by the operation.
Wait False Any valid value Turns wait on or off.
Window_Style 'Normal' Any valid value Window Style value used by the operation.
Working_Dir None Any valid value Working Dir value used by the operation.

Output

Returns success/status or the operation result.

Run_Self

Runs the Run_Self operation for Admin.

Run_Self(Extra_Args=None, Wait=False, Window_Style='Normal', Working_Dir=None)

Arguments

Argument Default Accepted values What it does
Extra_Args None Any valid value Extra Args value used by the operation.
Wait False Any valid value Turns wait on or off.
Window_Style 'Normal' Any valid value Window Style value used by the operation.
Working_Dir None Any valid value Working Dir value used by the operation.

Output

Returns the calculated result.

Run_Command

Runs the Run_Command operation for Admin.

Run_Command(Command_List, Wait=False, Window_Style='Normal', Working_Dir=None)

Arguments

Argument Default Accepted values What it does
Command_List Required Any valid value Command List value used by the operation.
Wait False Any valid value Turns wait on or off.
Window_Style 'Normal' Any valid value Window Style value used by the operation.
Working_Dir None Any valid value Working Dir value used by the operation.

Output

Returns the calculated result.

Run_Python_Script

Runs the Run_Python_Script operation for Admin.

Run_Python_Script(Script_Path, Script_Args=None, Wait=False, Window_Style='Normal', Working_Dir=None, Python_Exe=None)

Arguments

Argument Default Accepted values What it does
Script_Path Required Any valid value Script Path value used by the operation.
Script_Args None Any valid value Script Args value used by the operation.
Wait False Any valid value Turns wait on or off.
Window_Style 'Normal' Any valid value Window Style value used by the operation.
Working_Dir None Any valid value Working Dir value used by the operation.
Python_Exe None Any valid value Python Exe value used by the operation.

Output

Returns the calculated result.

Ensure

Runs the Ensure operation for Admin.

Ensure(Extra_Args=None, Wait=False, Window_Style='Normal', Working_Dir=None, Exit_Code=0)

Arguments

Argument Default Accepted values What it does
Extra_Args None Any valid value Extra Args value used by the operation.
Wait False Any valid value Turns wait on or off.
Window_Style 'Normal' Any valid value Window Style value used by the operation.
Working_Dir None Any valid value Working Dir value used by the operation.
Exit_Code 0 Any valid value Exit Code value used by the operation.

Output

Returns True/False to indicate success.