Skip to content

Commit 1263524

Browse files
authored
[ty] Simplify display implementations with std::fmt::from_fn (#27718)
1 parent 59196ba commit 1263524

9 files changed

Lines changed: 384 additions & 736 deletions

File tree

‎crates/ty_ide/src/hover.rs‎

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ use ruff_db::files::FileRange;
55
use ruff_db::parsed::parsed_module;
66
use ruff_python_ast as ast;
77
use ruff_text_size::{Ranged, TextSize};
8-
use std::fmt;
9-
use std::fmt::Formatter;
8+
use std::fmt::{self, Display};
109
use ty_python_core::ProgramFile;
1110
use ty_python_semantic::ProgramEnvironment;
1211
use ty_python_semantic::types::ide_support::{resolved_call_signature, typed_dict_key_hover};
@@ -230,12 +229,21 @@ pub struct Hover<'db> {
230229

231230
impl<'db> Hover<'db> {
232231
/// Renders the hover to a string using the specified markup kind.
233-
pub const fn display<'a>(&'a self, db: &'db dyn Db, kind: MarkupKind) -> DisplayHover<'db, 'a> {
234-
DisplayHover {
235-
db,
236-
hover: self,
237-
kind,
238-
}
232+
pub const fn display<'a>(&'a self, db: &'db dyn Db, kind: MarkupKind) -> impl Display {
233+
std::fmt::from_fn(move |f| {
234+
let mut first = true;
235+
let env = ProgramEnvironment::from_file(self.program_file);
236+
for content in &self.contents {
237+
if !first {
238+
kind.horizontal_line().fmt(f)?;
239+
}
240+
241+
content.display(db, &env, kind).fmt(f)?;
242+
first = false;
243+
}
244+
245+
Ok(())
246+
})
239247
}
240248

241249
fn iter(&self) -> std::slice::Iter<'_, HoverContent<'db>> {
@@ -261,30 +269,6 @@ impl<'a, 'db> IntoIterator for &'a Hover<'db> {
261269
}
262270
}
263271

264-
pub struct DisplayHover<'db, 'a> {
265-
db: &'db dyn Db,
266-
hover: &'a Hover<'db>,
267-
kind: MarkupKind,
268-
}
269-
270-
impl fmt::Display for DisplayHover<'_, '_> {
271-
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
272-
let db = self.db;
273-
let mut first = true;
274-
let env = ProgramEnvironment::from_file(self.hover.program_file);
275-
for content in &self.hover.contents {
276-
if !first {
277-
self.kind.horizontal_line().fmt(f)?;
278-
}
279-
280-
content.display(db, &env, self.kind).fmt(f)?;
281-
first = false;
282-
}
283-
284-
Ok(())
285-
}
286-
}
287-
288272
#[derive(Debug, Clone)]
289273
pub enum HoverContent<'db> {
290274
Signature(String),

‎crates/ty_module_resolver/src/environment.rs‎

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
use std::fmt;
2-
31
use ruff_db::files::File;
42
use ruff_python_ast::PythonVersion;
53

@@ -22,34 +20,20 @@ impl<'db> ResolverEnvironment<'db> {
2220
self,
2321
db: &'db dyn Db,
2422
mode: ModuleResolveMode,
25-
) -> DisplaySearchPaths<'db> {
26-
DisplaySearchPaths {
27-
db,
28-
resolver_environment: self,
29-
mode,
30-
}
31-
}
32-
}
33-
34-
pub struct DisplaySearchPaths<'db> {
35-
db: &'db dyn Db,
36-
resolver_environment: ResolverEnvironment<'db>,
37-
mode: ModuleResolveMode,
38-
}
39-
40-
impl fmt::Display for DisplaySearchPaths<'_> {
41-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
42-
let mut paths = search_paths(self.db, self.resolver_environment, self.mode).peekable();
23+
) -> impl std::fmt::Display {
24+
std::fmt::from_fn(move |f| {
25+
let mut paths = search_paths(db, self, mode).peekable();
4326

44-
if paths.peek().is_none() {
45-
return f.write_str("[]");
46-
}
27+
if paths.peek().is_none() {
28+
return f.write_str("[]");
29+
}
4730

48-
writeln!(f, "[")?;
49-
for path in paths {
50-
writeln!(f, " {path},")?;
51-
}
52-
f.write_str("]")
31+
writeln!(f, "[")?;
32+
for path in paths {
33+
writeln!(f, " {path},")?;
34+
}
35+
f.write_str("]")
36+
})
5337
}
5438
}
5539

‎crates/ty_project/src/db.rs‎

Lines changed: 104 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -325,137 +325,125 @@ fn bytes_to_mb(total: usize) -> f64 {
325325

326326
impl SalsaMemoryDump {
327327
/// Returns a short report that provides total memory usage information.
328-
pub fn display_short(&self) -> impl fmt::Display + '_ {
329-
struct DisplayShort<'a>(&'a SalsaMemoryDump);
330-
331-
impl fmt::Display for DisplayShort<'_> {
332-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
333-
let SalsaMemoryDump {
334-
total_fields,
335-
total_metadata,
336-
total_memo_fields,
337-
total_memo_metadata,
338-
ref ingredients,
339-
ref memos,
340-
} = *self.0;
341-
342-
writeln!(f, "=======SALSA SUMMARY=======")?;
328+
pub fn display_short(self) -> impl fmt::Display {
329+
std::fmt::from_fn(move |f| {
330+
let SalsaMemoryDump {
331+
total_fields,
332+
total_metadata,
333+
total_memo_fields,
334+
total_memo_metadata,
335+
ref ingredients,
336+
ref memos,
337+
} = self;
338+
339+
writeln!(f, "=======SALSA SUMMARY=======")?;
340+
341+
writeln!(
342+
f,
343+
"TOTAL MEMORY USAGE: {:.2}MB",
344+
bytes_to_mb(
345+
total_metadata + total_fields + total_memo_fields + total_memo_metadata
346+
)
347+
)?;
348+
349+
writeln!(
350+
f,
351+
" struct metadata = {:.2}MB",
352+
bytes_to_mb(total_metadata),
353+
)?;
354+
writeln!(f, " struct fields = {:.2}MB", bytes_to_mb(total_fields))?;
355+
writeln!(
356+
f,
357+
" memo metadata = {:.2}MB",
358+
bytes_to_mb(total_memo_metadata),
359+
)?;
360+
writeln!(
361+
f,
362+
" memo fields = {:.2}MB",
363+
bytes_to_mb(total_memo_fields),
364+
)?;
365+
366+
writeln!(f, "QUERY COUNT: {}", memos.len())?;
367+
writeln!(f, "STRUCT COUNT: {}", ingredients.len())?;
368+
369+
Ok(())
370+
})
371+
}
343372

344-
writeln!(
345-
f,
346-
"TOTAL MEMORY USAGE: {:.2}MB",
347-
bytes_to_mb(
348-
total_metadata + total_fields + total_memo_fields + total_memo_metadata
349-
)
350-
)?;
373+
/// Returns a short report that provides fine-grained memory usage information per
374+
/// Salsa ingredient.
375+
pub fn display_full(self) -> impl fmt::Display {
376+
std::fmt::from_fn(move |f| {
377+
let SalsaMemoryDump {
378+
total_fields,
379+
total_metadata,
380+
total_memo_fields,
381+
total_memo_metadata,
382+
ref ingredients,
383+
ref memos,
384+
} = self;
385+
386+
writeln!(f, "=======SALSA STRUCTS=======")?;
387+
388+
for ingredient in ingredients {
389+
let size_of_fields =
390+
ingredient.size_of_fields() + ingredient.heap_size_of_fields().unwrap_or(0);
351391

352392
writeln!(
353393
f,
354-
" struct metadata = {:.2}MB",
355-
bytes_to_mb(total_metadata),
356-
)?;
357-
writeln!(f, " struct fields = {:.2}MB", bytes_to_mb(total_fields))?;
358-
writeln!(
359-
f,
360-
" memo metadata = {:.2}MB",
361-
bytes_to_mb(total_memo_metadata),
394+
"{:<50} metadata={:<8} fields={:<8} count={}",
395+
format!("`{}`", ingredient.debug_name()),
396+
format!("{:.2}MB", bytes_to_mb(ingredient.size_of_metadata())),
397+
format!("{:.2}MB", bytes_to_mb(size_of_fields)),
398+
ingredient.count()
362399
)?;
363-
writeln!(
364-
f,
365-
" memo fields = {:.2}MB",
366-
bytes_to_mb(total_memo_fields),
367-
)?;
368-
369-
writeln!(f, "QUERY COUNT: {}", memos.len())?;
370-
writeln!(f, "STRUCT COUNT: {}", ingredients.len())?;
371-
372-
Ok(())
373400
}
374-
}
375401

376-
DisplayShort(self)
377-
}
402+
writeln!(f, "=======SALSA QUERIES=======")?;
378403

379-
/// Returns a short report that provides fine-grained memory usage information per
380-
/// Salsa ingredient.
381-
pub fn display_full(&self) -> impl fmt::Display + '_ {
382-
struct DisplayFull<'a>(&'a SalsaMemoryDump);
383-
384-
impl fmt::Display for DisplayFull<'_> {
385-
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
386-
let SalsaMemoryDump {
387-
total_fields,
388-
total_metadata,
389-
total_memo_fields,
390-
total_memo_metadata,
391-
ref ingredients,
392-
ref memos,
393-
} = *self.0;
394-
395-
writeln!(f, "=======SALSA STRUCTS=======")?;
396-
397-
for ingredient in ingredients {
398-
let size_of_fields =
399-
ingredient.size_of_fields() + ingredient.heap_size_of_fields().unwrap_or(0);
400-
401-
writeln!(
402-
f,
403-
"{:<50} metadata={:<8} fields={:<8} count={}",
404-
format!("`{}`", ingredient.debug_name()),
405-
format!("{:.2}MB", bytes_to_mb(ingredient.size_of_metadata())),
406-
format!("{:.2}MB", bytes_to_mb(size_of_fields)),
407-
ingredient.count()
408-
)?;
409-
}
410-
411-
writeln!(f, "=======SALSA QUERIES=======")?;
412-
413-
for (query_fn, memo) in memos {
414-
let size_of_fields =
415-
memo.size_of_fields() + memo.heap_size_of_fields().unwrap_or(0);
404+
for (query_fn, memo) in memos {
405+
let size_of_fields =
406+
memo.size_of_fields() + memo.heap_size_of_fields().unwrap_or(0);
416407

417-
writeln!(f, "`{query_fn} -> {}`", memo.debug_name())?;
418-
419-
writeln!(
420-
f,
421-
" metadata={:<8} fields={:<8} count={}",
422-
format!("{:.2}MB", bytes_to_mb(memo.size_of_metadata())),
423-
format!("{:.2}MB", bytes_to_mb(size_of_fields)),
424-
memo.count()
425-
)?;
426-
}
427-
428-
writeln!(f, "=======SALSA SUMMARY=======")?;
429-
writeln!(
430-
f,
431-
"TOTAL MEMORY USAGE: {:.2}MB",
432-
bytes_to_mb(
433-
total_metadata + total_fields + total_memo_fields + total_memo_metadata
434-
)
435-
)?;
408+
writeln!(f, "`{query_fn} -> {}`", memo.debug_name())?;
436409

437410
writeln!(
438411
f,
439-
" struct metadata = {:.2}MB",
440-
bytes_to_mb(total_metadata),
412+
" metadata={:<8} fields={:<8} count={}",
413+
format!("{:.2}MB", bytes_to_mb(memo.size_of_metadata())),
414+
format!("{:.2}MB", bytes_to_mb(size_of_fields)),
415+
memo.count()
441416
)?;
442-
writeln!(f, " struct fields = {:.2}MB", bytes_to_mb(total_fields))?;
443-
writeln!(
444-
f,
445-
" memo metadata = {:.2}MB",
446-
bytes_to_mb(total_memo_metadata),
447-
)?;
448-
writeln!(
449-
f,
450-
" memo fields = {:.2}MB",
451-
bytes_to_mb(total_memo_fields),
452-
)?;
453-
454-
Ok(())
455417
}
456-
}
457418

458-
DisplayFull(self)
419+
writeln!(f, "=======SALSA SUMMARY=======")?;
420+
writeln!(
421+
f,
422+
"TOTAL MEMORY USAGE: {:.2}MB",
423+
bytes_to_mb(
424+
total_metadata + total_fields + total_memo_fields + total_memo_metadata
425+
)
426+
)?;
427+
428+
writeln!(
429+
f,
430+
" struct metadata = {:.2}MB",
431+
bytes_to_mb(total_metadata),
432+
)?;
433+
writeln!(f, " struct fields = {:.2}MB", bytes_to_mb(total_fields))?;
434+
writeln!(
435+
f,
436+
" memo metadata = {:.2}MB",
437+
bytes_to_mb(total_memo_metadata),
438+
)?;
439+
writeln!(
440+
f,
441+
" memo fields = {:.2}MB",
442+
bytes_to_mb(total_memo_fields),
443+
)?;
444+
445+
Ok(())
446+
})
459447
}
460448

461449
/// Serializes the memory dump to JSON.

0 commit comments

Comments
 (0)