use anyhow::{Context, Result};
use std::path::{Path, PathBuf};
use std::process::Command;
use crate::config::{PipConfig, output_config_hash, resolve_extra_inputs};
use crate::file_index::FileIndex;
use crate::graph::{BuildGraph, Product};
use crate::processors::{ProcessorBase, Processor, scan_root_valid, run_in_anchor_dir, anchor_display_dir, check_command_output};
pub struct PipProcessor {
base: ProcessorBase,
config: PipConfig,
}
impl PipProcessor {
pub fn new(config: PipConfig) -> Self {
Self {
base: ProcessorBase::creator(
crate::processors::names::PIP,
"Install Python dependencies using pip",
),
config,
}
}
fn execute_pip(&self, ctx: &crate::build_context::BuildContext, requirements_txt: &Path) -> Result<()> {
let mut cmd = Command::new(&self.config.standard.command);
cmd.arg("install");
cmd.arg("-r").arg(requirements_txt.file_name()
.context("requirements.txt path has no filename")?
);
for arg in &self.config.standard.args {
cmd.arg(arg);
}
let output = run_in_anchor_dir(ctx, &mut cmd, requirements_txt)?;
check_command_output(&output, format_args!("pip install in {}", anchor_display_dir(requirements_txt)))
}
}
impl Processor for PipProcessor {
fn scan_config(&self) -> &crate::config::StandardConfig {
&self.config.standard
}
fn description(&self) -> &str {
self.base.description()
}
fn processor_type(&self) -> crate::processors::ProcessorType {
self.base.processor_type()
}
fn auto_detect(&self, file_index: &FileIndex) -> bool {
scan_root_valid(&self.config.standard) && !file_index.scan(&self.config.standard, false).is_empty()
}
fn config_json(&self) -> Option<String> {
serde_json::to_string(&self.config).ok()
}
fn max_jobs(&self) -> Option<usize> {
self.config.standard.max_jobs
}
fn required_tools(&self) -> Vec<String> {
vec![self.config.standard.command.clone(), "python3".to_string()]
}
fn discover(&self, graph: &mut BuildGraph, file_index: &FileIndex, instance_name: &str) -> Result<()> {
if !scan_root_valid(&self.config.standard) {
return Ok(());
}
let files = file_index.scan(&self.config.standard, false);
if files.is_empty() {
return Ok(());
}
let hash = Some(output_config_hash(&self.config, <crate::config::PipConfig as crate::config::KnownFields>::checksum_fields()));
let extra = resolve_extra_inputs(&self.config.standard.dep_inputs)?;
for anchor in files {
let mut inputs: Vec<PathBuf> = Vec::with_capacity(1 + extra.len());
inputs.push(anchor.clone());
inputs.extend_from_slice(&extra);
graph.add_product(inputs, vec![], instance_name, hash.clone())?;
}
Ok(())
}
fn supports_batch(&self) -> bool { false }
fn execute(&self, ctx: &crate::build_context::BuildContext, product: &Product) -> Result<()> {
self.execute_pip(ctx, product.primary_input())
}
}
fn plugin_create(toml: &toml::Value) -> anyhow::Result<Box<dyn crate::processors::Processor>> {
crate::registries::deserialize_and_create(toml, |cfg| Box::new(PipProcessor::new(cfg)))
}
inventory::submit! {
crate::registries::ProcessorPlugin {
version: 1,
name: "pip",
processor_type: crate::processors::ProcessorType::Creator,
create: plugin_create,
defconfig_json: crate::registries::default_config_json::<crate::config::PipConfig>,
known_fields: crate::registries::typed_known_fields::<crate::config::PipConfig>,
checksum_fields: crate::registries::typed_checksum_fields::<crate::config::PipConfig>,
must_fields: crate::registries::typed_must_fields::<crate::config::PipConfig>,
field_descriptions: crate::registries::typed_field_descriptions::<crate::config::PipConfig>,
keywords: &["python", "pip", "package-manager", "py"],
description: "Install Python dependencies using pip",
is_native: false,
can_fix: false,
}
}