agi_env API

This is a module share between core/agi-core and gui/agilab to set all the path required by both

Usage Example

Instanciation

from agi_env import AgiEnv

env = AgiEnv('my-code')

# or
path_to_my_code = Path("../../agi/apps/my-code-project/src/my_code/my_code.py")
env = AgiEnv(path_to_my_code)

Reference

class agi_env.agi_env.AgiEnv(install_type=None, apps_dir=None, active_app=None, active_module=None, verbose=0)

Bases: object

AgiEnv manages paths and environment variables within the agiFramework.

class ContentRenamer(rename_map)

Bases: NodeTransformer

A class that renames identifiers in an abstract syntax tree (AST).

rename_map

A mapping of old identifiers to new identifiers.

Type:

dict

__init__(rename_map)

Initialize the ContentRenamer with the rename_map.

Parameters:

rename_map (dict) – Mapping of old names to new names.

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

visit_AnnAssign(node)

Visit and process an AnnAssign node in an abstract syntax tree.

Parameters:

• self – The AST visitor object.

• node – The AnnAssign node to be visited.

Returns:

The visited AnnAssign node.

Return type:

AnnAssign

visit_Assign(node)

Visit and process an assignment node.

Parameters:

• self – The instance of the visitor class.

• node – The assignment node to be visited.

Returns:

The visited assignment node.

Return type:

ast.Node

visit_Attribute(node)

Visit and potentially rename an attribute in a node.

Parameters:

node – A node representing an attribute.

Returns:

The visited node with potential attribute renamed.

Return type:

node

Raises:

None. –

visit_ClassDef(node)

Visit and potentially rename a ClassDef node.

Parameters:

node (ast.ClassDef) – The ClassDef node to visit.

Returns:

The potentially modified ClassDef node.

Return type:

ast.ClassDef

visit_Constant(node)

visit_For(node)

Visit and potentially rename the target variable in a For loop node.

Parameters:

node (ast.For) – The For loop node to visit.

Returns:

The modified For loop node.

Return type:

ast.For

Note

This function may modify the target variable in the For loop node if it exists in the rename map.

visit_FunctionDef(node)

Rename a function node based on a provided mapping.

Parameters:

node (ast.FunctionDef) – The function node to be processed.

Returns:

The function node with potential name change.

Return type:

ast.FunctionDef

visit_Global(node)

Visit and potentially rename global variables in the AST node.

Parameters:

• self – The instance of the class that contains the renaming logic.

• node – The AST node to visit and potentially rename global variables.

Returns:

The modified AST node with global variable names potentially renamed.

Return type:

AST node

visit_Import(node)

Rename imported modules in ‘import module’ statements.

Parameters:

node (ast.Import) – The import node.

visit_ImportFrom(node)

Rename modules and imported names in ‘from module import name’ statements.

Parameters:

node (ast.ImportFrom) – The import from node.

visit_Name(node)

Visit and potentially rename a Name node in the abstract syntax tree.

Parameters:

• self – The current object instance.

• node – The Name node in the abstract syntax tree.

Returns:

The modified Name node after potential renaming.

Return type:

ast.Node

Note

This function modifies the Name node in place.

Raises:

None –

visit_arg(node)

Visit and potentially rename an argument node.

Parameters:

• self – The instance of the class.

• node – The argument node to visit and possibly rename.

Returns:

The modified argument node.

Return type:

ast.AST

Notes

Modifies the argument node in place if its name is found in the rename map.

Raises:

None. –

visit_nonlocal(node)

Visit and potentially rename nonlocal variables in the AST node.

Parameters:

• self – An instance of the class containing the visit_nonlocal method.

• node – The AST node to visit and potentially modify.

Returns:

The modified AST node after visiting and potentially renaming nonlocal variables.

Return type:

ast.AST

exception JumpToMain

Bases: Exception

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(install_type=None, apps_dir=None, active_app=None, active_module=None, verbose=0)

Initialize the AgiEnv instance

parameters: - install_type: 0: end-user, 1: dev, 2: api - apps_dir: path to apps directory - active_app: name or path of the active app - active_module: path of the active module - verbose: verbosity level

active(target, install_type)

app = None

apps_dir = None

ast = <module 'ast' from '/home/jpm/.local/share/uv/python/cpython-3.12.9-linux-x86_64-gnu/lib/python3.12/ast.py'>

astor = <module 'astor' from '/home/jpm/PycharmProjects/agil/.venv/lib/python3.12/site-packages/astor/__init__.py'>

change_active_app(app, install_type)

change_active_module(module_path, install_type)

check_args(target_args_class, target_args)

clone_directory(source_dir, dest_dir, rename_map, spec, source_root)

Recursively clone directories and files from source to destination, applying renaming and respecting .gitignore patterns. Creates a symbolic link for the .venv directory if it’s not ignored.

Parameters:

• source_dir (Path) – Source directory path.

• dest_dir (Path) – Destination directory path.

• rename_map (dict) – Mapping of old relative paths to new relative paths.

• spec (PathSpec) – Compiled PathSpec object to filter files/directories.

• source_root (Path) – The root directory of the source project.

clone_project(target_project, dest_project)

Clone a project by recursively copying files and directories, applying renaming. For the .venv directory, create a symbolic link instead of copying if it’s not ignored.

Parameters:

• target_project (str) – Name of the target project.

• dest_project (str) – Name of the destination project.

create_rename_map(target_project, dest_project)

Create a mapping of old names to new names for renaming during project cloning.

static create_symlink(source, dest)

create_symlink_windows(dest)

Create a symbolic link on Windows, handling permissions and types.

Parameters:

• source (Path) – Source directory path.

• dest (Path) – Destination symlink path.

extract_base_info(base, import_mapping)

Extracts the base class name and attempts to determine the module name from the import mapping. :returns: (base_class_name, module_name) :rtype: Tuple[str, Optional[str]]

get_base_classes(module_path, class_name)

Parses the module at module_path and returns a list of tuples for the base classes of the specified class. Each tuple is (base_class_name, module_name).

get_base_worker_cls(module_path, class_name)

Retrieves the first base class ending with ‘Worker’ from the specified module. Returns a tuple: (base_class_name, module_name)

get_full_attribute_name(node)

Recursively retrieves the full dotted name from an attribute node.

get_import_mapping(source)

Parses the source code and builds a mapping of imported names/aliases to module names.

get_modules(target=None)

get_projects(path)

static get_venv_root()

handle_venv_directory(source_venv, dest_venv)

Create a symbolic link for the .venv directory instead of copying it.

Parameters:

• source_venv (Path) – Source .venv directory path.

• dest_venv (Path) – Destination .venv symbolic link path.

has_admin_rights()

Check if the current process has administrative rights on Windows.

Returns:

True if admin, False otherwise.

Return type:

bool

humanize_validation_errors(error)

init_envars_app(envars)

install_type = None

is_valid_ip(ip)

Return type:

bool

static locate_agi_installation()

static mode2int(mode)

mode2str(mode)

module = None

static normalize_path(path)

static read_gitignore(self, gitignore_path)

Read patterns from a .gitignore file and compile them into a PathSpec.

Parameters:

gitignore_path (Path) – Path to the .gitignore file.

Returns:

Compiled PathSpec object.

Return type:

PathSpec

static run(cmd, venv=None, cwd=None, timeout=None, wait=True, log_callback=None)

async static run_agi_bg(cmd, cwd='.', venv=None, timeout=None, merge_stderr=True)

run_agi_sync(code, log_callback=None, venv=None, type=None)

async static run_async(cmd, venv=None, cwd=None, timeout=None, log_callback=None)

property scheduler_ip_address

set_apps_dir(apps_dir)

set_cluster_credentials(credentials)

Set the AGI_CREDENTIALS environment variable.

set_env_var(key, value)

General setter: Updates the AgiEnv internal environment dictionary, the process environment, and persists the change in the .agilab/.env file.

set_install_type(install_type)

set_openai_api_key(api_key)

Set the OPENAI_API_KEY environment variable.

exception agi_env.agi_env.JumpToMain

Bases: Exception

Custom exception to jump back to the main execution flow.

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.