fix: add an optional return type in headers (#805)

* fix: add an optional return type in headers

* add documentation

docs_src/src/pages/documentation/api_reference/getting_started.mdx

@@ -546,6 +546,9 @@ Either, by using the `headers` field in the `Request` object:
       headers = request.headers
 
       print("These are the request headers: ", headers)
+      existing_header = headers.get("exisiting_header")
+      existing_header = headers.get("exisiting_header", "default_value")
+      exisiting_header = headers["exisiting_header"] # This syntax is also valid
 
       headers.set("modified", "modified_value")
       headers["new_header"] = "new_value" # This syntax is also valid
@@ -563,8 +566,12 @@ Either, by using the `headers` field in the `Request` object:
       headers = request.headers
 
       print("These are the request headers: ", headers)
+      existing_header = headers.get("exisiting_header")
+      existing_header = headers.get("exisiting_header", "default_value")
+      exisiting_header = headers["exisiting_header"] # This syntax is also valid
 
       headers.set("modified", "modified_value")
+      headers["new_header"] = "new_value" # This syntax is also valid
 
       print("These are the modified request headers: ", headers)
 

integration_tests/base_routes.py

@@ -145,6 +145,9 @@ def global_after_request(response: Response):
 
 @app.get("/sync/global/middlewares")
 def sync_global_middlewares(request: Request):
+    print(request.headers)
+    print(request.headers.get("txt"))
+    print(request.headers["txt"])
     assert "global_before" in request.headers
     assert request.headers.get("global_before") == "global_before_request"
     return "sync global middlewares"

src/types/headers.rs

@@ -62,18 +62,15 @@ impl Headers {
         }
     }
 
-    pub fn get(&self, key: String) -> PyResult<String> {
+    pub fn get(&self, key: String) -> Option<String> {
         // return the last value
         match self.headers.get(&key.to_lowercase()) {
             Some(iter) => {
                 let (_, values) = iter.pair();
                 let last_value = values.last().unwrap();
-                Ok(last_value.to_string())
+                Some(last_value.to_string())
             }
-            None => Err(pyo3::exceptions::PyKeyError::new_err(format!(
-                "KeyError: {}",
-                key
-            ))),
+            None => None,
         }
     }
 
@@ -151,7 +148,7 @@ impl Headers {
         self.set(key, value);
     }
 
-    pub fn __getitem__(&self, key: String) -> PyResult<String> {
+    pub fn __getitem__(&self, key: String) -> Option<String> {
         self.get(key)
     }
 }

src/types/request.rs

@@ -141,7 +141,7 @@ impl Request {
         let body: Vec<u8> = if headers.contains(String::from("content-type"))
             && headers
                 .get(String::from("content-type"))
-                .is_ok_and(|val| val.contains("multipart/form-data"))
+                .is_some_and(|val| val.contains("multipart/form-data"))
         {
             let h = headers.get(String::from("content-type")).unwrap();
             debug!("Content-Type: {:?}", h);