josh/django-language-server
1
0
Fork 0
mirror of https://github.com/joshuadavidthomas/django-language-server.git synced 2025-09-26 20:09:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Create djls-dev crate and centralize Python linking build scripts (#119)

Browse source
This commit is contained in:
Josh Thomas 2025-04-30 12:59:04 -05:00 • committed by GitHub
parent c09d6541ba
commit 7eb9580750
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 66 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -28,6 +28,7 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
- **Internal**: Moved task queueing functionality to `djls-server` crate, renamed from `Worker` to `Queue`, and simplified API.
- **Internal**: Improved Python environment handling, including refactored activation logic.
- **Internal**: Centralized Python linking build logic into a shared `djls-dev` crate to reduce duplication.
## [5.2.0a0]

1
Cargo.toml
View file

@ -5,6 +5,7 @@ resolver = "2"
[workspace.dependencies]
djls = { path = "crates/djls" }
djls-conf = { path = "crates/djls-conf" }
djls-dev = { path = "crates/djls-dev" }
djls-project = { path = "crates/djls-project" }
djls-server = { path = "crates/djls-server" }
djls-templates = { path = "crates/djls-templates" }

8
crates/djls-dev/Cargo.toml Normal file
View file

@ -0,0 +1,8 @@
[package]
name = "djls-dev"
version = "0.1.0"
edition = "2021"
publish = false
[dependencies]
pyo3-build-config = { workspace = true, features = ["resolve-config"] }

47
crates/djls-dev/src/build.rs Normal file
View file

@ -0,0 +1,47 @@
/// Sets up the necessary Cargo directives for linking against the Python library.
///
/// This function should be called from the `build.rs` script of any crate
/// within the workspace whose compiled artifact (e.g., test executable, binary)
/// needs to link against the Python C API at compile time and find the
/// corresponding shared library at runtime. This is typically required for
/// crates using `pyo3` features like `Python::with_gil` or defining `#[pyfunction]`s
/// directly in their test or binary code.
///
/// It uses `pyo3-build-config` to detect the active Python installation and
/// prints the required `cargo:rustc-link-search` and `cargo:rustc-link-lib`
/// directives to Cargo, enabling the linker to find and link against the
/// appropriate Python library (e.g., libpythonX.Y.so).
///
/// It also adds an RPATH linker argument on Unix-like systems (`-Wl,-rpath,...`)
/// to help the resulting executable find the Python shared library at runtime
/// without needing manual `LD_LIBRARY_PATH` adjustments in typical scenarios.
pub fn setup_python_linking() {
// Instruct Cargo to rerun the calling build script if the Python config changes.
// Using PYO3_CONFIG_FILE is a reliable way to detect changes in the active Python env.
println!("cargo:rerun-if-changed=build.rs");
// Set up #[cfg] flags first (useful for conditional compilation)
pyo3_build_config::use_pyo3_cfgs();
// Get the Python interpreter configuration directly
let config = pyo3_build_config::get();
// Add the library search path if available
if let Some(lib_dir) = &config.lib_dir {
println!("cargo:rustc-link-search=native={}", lib_dir);
// Add RPATH linker argument for Unix-like systems (Linux, macOS)
// This helps the test executable find the Python library at runtime.
#[cfg(not(windows))]
println!("cargo:rustc-link-arg=-Wl,-rpath,{}", lib_dir);
} else {
println!("cargo:warning=Python library directory not found in config.");
}
// Add the library link directive if available
if let Some(lib_name) = &config.lib_name {
println!("cargo:rustc-link-lib=dylib={}", lib_name);
} else {
println!("cargo:warning=Python library name not found in config.");
}
}

3
crates/djls-dev/src/lib.rs Normal file
View file

@ -0,0 +1,3 @@
mod build;
pub use build::setup_python_linking;

2
crates/djls-project/Cargo.toml
View file

@ -10,7 +10,7 @@ tower-lsp-server = { workspace = true, features = ["proposed"] }
which = "7.0.1"
[build-dependencies]
pyo3-build-config = { workspace = true, features = ["resolve-config"] }
djls-dev = { workspace = true }
[dev-dependencies]
tempfile = { workspace = true }

44
crates/djls-project/build.rs
View file

@ -1,45 +1,3 @@
/// Build script to configure linking against the Python library.
///
/// This script is necessary when the crate's code, particularly tests
/// that interact with the Python interpreter via `pyo3` (e.g., using
/// `Python::with_gil`, importing modules, calling Python functions),
/// needs symbols from the Python C API at link time.
///
/// It uses `pyo3-build-config` to detect the Python installation and
/// prints the required `cargo:rustc-link-search` and `cargo:rustc-link-lib`
/// directives to Cargo, enabling the linker to find and link against the
/// appropriate Python library (e.g., libpythonX.Y.so).
///
/// It also adds an RPATH linker argument on Unix-like systems so the
/// resulting test executable can find the Python library at runtime.
///
/// Note: Each crate whose test target requires Python linking needs its
/// own `build.rs` with this logic.
fn main() {
println!("cargo:rerun-if-changed=build.rs");
// Set up #[cfg] flags first (useful for conditional compilation)
pyo3_build_config::use_pyo3_cfgs();
// Get the Python interpreter configuration directly
let config = pyo3_build_config::get();
// Add the library search path if available
if let Some(lib_dir) = &config.lib_dir {
println!("cargo:rustc-link-search=native={}", lib_dir);
// Add RPATH linker argument for Unix-like systems (Linux, macOS)
// This helps the test executable find the Python library at runtime.
#[cfg(not(windows))]
println!("cargo:rustc-link-arg=-Wl,-rpath,{}", lib_dir);
} else {
println!("cargo:warning=Python library directory not found in config.");
}
// Add the library link directive if available
if let Some(lib_name) = &config.lib_name {
println!("cargo:rustc-link-lib=dylib={}", lib_name);
} else {
println!("cargo:warning=Python library name not found in config.");
}
djls_dev::setup_python_linking();
}

2
crates/djls-server/Cargo.toml
View file

@ -18,4 +18,4 @@ tower-lsp-server = { workspace = true }
percent-encoding = "2.3"
[build-dependencies]
pyo3-build-config = { workspace = true, features = ["resolve-config"] }
djls-dev = { workspace = true }

44
crates/djls-server/build.rs
View file

@ -1,45 +1,3 @@
/// Build script to configure linking against the Python library.
///
/// This script is necessary when the crate's code, particularly tests
/// that interact with the Python interpreter via `pyo3` (e.g., using
/// `Python::with_gil`, importing modules, calling Python functions),
/// needs symbols from the Python C API at link time.
///
/// It uses `pyo3-build-config` to detect the Python installation and
/// prints the required `cargo:rustc-link-search` and `cargo:rustc-link-lib`
/// directives to Cargo, enabling the linker to find and link against the
/// appropriate Python library (e.g., libpythonX.Y.so).
///
/// It also adds an RPATH linker argument on Unix-like systems so the
/// resulting test executable can find the Python library at runtime.
///
/// Note: Each crate whose test target requires Python linking needs its
/// own `build.rs` with this logic.
fn main() {
println!("cargo:rerun-if-changed=build.rs");
// Set up #[cfg] flags first (useful for conditional compilation)
pyo3_build_config::use_pyo3_cfgs();
// Get the Python interpreter configuration directly
let config = pyo3_build_config::get();
// Add the library search path if available
if let Some(lib_dir) = &config.lib_dir {
println!("cargo:rustc-link-search=native={}", lib_dir);
// Add RPATH linker argument for Unix-like systems (Linux, macOS)
// This helps the test executable find the Python library at runtime.
#[cfg(not(windows))]
println!("cargo:rustc-link-arg=-Wl,-rpath,{}", lib_dir);
} else {
println!("cargo:warning=Python library directory not found in config.");
}
// Add the library link directive if available
if let Some(lib_name) = &config.lib_name {
println!("cargo:rustc-link-lib=dylib={}", lib_name);
} else {
println!("cargo:warning=Python library name not found in config.");
}
djls_dev::setup_python_linking();
}

2
crates/djls/Cargo.toml
View file

@ -20,4 +20,4 @@ tower-lsp-server = { workspace = true }
clap = { version = "4.5", features = ["derive"] }
[build-dependencies]
pyo3-build-config = { workspace = true, features = ["resolve-config"] }
djls-dev = { workspace = true }

44
crates/djls/build.rs
View file

@ -1,45 +1,3 @@
/// Build script to configure linking against the Python library.
///
/// This script is necessary when the crate's code, particularly tests
/// that interact with the Python interpreter via `pyo3` (e.g., using
/// `Python::with_gil`, importing modules, calling Python functions),
/// needs symbols from the Python C API at link time.
///
/// It uses `pyo3-build-config` to detect the Python installation and
/// prints the required `cargo:rustc-link-search` and `cargo:rustc-link-lib`
/// directives to Cargo, enabling the linker to find and link against the
/// appropriate Python library (e.g., libpythonX.Y.so).
///
/// It also adds an RPATH linker argument on Unix-like systems so the
/// resulting test executable can find the Python library at runtime.
///
/// Note: Each crate whose test target requires Python linking needs its
/// own `build.rs` with this logic.
fn main() {
println!("cargo:rerun-if-changed=build.rs");
// Set up #[cfg] flags first (useful for conditional compilation)
pyo3_build_config::use_pyo3_cfgs();
// Get the Python interpreter configuration directly
let config = pyo3_build_config::get();
// Add the library search path if available
if let Some(lib_dir) = &config.lib_dir {
println!("cargo:rustc-link-search=native={}", lib_dir);
// Add RPATH linker argument for Unix-like systems (Linux, macOS)
// This helps the test executable find the Python library at runtime.
#[cfg(not(windows))]
println!("cargo:rustc-link-arg=-Wl,-rpath,{}", lib_dir);
} else {
println!("cargo:warning=Python library directory not found in config.");
}
// Add the library link directive if available
if let Some(lib_name) = &config.lib_name {
println!("cargo:rustc-link-lib=dylib={}", lib_name);
} else {
println!("cargo:warning=Python library name not found in config.");
}
djls_dev::setup_python_linking();
}