Работа с переменными окружения
Мы улучшим бинарный файл minigrep, добавив дополнительную возможность: опцию
поиска без учёта регистра, которую пользователь может включить через переменную
окружения. Мы могли бы сделать эту возможность параметром командной строки и требовать,
чтобы пользователи вводили его каждый раз, когда хотят её применить, но, сделав её
переменной окружения, мы позволяем пользователям установить переменную окружения один раз
и чтобы все их поиски в этом сеансе терминала выполнялись без учёта регистра.
Написание падающего теста для поиска без учёта регистра
Сначала добавим новую функцию search_case_insensitive в библиотеку minigrep,
которая будет вызываться, когда переменная окружения имеет значение. Мы продолжим
следовать процессу TDD, поэтому первым шагом снова будет написание падающего теста.
Мы добавим новый тест для новой функции search_case_insensitive и переименуем
наш старый тест из one_result в case_sensitive, чтобы прояснить различия
между двумя тестами, как показано в листинге 12-20.
pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {
let mut results = Vec::new();
for line in contents.lines() {
if line.contains(query) {
results.push(line);
}
}
results
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn case_sensitive() {
let query = "duct";
let contents = "\
Rust:
safe, fast, productive.
Pick three.
Duct tape.";
assert_eq!(vec!["safe, fast, productive."], search(query, contents));
}
#[test]
fn case_insensitive() {
let query = "rUsT";
let contents = "\
Rust:
safe, fast, productive.
Pick three.
Trust me.";
assert_eq!(
vec!["Rust:", "Trust me."],
search_case_insensitive(query, contents)
);
}
}
Обратите внимание, что мы также отредактировали contents старого теста. Мы добавили новую строку
с текстом "Duct tape.", используя заглавную D, которая не должна совпадать с запросом
"duct", когда мы ищем с учётом регистра. Изменение старого теста
таким образом помогает убедиться, что мы случайно не сломаем функциональность поиска с учётом регистра,
которую мы уже реализовали. Этот тест должен пройти сейчас
и должен продолжать проходить по мере нашей работы над поиском без учёта регистра.
Новый тест для поиска без учёта регистра использует "rUsT" в качестве запроса. В
функции search_case_insensitive, которую мы собираемся добавить, запрос "rUsT"
должен совпасть со строкой, содержащей "Rust:" с заглавной R, и совпасть со
строкой "Trust me.", хотя обе имеют другой регистр, чем запрос. Это
наш падающий тест, и он не скомпилируется, потому что мы ещё не определили
функцию search_case_insensitive. Не стесняйтесь добавить скелетную
реализацию, которая всегда возвращает пустой вектор, аналогично тому, как мы делали
для функции search в листинге 12-16, чтобы увидеть, как тест компилируется и падает.
Реализация функции search_case_insensitive
Функция search_case_insensitive, показанная в листинге 12-21, будет почти
такой же, как функция search. Единственное отличие в том, что мы приведём к нижнему регистру
query и каждую line, чтобы независимо от регистра входных аргументов
они были в одном регистре, когда мы проверяем, содержит ли строка запрос.
pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {
let mut results = Vec::new();
for line in contents.lines() {
if line.contains(query) {
results.push(line);
}
}
results
}
pub fn search_case_insensitive<'a>(
query: &str,
contents: &'a str,
) -> Vec<&'a str> {
let query = query.to_lowercase();
let mut results = Vec::new();
for line in contents.lines() {
if line.to_lowercase().contains(&query) {
results.push(line);
}
}
results
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn case_sensitive() {
let query = "duct";
let contents = "\
Rust:
safe, fast, productive.
Pick three.
Duct tape.";
assert_eq!(vec!["safe, fast, productive."], search(query, contents));
}
#[test]
fn case_insensitive() {
let query = "rUsT";
let contents = "\
Rust:
safe, fast, productive.
Pick three.
Trust me.";
assert_eq!(
vec!["Rust:", "Trust me."],
search_case_insensitive(query, contents)
);
}
}
search_case_insensitive для приведения запроса и строки к нижнему регистру перед их сравнениемСначала мы приводим строку query к нижнему регистру и сохраняем её в новую переменную с
тем же именем, затеняя исходный query. Вызов to_lowercase для запроса
необходим, чтобы независимо от того, является ли запрос пользователя "rust", "RUST",
"Rust" или "rUsT", мы обрабатывали запрос так, как если бы он был "rust", и были
нечувствительны к регистру. Хотя to_lowercase обрабатывает базовый Unicode, он
не будет на 100 процентов точным. Если бы мы писали настоящее приложение, мы бы захотели
сделать здесь немного больше работы, но этот раздел о переменных окружения,
а не о Unicode, поэтому мы оставим это здесь.
Обратите внимание, что query теперь является String, а не срезом строки, потому что вызов
to_lowercase создаёт новые данные, а не ссылается на существующие. Скажем,
запрос — "rUsT", например: этот срез строки не содержит строчных
u или t для использования, поэтому мы должны выделить новую String, содержащую
"rust". Когда мы теперь передаём query в качестве аргумента методу contains, нам
нужно добавить амперсанд, потому что сигнатура contains определена как принимающая
срез строки.
Затем мы добавляем вызов to_lowercase для каждой line, чтобы привести к нижнему регистру все
символы. Теперь, когда мы преобразовали line и query к нижнему регистру, мы
найдём совпадения независимо от регистра запроса.
Посмотрим, проходит ли эта реализация тесты:
$ cargo test
Compiling minigrep v0.1.0 (file:///projects/minigrep)
Finished `test` profile [unoptimized + debuginfo] target(s) in 1.33s
Running unittests src/lib.rs (target/debug/deps/minigrep-9cd200e5fac0fc94)
running 2 tests
test tests::case_insensitive ... ok
test tests::case_sensitive ... ok
test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Running unittests src/main.rs (target/debug/deps/minigrep-9cd200e5fac0fc94)
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests minigrep
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Отлично! Они прошли. Теперь вызовем новую функцию search_case_insensitive
из функции run. Сначала добавим опцию конфигурации в структуру Config
для переключения между поиском с учётом регистра и без учёта регистра. Добавление
этого поля вызовет ошибки компиляции, потому что мы пока нигде не инициализируем это поле:
Имя файла: src/main.rs
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
// --snip--
fn main() {
let args: Vec<String> = env::args().collect();
let config = Config::build(&args).unwrap_or_else(|err| {
println!("Problem parsing arguments: {err}");
process::exit(1);
});
if let Err(e) = run(config) {
println!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(args: &[String]) -> Result<Config, &'static str> {
if args.len() < 3 {
return Err("not enough arguments");
}
let query = args[1].clone();
let file_path = args[2].clone();
Ok(Config { query, file_path })
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}
Мы добавили поле ignore_case, которое хранит логическое значение. Далее нам нужно, чтобы функция run
проверяла значение поля ignore_case и использовала его для решения,
вызывать ли функцию search или функцию search_case_insensitive,
как показано в листинге 12-22. Это всё ещё не скомпилируется.
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
// --snip--
fn main() {
let args: Vec<String> = env::args().collect();
let config = Config::build(&args).unwrap_or_else(|err| {
println!("Problem parsing arguments: {err}");
process::exit(1);
});
if let Err(e) = run(config) {
println!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(args: &[String]) -> Result<Config, &'static str> {
if args.len() < 3 {
return Err("not enough arguments");
}
let query = args[1].clone();
let file_path = args[2].clone();
Ok(Config { query, file_path })
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}
search, либо search_case_insensitive в зависимости от значения в config.ignore_caseНаконец, нам нужно проверить переменную окружения. Функции для
работы с переменными окружения находятся в модуле env стандартной
библиотеки, который уже находится в области видимости в начале src/main.rs. Мы будем использовать
функцию var из модуля env, чтобы проверить, установлено ли какое-либо значение
для переменной окружения с именем IGNORE_CASE, как показано в листинге 12-23.
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
fn main() {
let args: Vec<String> = env::args().collect();
let config = Config::build(&args).unwrap_or_else(|err| {
println!("Problem parsing arguments: {err}");
process::exit(1);
});
if let Err(e) = run(config) {
println!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(args: &[String]) -> Result<Config, &'static str> {
if args.len() < 3 {
return Err("not enough arguments");
}
let query = args[1].clone();
let file_path = args[2].clone();
let ignore_case = env::var("IGNORE_CASE").is_ok();
Ok(Config {
query,
file_path,
ignore_case,
})
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}
IGNORE_CASEЗдесь мы создаём новую переменную ignore_case. Чтобы задать её значение, мы вызываем
функцию env::var и передаём ей имя переменной окружения
IGNORE_CASE. Функция env::var возвращает Result, который будет
успешным вариантом Ok, содержащим значение переменной окружения, если
переменная окружения установлена в любое значение. Она вернёт вариант Err
если переменная окружения не установлена.
Мы используем метод is_ok на Result, чтобы проверить, установлена ли переменная
окружения, что означает, что программа должна выполнить поиск без учёта регистра.
Если переменная окружения IGNORE_CASE ни во что не установлена, is_ok вернёт
false, и программа выполнит поиск с учётом регистра. Нас не интересует
значение переменной окружения, только установлена она или
нет, поэтому мы проверяем is_ok, а не используем unwrap, expect или любой
из других методов, которые мы видели на Result.
Мы передаём значение из переменной ignore_case в экземпляр Config, чтобы
функция run могла прочитать это значение и решить, вызывать ли
search_case_insensitive или search, как мы реализовали в листинге 12-22.
Давайте попробуем! Сначала мы запустим нашу программу без установленной переменной
окружения и с запросом to, который должен совпасть с любой строкой, содержащей
слово to в нижнем регистре:
$ cargo run -- to poem.txt
Compiling minigrep v0.1.0 (file:///projects/minigrep)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
Running `target/debug/minigrep to poem.txt`
Are you nobody, too?
How dreary to be somebody!
Похоже, это всё ещё работает! Теперь запустим программу с IGNORE_CASE, установленной
в 1, но с тем же запросом to:
$ IGNORE_CASE=1 cargo run -- to poem.txt
Если вы используете PowerShell, вам нужно будет установить переменную окружения и запустить программу отдельными командами:
PS> $Env:IGNORE_CASE=1; cargo run -- to poem.txt
Это сделает IGNORE_CASE постоянной для оставшейся части сеанса оболочки.
Её можно сбросить с помощью командлета Remove-Item:
PS> Remove-Item Env:IGNORE_CASE
Мы должны получить строки, содержащие to, которые могут иметь заглавные буквы:
Are you nobody, too?
How dreary to be somebody!
To tell your name the livelong day
To an admiring bog!
Отлично, мы также получили строки, содержащие To! Наша программа minigrep теперь может выполнять
поиск без учёта регистра, управляемый переменной окружения. Теперь вы знаете,
как управлять опциями, заданными с помощью аргументов командной строки или переменных
окружения.
Некоторые программы допускают аргументы и переменные окружения для одной и той же конфигурации. В таких случаях программы решают, что одно или другое имеет приоритет. В качестве ещё одного упражнения попробуйте управлять чувствительностью к регистру через аргумент командной строки или переменную окружения. Решите, что должно иметь приоритет — аргумент командной строки или переменная окружения, если программа запускается с одним набором для учёта регистра и другим набором для игнорирования регистра.
Модуль std::env содержит множество других полезных возможностей для работы с
переменными окружения: ознакомьтесь с его документацией, чтобы увидеть, что доступно.