-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathparser.rs
More file actions
678 lines (613 loc) · 21.7 KB
/
parser.rs
File metadata and controls
678 lines (613 loc) · 21.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
//! pyproject.toml parsing and format-preserving dependency updates via `toml_edit`.
//!
//! Supports:
//! - `[project] dependencies` (PEP 621)
//! - `[tool.poetry.dependencies]` (Poetry)
//! - `[dependency-groups]` (PEP 735)
use dependency_check_updates_core::{DependencySection, DependencySpec, PlannedUpdate};
use toml_edit::{DocumentMut, Item};
/// A parsed pyproject.toml file.
#[derive(Debug)]
pub struct PyProjectManifest {
/// The original raw text.
pub original_text: String,
/// The `toml_edit` document (format-preserving).
pub doc: DocumentMut,
/// Collected dependencies.
pub dependencies: Vec<DependencySpec>,
}
impl PyProjectManifest {
/// Parse a pyproject.toml from raw text.
///
/// # Errors
///
/// Returns an error if the text is not valid TOML.
pub fn parse(text: &str) -> Result<Self, PyProjectError> {
let doc: DocumentMut = text
.parse()
.map_err(|e: toml_edit::TomlError| PyProjectError::ParseFailed(e.to_string()))?;
let dependencies = Self::collect_dependencies(&doc);
Ok(Self {
original_text: text.to_owned(),
doc,
dependencies,
})
}
fn collect_dependencies(doc: &DocumentMut) -> Vec<DependencySpec> {
let mut deps = Vec::new();
// PEP 621: [project] dependencies = ["requests>=2.0", ...]
if let Some(project) = doc.get("project").and_then(Item::as_table) {
if let Some(dep_array) = project.get("dependencies").and_then(Item::as_array) {
for item in dep_array {
if let Some(spec_str) = item.as_str() {
if let Some(dep) =
parse_pep508_spec(spec_str, DependencySection::ProjectDependencies)
{
deps.push(dep);
}
}
}
}
// [project.optional-dependencies]
if let Some(opt_deps) = project
.get("optional-dependencies")
.and_then(Item::as_table)
{
for (_group, items) in opt_deps {
if let Some(arr) = items.as_array() {
for item in arr {
if let Some(spec_str) = item.as_str() {
if let Some(dep) = parse_pep508_spec(
spec_str,
DependencySection::OptionalDependencies,
) {
deps.push(dep);
}
}
}
}
}
}
}
// Poetry: [tool.poetry.dependencies]
if let Some(tool) = doc.get("tool").and_then(Item::as_table) {
if let Some(poetry) = tool.get("poetry").and_then(Item::as_table) {
if let Some(poetry_deps) = poetry.get("dependencies").and_then(Item::as_table) {
for (name, item) in poetry_deps {
if name == "python" {
continue; // Skip python version constraint
}
if let Some(version) = extract_poetry_version(item) {
if !is_wildcard_req(&version) {
deps.push(DependencySpec {
name: name.to_owned(),
current_req: version,
section: DependencySection::Dependencies,
});
}
}
}
}
// Poetry dev-dependencies
if let Some(dev_deps) = poetry.get("dev-dependencies").and_then(Item::as_table) {
for (name, item) in dev_deps {
if let Some(version) = extract_poetry_version(item) {
if !is_wildcard_req(&version) {
deps.push(DependencySpec {
name: name.to_owned(),
current_req: version,
section: DependencySection::DevDependencies,
});
}
}
}
}
}
}
// PEP 735: [dependency-groups]
if let Some(groups) = doc.get("dependency-groups").and_then(Item::as_table) {
for (_group_name, items) in groups {
if let Some(arr) = items.as_array() {
for item in arr {
if let Some(spec_str) = item.as_str() {
if let Some(dep) =
parse_pep508_spec(spec_str, DependencySection::DevDependencies)
{
deps.push(dep);
}
}
}
}
}
}
deps
}
/// Apply planned updates to the document, returning the modified text.
///
/// # Errors
///
/// Returns an error if a dependency cannot be updated.
pub fn apply_updates(&mut self, updates: &[PlannedUpdate]) -> Result<String, PyProjectError> {
for update in updates {
self.apply_single_update(update);
}
Ok(self.doc.to_string())
}
fn apply_single_update(&mut self, update: &PlannedUpdate) {
// Try PEP 621 project.dependencies
if let Some(project) = self.doc.get_mut("project").and_then(Item::as_table_mut) {
if let Some(dep_array) = project.get_mut("dependencies").and_then(Item::as_array_mut) {
for item in dep_array.iter_mut() {
if let Some(spec_str) = item.as_str() {
if spec_str_matches_name(spec_str, &update.name) {
let new_spec = replace_version_in_pep508(spec_str, &update.to);
*item = toml_edit::Value::String(toml_edit::Formatted::new(new_spec));
return;
}
}
}
}
}
// Try Poetry tool.poetry.dependencies
if let Some(tool) = self.doc.get_mut("tool").and_then(Item::as_table_mut) {
if let Some(poetry) = tool.get_mut("poetry").and_then(Item::as_table_mut) {
if let Some(deps) = poetry.get_mut("dependencies").and_then(Item::as_table_mut) {
if let Some(Item::Value(toml_edit::Value::String(s))) =
deps.get_mut(&update.name)
{
let decor = s.decor().clone();
let mut new_s = toml_edit::Formatted::new(update.to.clone());
*new_s.decor_mut() = decor;
*s = new_s;
}
}
}
}
// Silently skip if not found (may be in optional-deps or groups)
}
}
/// Parse a PEP 508 dependency spec like `"requests>=2.28.0"` or `"flask~=2.0"`.
///
/// Returns `None` for specs without version constraints (e.g., bare `"requests"`).
fn parse_pep508_spec(spec: &str, section: DependencySection) -> Option<DependencySpec> {
let spec = spec.trim();
// Find where the version constraint starts (first non-alphanumeric, non-hyphen, non-dot, non-underscore)
let name_end = spec
.find(|c: char| !c.is_alphanumeric() && c != '-' && c != '_' && c != '.')
.unwrap_or(spec.len());
let name = spec[..name_end].trim();
if name.is_empty() {
return None;
}
let rest = spec[name_end..].trim();
// Remove extras like [security] before version
let rest = if rest.starts_with('[') {
rest.find(']').map_or(rest, |i| rest[i + 1..].trim())
} else {
rest
};
// Remove environment markers like ; python_version >= "3.8"
let rest = rest.split(';').next().unwrap_or("").trim();
if rest.is_empty() {
return None; // No version constraint
}
if is_wildcard_req(rest) {
return None; // `*`, `==*`, etc. already mean "any version"
}
Some(DependencySpec {
name: name.to_owned(),
current_req: rest.to_owned(),
section,
})
}
/// Check if a PEP 508 spec string matches a given package name.
fn spec_str_matches_name(spec: &str, name: &str) -> bool {
let spec = spec.trim();
let name_end = spec
.find(|c: char| !c.is_alphanumeric() && c != '-' && c != '_' && c != '.')
.unwrap_or(spec.len());
let spec_name = &spec[..name_end];
// PEP 503 normalized comparison (case-insensitive, treat - _ . as equivalent)
normalize_pep503(spec_name) == normalize_pep503(name)
}
fn normalize_pep503(name: &str) -> String {
name.to_lowercase().replace(['-', '.'], "_")
}
/// Replace the version constraint in a PEP 508 spec string.
fn replace_version_in_pep508(spec: &str, new_version: &str) -> String {
let spec = spec.trim();
let name_end = spec
.find(|c: char| !c.is_alphanumeric() && c != '-' && c != '_' && c != '.')
.unwrap_or(spec.len());
let name = &spec[..name_end];
// Check for extras
let rest = &spec[name_end..];
let (extras, rest) = if rest.starts_with('[') {
rest.find(']')
.map_or(("", rest), |i| (&rest[..=i], rest[i + 1..].trim_start()))
} else {
("", rest.trim_start())
};
// Check for environment markers
let marker = rest.find(';').map_or("", |i| &rest[i..]);
format!("{name}{extras}{new_version}{marker}")
}
/// Check if a version requirement is an unresolvable wildcard like `*` or `==*`.
///
/// Such requirements already mean "any/latest version", so updating them
/// would be a meaningless no-op and we filter them out at parse time.
fn is_wildcard_req(req: &str) -> bool {
let stripped = req
.trim()
.trim_start_matches(['=', '~', '^', '>', '<'])
.trim();
matches!(stripped, "" | "*")
}
/// Extract a version string from a Poetry dependency value.
fn extract_poetry_version(item: &Item) -> Option<String> {
match item {
Item::Value(toml_edit::Value::String(s)) => Some(s.value().to_owned()),
Item::Value(toml_edit::Value::InlineTable(t)) => t
.get("version")
.and_then(toml_edit::Value::as_str)
.map(String::from),
Item::Table(t) => t.get("version").and_then(Item::as_str).map(String::from),
_ => None,
}
}
/// Errors from pyproject.toml operations.
#[derive(Debug, thiserror::Error)]
pub enum PyProjectError {
#[error("failed to parse pyproject.toml: {0}")]
ParseFailed(String),
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_parse_pep621_dependencies() {
let toml = r#"
[project]
name = "my-project"
dependencies = [
"requests>=2.28.0",
"flask~=2.0",
"click>=8.0,<9.0",
]
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
assert_eq!(manifest.dependencies.len(), 3);
assert_eq!(manifest.dependencies[0].name, "requests");
assert_eq!(manifest.dependencies[0].current_req, ">=2.28.0");
assert_eq!(
manifest.dependencies[0].section,
DependencySection::ProjectDependencies
);
}
#[test]
fn test_parse_pep621_optional_deps() {
let toml = r#"
[project.optional-dependencies]
dev = ["pytest>=7.0", "black>=23.0"]
docs = ["sphinx>=5.0"]
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
assert_eq!(manifest.dependencies.len(), 3);
assert_eq!(
manifest.dependencies[0].section,
DependencySection::OptionalDependencies
);
}
#[test]
fn test_parse_poetry_dependencies() {
let toml = r#"
[tool.poetry.dependencies]
python = "^3.8"
requests = "^2.28.0"
flask = {version = "^2.0", optional = true}
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
// python is skipped
assert_eq!(manifest.dependencies.len(), 2);
assert_eq!(manifest.dependencies[0].name, "requests");
assert_eq!(manifest.dependencies[0].current_req, "^2.28.0");
}
#[test]
fn test_parse_poetry_dev_dependencies() {
let toml = r#"
[tool.poetry.dev-dependencies]
pytest = "^7.0"
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
assert_eq!(manifest.dependencies.len(), 1);
assert_eq!(
manifest.dependencies[0].section,
DependencySection::DevDependencies
);
}
#[test]
fn test_parse_dependency_groups() {
let toml = r#"
[dependency-groups]
test = ["pytest>=7.0", "coverage>=7.0"]
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
assert_eq!(manifest.dependencies.len(), 2);
}
#[test]
fn test_skip_bare_deps() {
let toml = r#"
[project]
dependencies = ["requests", "flask>=2.0"]
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
assert_eq!(manifest.dependencies.len(), 1);
assert_eq!(manifest.dependencies[0].name, "flask");
}
#[test]
fn test_pep508_with_extras() {
let dep = parse_pep508_spec(
"requests[security]>=2.28.0",
DependencySection::ProjectDependencies,
);
let dep = dep.unwrap();
assert_eq!(dep.name, "requests");
assert_eq!(dep.current_req, ">=2.28.0");
}
#[test]
fn test_pep508_with_markers() {
let dep = parse_pep508_spec(
"pywin32>=300; sys_platform == 'win32'",
DependencySection::ProjectDependencies,
);
let dep = dep.unwrap();
assert_eq!(dep.name, "pywin32");
assert_eq!(dep.current_req, ">=300");
}
#[test]
fn test_no_deps_empty() {
let toml = r#"
[project]
name = "empty"
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
assert!(manifest.dependencies.is_empty());
}
#[test]
fn test_comments_preserved() {
let toml = r#"
# Project config
[project]
name = "my-project"
# Main dependencies
dependencies = [
"requests>=2.28.0",
]
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
let result = manifest.apply_updates(&[]).unwrap();
assert!(result.contains("# Project config"));
assert!(result.contains("# Main dependencies"));
}
#[test]
fn test_replace_version_in_pep508() {
assert_eq!(
replace_version_in_pep508("requests>=2.28.0", ">=2.31.0"),
"requests>=2.31.0"
);
assert_eq!(
replace_version_in_pep508("flask~=2.0", "~=3.0"),
"flask~=3.0"
);
assert_eq!(
replace_version_in_pep508("pywin32>=300; sys_platform == 'win32'", ">=306"),
"pywin32>=306; sys_platform == 'win32'"
);
}
#[test]
fn test_normalize_pep503() {
assert_eq!(normalize_pep503("My-Package"), "my_package");
assert_eq!(normalize_pep503("my.package"), "my_package");
assert_eq!(normalize_pep503("MY_PACKAGE"), "my_package");
}
#[test]
fn test_apply_updates_pep621() {
let toml = r#"
[project]
name = "my-project"
dependencies = [
"requests>=2.28.0",
"flask~=2.0",
]
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
let updates = vec![PlannedUpdate {
name: "requests".to_owned(),
section: DependencySection::ProjectDependencies,
from: ">=2.28.0".to_owned(),
to: ">=2.31.0".to_owned(),
}];
let result = manifest.apply_updates(&updates).unwrap();
assert!(result.contains("requests>=2.31.0"));
assert!(result.contains("flask~=2.0"));
}
#[test]
fn test_apply_updates_poetry() {
let toml = r#"
[tool.poetry.dependencies]
python = "^3.8"
requests = "^2.28.0"
flask = "^2.0"
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
let updates = vec![PlannedUpdate {
name: "requests".to_owned(),
section: DependencySection::Dependencies,
from: "^2.28.0".to_owned(),
to: "^2.31.0".to_owned(),
}];
let result = manifest.apply_updates(&updates).unwrap();
assert!(result.contains("\"^2.31.0\""));
assert!(result.contains("flask = \"^2.0\""));
}
#[test]
fn test_apply_updates_empty() {
let toml = r#"
[project]
name = "my-project"
dependencies = [
"requests>=2.28.0",
]
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
let result = manifest.apply_updates(&[]).unwrap();
assert!(result.contains("requests>=2.28.0"));
}
#[test]
fn test_apply_updates_pep508_with_extras() {
let toml = r#"
[project]
dependencies = [
"requests[security]>=2.28.0",
]
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
assert_eq!(manifest.dependencies.len(), 1);
assert_eq!(manifest.dependencies[0].name, "requests");
let updates = vec![PlannedUpdate {
name: "requests".to_owned(),
section: DependencySection::ProjectDependencies,
from: ">=2.28.0".to_owned(),
to: ">=2.31.0".to_owned(),
}];
let result = manifest.apply_updates(&updates).unwrap();
assert!(result.contains("requests[security]>=2.31.0"));
}
#[test]
fn test_apply_updates_pep508_with_markers() {
let toml = r#"
[project]
dependencies = [
"pywin32>=300; sys_platform == 'win32'",
]
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
let updates = vec![PlannedUpdate {
name: "pywin32".to_owned(),
section: DependencySection::ProjectDependencies,
from: ">=300".to_owned(),
to: ">=306".to_owned(),
}];
let result = manifest.apply_updates(&updates).unwrap();
assert!(result.contains("pywin32>=306; sys_platform == 'win32'"));
}
#[test]
fn test_spec_str_matches_name_normalized() {
assert!(spec_str_matches_name("My-Package>=1.0", "my_package"));
assert!(spec_str_matches_name("my.package>=1.0", "my-package"));
assert!(!spec_str_matches_name("other>=1.0", "my-package"));
}
#[test]
fn test_replace_version_with_extras_and_markers() {
let result = replace_version_in_pep508(
"requests[security]>=2.28.0; python_version >= '3.8'",
">=2.31.0",
);
assert_eq!(
result,
"requests[security]>=2.31.0; python_version >= '3.8'"
);
}
#[test]
fn test_parse_pep508_bare_name() {
let dep = parse_pep508_spec("requests", DependencySection::ProjectDependencies);
assert!(dep.is_none());
}
#[test]
fn test_parse_pep508_empty_name() {
let dep = parse_pep508_spec("", DependencySection::ProjectDependencies);
assert!(dep.is_none());
}
#[test]
fn test_invalid_toml_returns_error() {
let result = PyProjectManifest::parse("not valid [[[toml");
assert!(result.is_err());
}
#[test]
fn test_poetry_table_form_version() {
let toml = r#"
[tool.poetry.dependencies]
python = "^3.8"
[tool.poetry.dependencies.sqlalchemy]
version = "^2.0"
extras = ["asyncio"]
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
let sa = manifest
.dependencies
.iter()
.find(|d| d.name == "sqlalchemy");
assert!(sa.is_some());
assert_eq!(sa.unwrap().current_req, "^2.0");
}
#[test]
fn test_poetry_inline_table_version() {
let toml = r#"
[tool.poetry.dependencies]
python = "^3.8"
flask = {version = "^2.0", optional = true}
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
let flask = manifest.dependencies.iter().find(|d| d.name == "flask");
assert!(flask.is_some());
assert_eq!(flask.unwrap().current_req, "^2.0");
}
#[test]
fn test_apply_updates_poetry_table_form() {
let toml = r#"
[tool.poetry.dependencies]
python = "^3.8"
requests = "^2.28.0"
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
let updates = vec![PlannedUpdate {
name: "requests".to_owned(),
section: DependencySection::Dependencies,
from: "^2.28.0".to_owned(),
to: "^2.31.0".to_owned(),
}];
let result = manifest.apply_updates(&updates).unwrap();
assert!(result.contains("\"^2.31.0\""));
// python constraint should remain unchanged
assert!(result.contains("python = \"^3.8\""));
}
#[test]
fn test_apply_updates_nonexistent_dep_silently_skipped() {
let toml = r#"
[project]
dependencies = ["requests>=2.28.0"]
"#;
let mut manifest = PyProjectManifest::parse(toml).unwrap();
let updates = vec![PlannedUpdate {
name: "nonexistent".to_owned(),
section: DependencySection::ProjectDependencies,
from: ">=1.0".to_owned(),
to: ">=2.0".to_owned(),
}];
// Should succeed without error, just skip the missing dep
let result = manifest.apply_updates(&updates).unwrap();
assert!(result.contains("requests>=2.28.0"));
}
#[test]
fn test_extract_poetry_version_bool_returns_none() {
// A boolean value should return None from extract_poetry_version
let toml = r#"
[tool.poetry.dependencies]
python = "^3.8"
my-pkg = true
"#;
let manifest = PyProjectManifest::parse(toml).unwrap();
// "my-pkg = true" is not a valid version spec, should be skipped
assert_eq!(manifest.dependencies.len(), 0);
}
}