inspect_environment
Identify Python and Synthesizer environment details—version, installation status, paths, and env vars—to diagnose setup issues without importing Synthesizer.
Instructions
Report Python and Synthesizer environment facts.
Synthesizer is never imported here, so this is cheap and has no side
effects. The price is being honest about what was checked:
synthesizer_installed means only that a module spec with a real
file origin was found. It is not proof that Synthesizer imports, and
a broken C extension, the most common real failure mode for this
package, is invisible to a spec lookup. import_error is
therefore always None here; only :func:inspect_synthesizer_api,
which does import, can populate it.
Returns:
A mapping with python_version, platform,
the executable and environment whose Synthesizer is
being reported on, synthesizer_installed,
synthesizer_version with the version_source that
reported it,
synthesizer_path, import_error (always None) and
synthesizer_env_vars. Synthesizer resolves its directories
as environment variable else platformdirs default, so only the
SYNTHESIZER_* variables that are actually set are reported;
resolving the defaults would mean importing the package.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||