Make format_deprecation a method on Deprecation

Summary: Nicer code organization.

Reviewed By: fangyi-zhou

Differential Revision: D87518878

fbshipit-source-id: da997052d79b73d4a1eee06cb6d19fb17c8bf9b1

Author: rchen152

crates/pyrefly_types/src/callable.rs

@@ -26,6 +26,8 @@ use pyrefly_util::visit::Visit;
 use pyrefly_util::visit::VisitMut;
 use ruff_python_ast::Keyword;
 use ruff_python_ast::name::Name;
+use vec1::Vec1;
+use vec1::vec1;
 
 use crate::class::Class;
 use crate::class::ClassType;
@@ -336,6 +338,14 @@ impl Deprecation {
     pub fn new(message: Option<String>) -> Self {
         Self { message }
     }
+
+    /// Format a base description using deprecation metadata.
+    pub fn as_error_message(&self, base: String) -> Vec1<String> {
+        match self.message.as_ref().map(|s| s.trim()) {
+            Some(msg) if !msg.is_empty() => vec1![base, msg.to_owned()],
+            _ => vec1![base],
+        }
+    }
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]

pyrefly/lib/alt/call.rs

@@ -34,7 +34,6 @@ use crate::alt::class::class_field::DescriptorBase;
 use crate::alt::unwrap::HintRef;
 use crate::binding::binding::Key;
 use crate::config::error_kind::ErrorKind;
-use crate::deprecation::format_deprecation;
 use crate::error::collector::ErrorCollector;
 use crate::error::context::ErrorContext;
 use crate::error::context::ErrorInfo;
@@ -376,10 +375,10 @@ impl<'a, Ans: LookupAnswer> AnswersSolver<'a, Ans> {
                     // We manually construct an error using the message from the context but a
                     // Deprecated error kind so that the error is shown at the Deprecated severity
                     // (default: WARN) rather than the severity of the context's error kind.
-                    let mut msg = format_deprecation(
-                        format!("`{}` is deprecated", m.kind.format(self.module().name())),
-                        Some(deprecation),
-                    );
+                    let mut msg = deprecation.as_error_message(format!(
+                        "`{}` is deprecated",
+                        m.kind.format(self.module().name())
+                    ));
                     if let Some(ctx) = context {
                         msg.insert(0, ctx().format());
                     }

pyrefly/lib/alt/expr.rs

@@ -56,7 +56,6 @@ use crate::binding::binding::Key;
 use crate::binding::binding::KeyYield;
 use crate::binding::binding::KeyYieldFrom;
 use crate::config::error_kind::ErrorKind;
-use crate::deprecation::format_deprecation;
 use crate::error::collector::ErrorCollector;
 use crate::error::context::ErrorContext;
 use crate::error::context::ErrorInfo;
@@ -247,10 +246,7 @@ impl<'a, Ans: LookupAnswer> AnswersSolver<'a, Ans> {
             errors.add(
                 range,
                 ErrorInfo::Kind(ErrorKind::Deprecated),
-                format_deprecation(
-                    format!("`{deprecated_function}` is deprecated"),
-                    Some(&deprecation),
-                ),
+                deprecation.as_error_message(format!("`{deprecated_function}` is deprecated")),
             );
         }
     }

pyrefly/lib/alt/overload.rs

@@ -32,7 +32,6 @@ use crate::alt::callable::CallWithTypes;
 use crate::alt::expr::TypeOrExpr;
 use crate::alt::unwrap::HintRef;
 use crate::config::error_kind::ErrorKind;
-use crate::deprecation::format_deprecation;
 use crate::error::collector::ErrorCollector;
 use crate::error::context::ErrorContext;
 use crate::error::context::ErrorInfo;
@@ -321,18 +320,15 @@ impl<'a, Ans: LookupAnswer> AnswersSolver<'a, Ans> {
         if matched {
             // If the selected overload is deprecated, we log a deprecation error.
             if let Some(deprecation) = &closest_overload.func.1.metadata.flags.deprecation {
-                let msg = format_deprecation(
-                    format!(
-                        "Call to deprecated overload `{}`",
-                        closest_overload
-                            .func
-                            .1
-                            .metadata
-                            .kind
-                            .format(self.module().name())
-                    ),
-                    Some(deprecation),
-                );
+                let msg = deprecation.as_error_message(format!(
+                    "Call to deprecated overload `{}`",
+                    closest_overload
+                        .func
+                        .1
+                        .metadata
+                        .kind
+                        .format(self.module().name())
+                ));
                 errors.add(range, ErrorInfo::new(ErrorKind::Deprecated, context), msg);
             }
             (closest_overload.res, closest_overload.func.1.signature)

pyrefly/lib/binding/stmt.rs

@@ -44,7 +44,6 @@ use crate::binding::scope::FlowStyle;
 use crate::binding::scope::LoopExit;
 use crate::binding::scope::Scope;
 use crate::config::error_kind::ErrorKind;
-use crate::deprecation::format_deprecation;
 use crate::error::context::ErrorInfo;
 use crate::export::definitions::MutableCaptureKind;
 use crate::export::exports::Export;
@@ -1002,10 +1001,7 @@ impl<'a> BindingsBuilder<'a> {
                         ..
                     })) = exported.get_hashed(name)
                     {
-                        let msg = format_deprecation(
-                            format!("`{name}` is deprecated"),
-                            Some(deprecation),
-                        );
+                        let msg = deprecation.as_error_message(format!("`{name}` is deprecated"));
                         self.error_multiline(x.range, ErrorInfo::Kind(ErrorKind::Deprecated), msg);
                     }
                     let val = if exported.contains_key_hashed(name) {
@@ -1052,10 +1048,8 @@ impl<'a> BindingsBuilder<'a> {
                         ..
                     })) = exported.get(&x.name.id)
                     {
-                        let msg = format_deprecation(
-                            format!("`{}` is deprecated", x.name),
-                            Some(deprecation),
-                        );
+                        let msg =
+                            deprecation.as_error_message(format!("`{}` is deprecated", x.name));
                         self.error_multiline(x.range, ErrorInfo::Kind(ErrorKind::Deprecated), msg);
                     }
                     Binding::Import(m, x.name.id.clone(), original_name_range)

pyrefly/lib/deprecation.rs

@@ -10,8 +10,6 @@ use ruff_python_ast::Expr;
 use ruff_python_ast::ExprAttribute;
 use ruff_python_ast::ExprCall;
 use ruff_python_ast::ExprStringLiteral;
-use vec1::Vec1;
-use vec1::vec1;
 
 fn is_deprecated_target(e: &Expr) -> bool {
     let (base, value) = match e {
@@ -45,11 +43,3 @@ pub fn parse_deprecation(e: &Expr) -> Option<Deprecation> {
     }
     Some(Deprecation::new(extract_message(call)))
 }
-
-/// Format a base description using metadata from a parsed decorator.
-pub fn format_deprecation(base: String, deprecation: Option<&Deprecation>) -> Vec1<String> {
-    match deprecation.and_then(|d| d.message.as_ref().map(|s| s.trim())) {
-        Some(msg) if !msg.is_empty() => vec1![base, msg.to_owned()],
-        _ => vec1![base],
-    }
-}