如何在format()中获取names属性，实现自定义对象在tibble友好打印？

问题背景 #

尝试让复杂自定义对象在tibble中友好打印，将每个对象的ID存储在向量的names属性中，希望在tibble列中展示该ID，但发现format()方法无法获取names属性（示例代码如下）。不希望使用自定义属性，因为每次修改或子集化对象时都需要重新绑定该属性。

示例代码 #

format.foo <- function(x, ...) {
  print(attributes(x))
  sprintf("<%s>", names(x))
}

df <- tibble::tibble(x = {
  out <- structure(letters[1:5], bar = "zig", class = "foo")
  stats::setNames(out, 1:5)
})

df
#> $bar
#> [1] "zig"
#> 
#> $class
#> [1] "foo"
#> 
#> # A tibble: 5 × 1
#>   x    
#>   <foo>
#> 1 x    
#> 2 <foo>
#> 3 x    
#> 4 <foo>
#> 5 x

解决方案 #

问题根源是tibble在调用format()时，会将列向量拆分为单个元素逐个处理，单个元素没有names属性。此时应使用tibble底层的pillar格式化系统，自定义pillar_shaft.foo方法——该方法接收整个列的完整向量，因此可以直接获取names属性，无需修改每个元素的属性。

实现代码 #

library(tibble)
library(pillar)

# 自定义pillar_shaft方法处理foo类对象
pillar_shaft.foo <- function(x, ...) {
  # 获取整个向量的names作为ID
  element_ids <- names(x)
  # 生成每个元素的显示文本
  display_content <- sprintf("<%s>", element_ids)
  # 返回pillar所需的shaft对象，设置对齐方式和最小宽度
  new_pillar_shaft_simple(display_content, align = "left", min_width = 3)
}

# 可选：保留format方法用于单独打印对象时的展示
format.foo <- function(x, ...) {
  sprintf("<%s>", names(x))
}

# 创建测试数据
df <- tibble::tibble(x = {
  out <- structure(letters[1:5], bar = "zig", class = "foo")
  stats::setNames(out, 1:5)
})

# 打印tibble，此时会正确显示每个元素的ID
df
#> # A tibble: 5 × 1
#>   x    
#>   <foo>
#> 1 <1>  
#> 2 <2>  
#> 3 <3>  
#> 4 <4>  
#> 5 <5>

效果说明 #

• 该方法直接利用整个列向量的names属性生成显示文本，无需为每个元素单独绑定自定义属性。
• 当对tibble进行子集化操作时（如df[1:3,]），只要子集后的向量保留names属性，打印时仍会正常显示对应ID。

内容的提问来源于stack exchange，提问作者Junitar