# adchilds/jythonscript architecture

> Architecture diagram of the GitHub repository adchilds/jythonscript, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/adchilds/jythonscript
- Repository: https://github.com/adchilds/jythonscript

## Overview

JythonScript is a small JVM wrapper for compiling, executing, and evaluating Jython scripts or expressions. The principal workflow starts with a Java caller supplying a script and optional arguments; the wrapper runs it in a Jython interpreter, and evaluation returns the script’s `result` value converted to a Java type. File handling and validation are supporting layers. The excerpts show key calls, but not every overload or conversion detail.

Main entry points: [`src/main/java/com/github/adchilds/jython/JythonScript.java`](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/JythonScript.java) (JythonScript API), [`src/main/java/com/github/adchilds/jython/exception/JythonScriptException.java`](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonScriptException.java) (Script exception), [`src/main/java/com/github/adchilds/jython/exception/JythonScriptNotFoundException.java`](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonScriptNotFoundException.java) (Missing-script exception), [`src/main/java/com/github/adchilds/jython/exception/JythonResultNotFoundException.java`](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonResultNotFoundException.java) (Missing-result exception)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_caller(("Java caller"))
node_jython_api["JythonScript API<br/>[JythonScript.java]"]
node_file_utils["File utilities<br/>[FileUtils.java]"]
node_string_utils["String utilities<br/>[StringUtils.java]"]
node_jython_runtime["Jython interpreter"]
node_script_error["Script exception"]
node_missing_script["Missing-script exception"]
node_missing_result["Missing-result exception"]

node_caller -->|"supplies scripts"| node_jython_api
node_jython_api -->|"opens script files"| node_file_utils
node_jython_api -->|"validates inputs"| node_string_utils
node_jython_api -->|"compiles and runs"| node_jython_runtime
node_jython_api -->|"reports failures"| node_script_error
node_jython_api -->|"reports missing scripts"| node_missing_script
node_jython_api -->|"reports missing results"| node_missing_result
node_missing_script -->|"extends"| node_script_error
node_missing_result -->|"extends"| node_script_error

click node_jython_api "https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/JythonScript.java"
click node_file_utils "https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/util/FileUtils.java"
click node_string_utils "https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/util/StringUtils.java"
click node_script_error "https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonScriptException.java"
click node_missing_script "https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonScriptNotFoundException.java"
click node_missing_result "https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonResultNotFoundException.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_caller,node_jython_runtime toneIndigo
class node_jython_api toneMint
class node_file_utils,node_string_utils,node_script_error,node_missing_script,node_missing_result toneTeal
```

## Components

### Other components

- **Java caller**
- [JythonScript API](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/JythonScript.java): `src/main/java/com/github/adchilds/jython/JythonScript.java`
- [File utilities](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/util/FileUtils.java): `src/main/java/com/github/adchilds/util/FileUtils.java`
- [String utilities](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/util/StringUtils.java): `src/main/java/com/github/adchilds/util/StringUtils.java`
- **Jython interpreter**
- [Script exception](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonScriptException.java): `src/main/java/com/github/adchilds/jython/exception/JythonScriptException.java`
- [Missing-script exception](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonScriptNotFoundException.java): `src/main/java/com/github/adchilds/jython/exception/JythonScriptNotFoundException.java`
- [Missing-result exception](https://github.com/adchilds/jythonscript/blob/develop/src/main/java/com/github/adchilds/jython/exception/JythonResultNotFoundException.java): `src/main/java/com/github/adchilds/jython/exception/JythonResultNotFoundException.java`

## Connections

- Java caller → JythonScript API: supplies scripts (evidence: `README.md`)
- JythonScript API → File utilities: opens script files (evidence: `src/main/java/com/github/adchilds/jython/JythonScript.java`)
- JythonScript API → String utilities: validates inputs (evidence: `src/main/java/com/github/adchilds/jython/JythonScript.java`)
- JythonScript API → Jython interpreter: compiles and runs (evidence: `src/main/java/com/github/adchilds/jython/JythonScript.java`)
- JythonScript API → Script exception: reports failures (evidence: `src/main/java/com/github/adchilds/jython/JythonScript.java`)
- JythonScript API → Missing-script exception: reports missing scripts (evidence: `src/main/java/com/github/adchilds/jython/JythonScript.java`)
- JythonScript API → Missing-result exception: reports missing results (evidence: `src/main/java/com/github/adchilds/jython/JythonScript.java`)
- Missing-script exception → Script exception: extends (evidence: `src/main/java/com/github/adchilds/jython/exception/JythonScriptNotFoundException.java`)
- Missing-result exception → Script exception: extends (evidence: `src/main/java/com/github/adchilds/jython/exception/JythonResultNotFoundException.java`)
