https://github.com/scalapy/python-native-libs
Helpers for setting up an embedded Python interpreter
https://github.com/scalapy/python-native-libs
embedded python scala
Last synced: 6 months ago
JSON representation
Helpers for setting up an embedded Python interpreter
- Host: GitHub
- URL: https://github.com/scalapy/python-native-libs
- Owner: scalapy
- License: bsd-3-clause
- Created: 2021-06-10T08:57:58.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-10-31T10:40:07.000Z (9 months ago)
- Last Synced: 2025-10-31T12:20:05.411Z (9 months ago)
- Topics: embedded, python, scala
- Language: Scala
- Homepage:
- Size: 74.2 KB
- Stars: 19
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-native-libs
Helpers for setting up an embedded Python interpreter
[](https://maven-badges.herokuapp.com/maven-central/ai.kien/python-native-libs_2.13)
## Overview
The canonical use case is to help set up [`ScalaPy`](https://scalapy.dev/) to point to a specific Python installation by attempting to infer the correct configuration properties used by `ScalaPy` during the initialization of the embedded Python interpreter. This could potentially see usage outside of `ScalaPy` too since these properties are relevant to embedded Python in general.
## Usage
By default `Python` checks for the `python3` executable (or `python` if `python3` is not found) on `PATH`
```scala
import ai.kien.python.Python
val python = Python()
// python: Python = ai.kien.python.Python@5eb35f5d
python.nativeLibrary
// res0: util.Try[String] = Success(value = "python3.9")
python.nativeLibraryPaths
// res1: util.Try[Seq[String]] = Success(
// value = ArraySeq(
// "/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib/python3.9/config-3.9-darwin",
// "/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib"
// )
// )
python.scalapyProperties
// res2: util.Try[Map[String, String]] = Success(
// value = Map(
// "jna.library.path" -> "/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib/python3.9/config-3.9-darwin:/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib",
// "scalapy.python.library" -> "python3.9",
// "scalapy.python.programname" -> "/usr/local/opt/python@3.9/bin/python3.9"
// )
// )
python.ldflags
// res3: util.Try[Seq[String]] = Success(
// value = ArraySeq(
// "-L/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib/python3.9/config-3.9-darwin",
// "-L/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib",
// "-lpython3.9",
// "-ldl",
// "-framework",
// "CoreFoundation"
// )
// )
```
You can point it towards a specific Python installation by passing the path to the interpreter executable to `Python`
```scala
val python = Python("/usr/bin/python3")
// python: Python = ai.kien.python.Python@eb0b5d0
python.nativeLibrary
// res4: util.Try[String] = Success(value = "python3.9")
python.nativeLibraryPaths
// res5: util.Try[Seq[String]] = Success(
// value = ArraySeq(
// "/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib/python3.9/config-3.9-darwin",
// "/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib"
// )
// )
python.scalapyProperties
// res6: util.Try[Map[String, String]] = Success(
// value = Map(
// "jna.library.path" -> "/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib/python3.9/config-3.9-darwin:/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib",
// "scalapy.python.library" -> "python3.9",
// "scalapy.python.programname" -> "/usr/local/opt/python@3.9/bin/python3.9"
// )
// )
python.ldflags
// res7: util.Try[Seq[String]] = Success(
// value = ArraySeq(
// "-L/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib/python3.9/config-3.9-darwin",
// "-L/usr/local/opt/python@3.9/Frameworks/Python.framework/Versions/3.9/lib",
// "-lpython3.9",
// "-ldl",
// "-framework",
// "CoreFoundation"
// )
// )
```
See `docs/details.md` to see the full list of these properties and what they mean.
`scalapyProperties` contains the system properties used by `ScalaPy`. For example, to set up `ScalaPy` to use the Python located at `/usr/bin/python3` in [`Ammonite`](https://ammonite.io/) or [`Almond`](https://almond.sh/) run
```scala
import $ivy.`ai.kien::python-native-libs:`
import $ivy.`me.shadaj::scalapy-core:`
import ai.kien.python.Python
Python("/usr/bin/python3").scalapyProperties.fold(
ex => println(s"Error while getting ScalaPy properties: $ex"),
props => props.foreach { case(k, v) => System.setProperty(k, v) }
)
import me.shadaj.scalapy.py
println(py.module("sys").version)
```