add syntax_highlight.languages() (#265)

* add `syntax_highlight.languages()`

* [autofix.ci] apply automated fixes

* add type annotations

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: mhils

mitmproxy-highlight/src/lib.rs

@@ -1,6 +1,4 @@
 use anyhow::bail;
-use std::fmt;
-use std::fmt::Formatter;
 use std::str::FromStr;
 
 pub mod common;
@@ -31,6 +29,17 @@ impl Language {
             )]),
         }
     }
+
+    pub const VALUES: [Self; 4] = [Self::Xml, Self::Yaml, Self::Error, Self::None];
+
+    pub fn as_str(&self) -> &'static str {
+        match self {
+            Self::Xml => "xml",
+            Self::Yaml => "yaml",
+            Self::Error => "error",
+            Self::None => "none",
+        }
+    }
 }
 
 impl FromStr for Language {
@@ -47,21 +56,6 @@ impl FromStr for Language {
     }
 }
 
-impl fmt::Display for Language {
-    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
-        write!(
-            f,
-            "{}",
-            match self {
-                Language::Xml => "xml",
-                Language::Yaml => "yaml",
-                Language::Error => "error",
-                Language::None => "none",
-            }
-        )
-    }
-}
-
 #[derive(Debug, Eq, PartialEq, Copy, Clone)]
 pub enum Tag {
     Text,    // Text that shouldn't be emphasized.
@@ -84,7 +78,7 @@ impl Tag {
         Self::Error,
     ];
 
-    pub fn to_str(self) -> &'static str {
+    pub fn as_str(&self) -> &'static str {
         match self {
             Tag::Text => "",
             Tag::Name => "name",

mitmproxy-rs/mitmproxy_rs/syntax_highlight.pyi

@@ -6,10 +6,14 @@ from typing import Literal
 def highlight(text: str, language: Literal["xml", "yaml", "error", "none"]) -> list[tuple[str, str]]:
     pass
 
+def languages() -> list[str]:
+    pass
+
 def tags() -> list[str]:
     pass
 
 __all__ = [
     "highlight",
+    "languages",
     "tags",
 ]

mitmproxy-rs/src/contentviews.rs

@@ -117,8 +117,8 @@ impl Contentview {
 
     /// Optional syntax highlighting that should be applied to the prettified output.
     #[getter]
-    pub fn syntax_highlight(&self) -> String {
-        self.0.syntax_highlight().to_string()
+    pub fn syntax_highlight(&self) -> &'static str {
+        self.0.syntax_highlight().as_str()
     }
 
     fn __lt__(&self, py: Python<'_>, other: PyObject) -> PyResult<bool> {

mitmproxy-rs/src/lib.rs

@@ -136,6 +136,8 @@ mod mitmproxy_rs {
         #[pymodule_export]
         use crate::syntax_highlight::highlight;
         #[pymodule_export]
+        use crate::syntax_highlight::languages;
+        #[pymodule_export]
         use crate::syntax_highlight::tags;
     }
 }

mitmproxy-rs/src/syntax_highlight.rs

@@ -22,18 +22,24 @@ pub fn highlight(text: String, language: &str) -> PyResult<Vec<(&'static str, St
         .map(|chunks| {
             chunks
                 .into_iter()
-                .map(|(tag, text)| (tag.to_str(), text))
+                .map(|(tag, text)| (tag.as_str(), text))
                 .collect()
         })
         .map_err(|e| PyValueError::new_err(format!("{:?}", e)))
 }
 
-/// Return the list of all possible tag names for a given language.
+/// Return the list of all possible syntax highlight tags.
 #[pyfunction]
 pub fn tags() -> PyResult<Vec<&'static str>> {
     Ok(Tag::VALUES
         .iter()
-        .map(|tag| tag.to_str())
+        .map(|tag| tag.as_str())
         .filter(|&x| !x.is_empty())
         .collect())
 }
+
+/// Return the list of all supported languages for syntax highlighting.
+#[pyfunction]
+pub fn languages() -> PyResult<Vec<&'static str>> {
+    Ok(Language::VALUES.iter().map(|lang| lang.as_str()).collect())
+}