lwe.core Package

lwe.core Submodules

lwe.core.config module

class lwe.core.config.Config(config_dir=None, data_dir=None, profile='default', config=None, args=None)

Bases: object

property debug

get(keys=None, config=None)

load_from_file(profile=None)

make_profile_dir(base_dir, profile)

property properties

set(keys, value, transform=True)

lwe.core.constants module

lwe.core.doc_parser module

lwe.core.doc_parser.func_to_openai_tool_spec(name, func)

lwe.core.doc_parser.merge_argument_attrs_from_doc(attrs, param_name, parsed_doc)

lwe.core.doc_parser.parse_docstring(docstring: str) → Dict[str, Dict[str, Any]]

lwe.core.doc_parser.parse_rst(text: str) → document

lwe.core.doc_parser.parse_type(type_str: str) → Dict[str, Any]

lwe.core.doc_parser.type_mapping(dtype)

Map a Python data type to a corresponding JSON type string.

Parameters

dtypetype

The Python data type to map (e.g., float, int, str).

Returns

str

The corresponding JSON type string (e.g., ‘number’, ‘integer’, ‘string’).

lwe.core.editor module

lwe.core.editor.discover_editor()

Discovers and returns the appropriate editor command as a list of arguments.

Handles cases where the editor command includes arguments, including quoted arguments with spaces (e.g. ‘vim -c “set noswapfile”’).

Returns:

A list of command parts ready for subprocess execution

Return type:

list[str]

lwe.core.editor.file_editor(filepath)

Opens the specified file in the system’s configured editor.

Parameters:

filepath (str) – Path to the file to edit

lwe.core.editor.get_environment_editor(default=None)

Fetches the preferred editor from the environment variables.

This function checks the following environment variables in order to determine the user’s preferred editor:

• LWE_EDITOR

• VISUAL

• EDITOR

Parameters:

default (str or None) – The default editor to return if no environment variable is set.

Returns:

The preferred editor as specified by environment variables or the default value.

Return type:

str or None

lwe.core.editor.pipe_editor(input_data='', suffix=None)

Opens the system editor with optional input data and returns the edited content.

This function creates a temporary file with the provided input data, opens it in the system editor, waits for the user to make changes and close the editor, then reads and returns the modified content. The temporary file is deleted afterwards.

Parameters:

• input_data (str) – Initial content to populate the editor with

• suffix (str or None) – Optional file extension for the temporary file (e.g. ‘.txt’, ‘.md’)

Returns:

The edited content after the editor is closed

Return type:

str

lwe.core.error module

exception lwe.core.error.NoInputError

Bases: Exception

lwe.core.tool module

class lwe.core.tool.Tool(config)

Bases: object

get_config()

set_filepath(filepath)

set_name(name)

lwe.core.tool_cache module

class lwe.core.tool_cache.ToolCache(config, tool_manager, customizations=None)

Bases: object

Manage tools in a cache.

add(tool_name, raise_on_missing=True)

Add a tool to the cache if valid.

add_customizations_tools()

add_message_tools(messages)

Add any tool calls in messages to cache.

lwe.core.tool_manager module

class lwe.core.tool_manager.ToolManager(config=None, additional_tools=None)

Bases: object

Manage tools.

cleanup_tool_definition(tool)

Remove items that are not needed in the tool definition.

dereference_tool_schema(schema, defs)

get_langchain_tool(tool_name)

get_langchain_tool_spec(tool_name)

get_tool(tool_name)

get_tool_config(tool_name)

is_langchain_tool(tool_name)

is_system_tool(filepath)

load_tool(tool_name)

load_tools()

make_user_tool_dirs()

run_langchain_tool(tool_name, input_data)

run_tool(tool_name, input_data)

setup_tool_instance(tool_name, tool_path)

lwe.core.logger module

class lwe.core.logger.Logger(name, config=None)

Bases: object

lwe.core.monkey_patch module

lwe.core.plugin module

class lwe.core.plugin.Plugin(config=None, cache_manager=None)

Bases: PluginBase, ABC

abstract default_config()

abstract setup()

class lwe.core.plugin.PluginBase(config=None, cache_manager=None)

Bases: object

property description

get_shell_completions(_base_shell_completions)

incompatible_backends()

make_llm(args=None)

property plugin_cache_filename

property plugin_type

query_llm(messages)

set_backend(backend)

set_name(name)

set_shell(shell)

write_plugin_cache_file(data)

lwe.core.plugin_manager module

class lwe.core.plugin_manager.PluginManager(config=None, backend=None, cache_manager=None, search_path=None, additional_plugins=None)

Bases: object

get_default_plugin_paths()

get_plugins()

inject_plugin(plugin_name, plugin_class)

load_package_plugins(plugin_list)

load_plugin(plugin_name)

load_plugins(plugin_list)

merge_plugin_config(plugin_instance)

reload_plugin(plugin_name)

setup_plugin(plugin_name, plugin_instance)

lwe.core.preset_manager module

class lwe.core.preset_manager.PresetManager(config=None, additional_presets=None)

Bases: object

Manage presets.

delete_preset(preset_name, preset_dir=None)

ensure_preset(preset_name)

is_system_preset(filepath)

load_presets()

load_test_preset()

make_user_preset_dirs()

parse_preset_dict(content)

save_preset(preset_name, metadata, customizations, preset_dir=None)

user_metadata_fields()

lwe.core.preset_manager.parse_llm_dict(content)

lwe.core.provider module

class lwe.core.provider.PresetValue(value_type, min_value=None, max_value=None, options=None, include_none=False, private=False)

Bases: object

build_completions()

cast(value)

class lwe.core.provider.Provider(config=None, cache_manager=None)

Bases: ProviderBase

abstract property capabilities

abstract customization_config()

abstract property default_model

abstract llm_factory()

class lwe.core.provider.ProviderBase(config=None, cache_manager=None)

Bases: Plugin

property available_models

calculate_customization_value(orig_keys, new_value)

cast_dict_value(value)

convert_ai_dict_to_message(message: Mapping[str, Any]) → AIMessage

Convert an LWE message dictionary to a LangChain AIMessage.

This default implementation supports a format suitable for OpenAI. Other providers plugins may need to override this method depending on the structure of their AI messages.

convert_dict_to_message(message: Mapping[str, Any]) → BaseMessage

Convert an LWE message dictionary to a LangChain message.

customizations_to_completions()

default_config()

default_customizations(defaults=None)

property display_name

get_capability(capability, default=False)

get_customization_value(keys)

get_customizations(customizations=None)

get_model()

invalid_model_message(model_name)

load_models()

make_llm(customizations=None, tools=None, tool_choice=None, use_defaults=False)

max_submission_tokens()

property model_property_name

property plugin_type

prepare_file_for_llm(file: dict)

prepare_messages_for_llm(messages)

prepare_messages_for_llm_chat(messages)

prepare_messages_for_llm_last_message(messages)

prepare_messages_for_llm_stuff_messages(messages)

prepare_messages_method()

set_customization_value(keys, new_value)

set_customizations(customizations)

set_model(model_name)

set_value(keys, value)

setup()

property static_models

transform_openai_tool_spec_to_json_schema_spec(spec)

transform_tools(tools)

validate_model(model_name)

lwe.core.provider_manager module

class lwe.core.provider_manager.ProviderManager(config, plugin_manager)

Bases: object

full_name(name)

get_provider_from_name(provider_name)

get_provider_plugins()

load_provider(provider_name: str)

lwe.core.repl module

class lwe.core.repl.Repl(config=None)

Bases: object

A shell interpreter that serves as a front end to the backend classes

action_plugin_reload(plugin_name)

action_template_copy(*template_names)

Copies an existing template and saves it as a new template.

Parameters:

template_names (tuple) – The names of the old and new templates.

Returns:

Success status, new file path, and user message.

Return type:

tuple

action_template_delete(template_name)

Deletes an existing template.

Parameters:

template_name (str) – The name of the template to delete.

action_template_edit(template_name)

Create a new template, or edit an existing template.

Parameters:

template_name (str) – The name of the template.

action_template_edit_run(template_name)

Open a template for final editing, then run it.

Parameters:

template_name (str) – The name of the template.

action_template_prompt_edit_run(template_name)

Prompts for a value for each variable in the template, sustitutes the values in the template, opens an editor for final edits, and sends the final content to the model as your input.

Parameters:

template_name (str) – The name of the template.

action_template_prompt_run(template_name)

Prompt for template variable values, then run.

Parameters:

template_name (str) – The name of the template.

action_template_run(template_name)

Run a template.

Parameters:

template_name (str) – The name of the template.

action_template_show(template_name)

Display a template.

Parameters:

template_name (str) – The name of the template.

build_shell_user_prefix()

catch_ctrl_c(signum, _frame)

cleanup()

cmdloop()

collect_template_variable_values(template_name, variables=None)

command_ask(input)

Ask a question

It is purely optional.

Examples:

{COMMAND} what is 6+6 (is the same as ‘what is 6+6’)

command_chat(arg)

Retrieve chat content

Arguments:

history_id: The history ID With no arguments, show content of the current conversation.

Examples:

Current conversation: {COMMAND} Older conversation: {COMMAND} 2

command_config(arg)

Show or edit the current configuration

Examples:

Show all: {COMMAND} Edit config: {COMMAND} edit Show files config: {COMMAND} files Show profile config: {COMMAND} profile Show runtime config: {COMMAND} runtime Show section: {COMMAND} debug

command_copy(_)

Copy last conversation message to clipboard

Examples:

{COMMAND}

command_delete(arg)

Delete one or more conversations

Can delete by conversation ID, history ID, or current conversation.

Arguments:

history_id : The history ID

Arguments can be mixed and matched as in the examples below.

Examples:

Current conversation: {COMMAND} Delete one: {COMMAND} 3 Multiple IDs: {COMMAND} 1,5 Ranges: {COMMAND} 1-5 Complex: {COMMAND} 1,3-5

command_editor(args)

Open an editor for entering a command

When the editor is closed, the content is sent.

Arguments:

default_text: The default text to open the editor with

Examples:

{COMMAND} {COMMAND} some text to start with

command_exit(_)

Exit the shell

Examples:

{COMMAND}

command_file(arg)

Send a prompt read from the named file

Arguments:

file_name: The name of the file to read from

Examples:

{COMMAND} myprompt.txt

command_history(arg)

Show recent conversation history

Arguments;

limit: limit the number of messages to show (default {DEFAULT_HISTORY_LIMIT}) offset: offset the list of messages by this number

Examples:

{COMMAND} {COMMAND} 10 {COMMAND} 10 5

command_log(arg)

Enable/disable logging to a file

Arguments:

file_name: The name of the file to write to

Examples:

Log to file: {COMMAND} mylog.txt Disable logging: {COMMAND}

command_model(arg)

View or set attributes on the current LLM model

Arguments:

path: The attribute path to view or set value: The value to set the attribute to With no arguments, view current set model attributes

Examples:

{COMMAND} {COMMAND} temperature {COMMAND} temperature 1.1

command_new(_)

Start a new conversation

Examples:

{COMMAND}

command_plugin(args)

Perform operations on plugins.

Arguments:

action: The action to perform. One of: reload target: The target for the action.

Examples:

{COMMAND} reload echo {COMMAND} reload provider_chat_openai

command_plugins(arg)

List installed plugins

Plugins are enabled by adding their name to the list of enabled plugins in the profile configuration.

Arguments:

filter_string: Optional. String to filter plugins by. Name and description are matched.

Examples:

{COMMAND} {COMMAND} shell

command_quit(_)

Exit the shell

Examples:

{COMMAND}

command_read(_)

Begin reading multi-line input

Allows for entering more complex multi-line input prior to sending it.

Examples:

{COMMAND}

command_stream(_)

Toggle streaming mode

Streaming mode: streams the raw response (no markdown rendering) Non-streaming mode: Returns full response at completion (markdown rendering supported).

Examples:

{COMMAND}

command_switch(arg)

Switch to chat

Arguments:

history_id: The history ID of the conversation

Examples:

{COMMAND} 2

command_template(args)

Run actions on available templates

Templates are pre-configured text content that can be customized before sending a message to the model.

‘Running’ a template sends its content (after variable substitutions) to the model as your input.

Available actions:

• copy: Copy a template

• delete: Delete a template

• edit: Open or create a template for editing

• edit-run: Open the template in an editor, then run it on editor save and close.

• prompt-edit-run: Collect values for template variables, then open in an editor, then run it on editor save and close

• prompt-run: Collect values for template variables, then run it

• run: Run a template

• show: Show a template

Arguments:

template_name: Required. The name of the template.

For copy, a new template name is also required.

Examples:

• /template copy mytemplate.md mytemplate_copy.md

• /template delete mytemplate.md

• /template edit mytemplate.md

• /template edit-run mytemplate.md

• /template prompt-edit-run mytemplate.md

• /template prompt-run mytemplate.md

• /template run mytemplate.md

• /template show mytemplate.md

command_templates(arg)

List available templates

Templates are pre-configured text content that can be customized before sending a message to the model.

They are located in the ‘templates’ directory in the following locations:

• The main configuration directory

• The profile configuration directory

See {COMMAND_LEADER}config for current locations.

Arguments:

filter_string: Optional. If provided, only templates with a name or description containing the filter string will be shown.

Examples:

{COMMAND} {COMMAND} filterstring

command_title(arg)

Show or set title

Arguments:

title: title of the current conversation …or… history_id: history ID of conversation

Examples:

Get current conversation title: {COMMAND} Set current conversation title: {COMMAND} new title Set conversation title using history ID: {COMMAND} 1

configure_backend()

configure_commands()

configure_plugins()

configure_shell_commands()

default(input, request_overrides=None)

dispatch_command_action(command, args)

doc_header = 'Documented commands type /help [command without /] (e.g. /help ask) for detailed help'

edit_run_template(template_content, suffix='md')

exec_prompt_pre(_command, _arg)

get_command_action_method(command, action)

get_command_actions(command, dashed=False)

get_command_help(command)

get_command_help_brief(command)

get_command_method(command)

get_custom_shell_completions()

get_plugin_commands()

get_plugin_shell_completions(completions)

get_shell_history()

get_shell_method(method_string)

get_styles()

help(command='')

help_commands()

initialize_repl(config=None)

intro = 'Provide a prompt, or type /help or ? to list commands.'

launch_backend(interactive=True)

logfile = None

message_map = {}

prompt = '> '

prompt_number = 0

prompt_prefix = ''

rebuild_completions()

reload_repl()

run_command(command, argument)

run_command_get_response(command, argument)

run_template(template_name, substitutions=None)

set_base_shell_completions()

set_user_prompt(user=None)

setup()

show_backend_config()

show_files_config()

show_full_config()

show_profile_config()

show_runtime_config()

show_section_config(section, section_data)

terminate_stream(_signal, _frame)

lwe.core.template_manager module

class lwe.core.template_manager.TemplateManager(config=None)

Bases: object

Manage templates.

build_message_from_template(template_name, substitutions=None)

Build a message from a given template and substitutions.

Parameters:

• template_name (str) – The name of the template to use.

• substitutions (dict, optional) – The substitutions to apply to the template. Defaults to None.

Returns:

The rendered message and any overrides.

Return type:

tuple

copy_template(old_name, new_name)

Copies a template file to a new location.

Parameters:

• old_name (str) – The name of the existing template file.

• new_name (str) – The name for the new template file.

Returns:

A tuple containing a boolean indicating success or failure, the new file path, and a status message.

Return type:

tuple

ensure_template(template_name)

Checks if a template exists.

Parameters:

template_name (str) – The name of the template to check.

Returns:

A tuple containing a boolean indicating if the template exists, the template name, and a message.

Return type:

tuple

extract_metadata_keys(keys, metadata)

Extracts specified keys from the metadata.

Parameters:

• keys (list) – Keys to be extracted from the metadata.

• metadata (dict) – The metadata from which keys are to be extracted.

Returns:

A tuple containing the updated metadata and the extracted keys.

Return type:

tuple

extract_template_run_overrides(metadata)

Extracts template run overrides from metadata.

Parameters:

metadata (dict) – The metadata from which to extract overrides.

Returns:

A tuple containing the updated metadata and the extracted overrides.

Return type:

tuple

get_raw_template(template_name)

Retrieve the raw source of a template by its name.

Parameters:

template_name (str) – The name of the template to retrieve.

Returns:

A tuple containing a boolean success flag, the raw template source as a string, and a user message.

Return type:

tuple

get_template_and_variables(template_name)

Fetches a template and its variables.

Parameters:

template_name (str) – The name of the template to fetch

Returns:

The fetched template and its variables, or (None, None) if the template is not found

Return type:

tuple

get_template_editable_filepath(template_name)

Get the editable file path for a given template.

Parameters:

template_name (str) – The name of the template

Returns:

A tuple containing a boolean indicating if the template is editable, the file path of the template, and a message

Return type:

tuple

get_template_source(template_name)

Get the source of a specified template.

Parameters:

template_name (str) – The name of the template

Returns:

A tuple containing a boolean indicating success, the source of the template if successful, and a user message

Return type:

tuple

get_template_variables_substitutions(template_name)

Get template variables and their substitutions.

Parameters:

template_name (str) – The name of the template

Returns:

A tuple containing a boolean indicating success, the template with its variables and substitutions, and a user message

Return type:

tuple

is_system_template(filepath)

Check if a file is a system template.

Parameters:

filepath (str) – The path of the file to check

Returns:

True if the file is a system template, False otherwise

Return type:

bool

load_templates()

Load templates from directories.

Returns:

None

make_temp_template(template_contents, suffix='md')

Create a temporary template.

Parameters:

• template_contents (str) – The contents to be written to the temporary template

• suffix (str, optional) – The suffix for the temporary file, defaults to ‘md’

Returns:

The basename and the full path of the temporary template

Return type:

tuple

make_temp_template_dir()

Create directory for temporary templates if it does not exist.

Returns:

None

make_user_template_dirs()

Create directories for user templates if they do not exist.

Returns:

None

process_template_builtin_variables(template_name, variables=None)

Process the built-in variables in a template.

Parameters:

• template_name (str) – The name of the template

• variables (list, optional) – The variables to be processed, defaults to None

Returns:

A dictionary of substitutions for the variables

Return type:

dict

remove_temp_template(template_name)

Remove a temporary template.

Parameters:

template_name (str) – The name of the temporary template

Returns:

None

render_template(template_name)

Render a template with variable substitutions.

Parameters:

template_name (str) – The name of the template to render

Returns:

A tuple containing a success flag, the rendered message or template name, and a user message

Return type:

tuple

template_builtin_variables()

This method returns a dictionary of built-in variables.

Returns:

A dictionary where the key is the variable name and the value is the function associated with it.

Return type:

dict

template_can_delete(template_name)

Checks if a template can be deleted.

Parameters:

template_name (str) – The name of the template to check

Returns:

A tuple containing a boolean indicating if the template can be deleted, the template name or filename, and a message

Return type:

tuple

template_delete(filename)

Deletes a specified template file and reloads the templates.

Parameters:

filename (str) – The name of the file to be deleted.

Returns:

A tuple containing a boolean indicating success, the filename, and a message.

Return type:

tuple

lwe.core.token_manager module

class lwe.core.token_manager.TokenManager(config, provider, model_name, tool_cache)

Bases: object

Manage model tokens.

default_get_num_tokens_from_messages(messages, encoding=None)

Get number of tokens for a list of messages.

The default implementation uses tiktoken, which is the OpenAI implementation.

Parameters:

• messages (list) – List of messages

• encoding (Encoding, optional) – Encoding to use, defaults to None to auto-detect

Returns:

Number of tokens

Return type:

int

get_num_tokens_from_messages(messages, encoding=None)

Get number of tokens for a list of messages.

If a provider does not have a get num_tokens_from_messages() method, default_get_num_tokens_from_messages() will be used.

Parameters:

• messages (list) – List of messages

• encoding (Encoding, optional) – Encoding to use, defaults to None to auto-detect

Returns:

Number of tokens

Return type:

int

get_token_encoding()

Get token encoding for a model.

Raises:

• NotImplementedError – If unsupported model

• Exception – If error getting encoding

Returns:

Encoding object

Return type:

Encoding

lwe.core.util module

class lwe.core.util.NoneAttrs

Bases: object

lwe.core.util.ansible_doc_to_markdown(module_name, full_doc=False)

lwe.core.util.clean_directory(directory)

lwe.core.util.command_with_leader(command)

lwe.core.util.conversation_from_messages(messages)

lwe.core.util.create_file(directory, filename, content=None)

lwe.core.util.current_datetime()

lwe.core.util.dash_to_underscore(text)

lwe.core.util.dict_to_pretty_json(dict_obj)

lwe.core.util.extract_preset_configuration_from_request_overrides(request_overrides, active_preset_name=None)

Extracts preset configuration from the given request overrides.

Parameters:

request_overrides – The request overrides from which to extract preset configuration.

Returns:

A tuple containing a success indicator, preset/preset_overrides/activate_preset configuration, and a user message.

lwe.core.util.filepath_replacements(filepath, config)

lwe.core.util.float_range_to_completions(min_val, max_val)

lwe.core.util.get_ansible_module_doc(module_name)

lwe.core.util.get_class_method(klass, command_command)

lwe.core.util.get_environment_variable(name, default=None)

lwe.core.util.get_environment_variable_list(name)

lwe.core.util.get_file_directory()

lwe.core.util.get_package_root(obj)

lwe.core.util.get_preset_name(preset)

lwe.core.util.introspect_command_actions(klass, command)

lwe.core.util.introspect_commands(klass)

lwe.core.util.is_valid_url(url)

lwe.core.util.list_to_completion_hash(completion_list)

lwe.core.util.list_to_markdown_list(list_obj, indent=2)

lwe.core.util.merge_dicts(dict1, dict2)

lwe.core.util.output_response(response)

lwe.core.util.parse_conversation_ids(id_string)

lwe.core.util.parse_shell_input(user_input)

lwe.core.util.paste_from_clipboard()

lwe.core.util.print_markdown(output, style=None)

lwe.core.util.print_status_message(success, message, style=None)

lwe.core.util.remove_and_create_dir(directory_path)

lwe.core.util.remove_prefix(text, prefix)

lwe.core.util.snake_to_class(string)

lwe.core.util.split_on_delimiter(string, delimiter=',')

lwe.core.util.transform_messages_to_chat_messages(messages)

Transform messages to chat messages.

Parameters:

messages (list) – List of messages

Returns:

List of chat messages

Return type:

list

lwe.core.util.underscore_to_dash(text)

lwe.core.util.validate_float(value, min=None, max=None)

lwe.core.util.validate_int(value, min=None, max=None)

lwe.core.util.validate_str(value, min=None, max=None)

lwe.core.util.write_temp_file(input_data='', suffix=None, prefix=None, dir=None)

lwe.core.workflow_manager module

class lwe.core.workflow_manager.WorkflowManager(config=None)

Bases: object

Manage workflows.

copy_workflow(old_name, new_name)

Copies a workflow file to a new location.

Parameters:

• old_name (str) – The name of the existing workflow file.

• new_name (str) – The name for the new workflow file.

Returns:

A tuple containing a boolean indicating success or failure, the new file path, and a status message.

Return type:

tuple

delete_workflow(workflow_name, workflow_dir=None)

ensure_runnable_workflow(workflow_name)

ensure_workflow(workflow_name)

get_workflow_dir()

get_workflow_environment_config()

is_system_workflow(filepath)

load_workflow(workflow_name)

load_workflows()

make_user_workflow_dirs()

parse_workflow_args(args_string)

run(workflow_name, workflow_args)

set_workflow_environment()

lwe.core Module contents