Restore doctests in mockhttp.py (#318)

Copilot · mindflayer · web-flow · commit e011f2747ebf · 2026-02-22T21:16:36.000+01:00
* Initial plan

* Restore doctests in mockhttp.py for set_extra_headers, can_handle, and _parse_requestline

Co-authored-by: mindflayer &lt;527325+mindflayer@users.noreply.github.com&gt;

* Add coverage.xml to .gitignore and remove from tracking

Co-authored-by: mindflayer &lt;527325+mindflayer@users.noreply.github.com&gt;

---------

Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: mindflayer &lt;527325+mindflayer@users.noreply.github.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -28,3 +28,4 @@ shippable
 .vscode/
 Pipfile.lock
 requirements.txt
+coverage.xml
diff --git a/mocket/mocks/mockhttp.py b/mocket/mocks/mockhttp.py
@@ -182,10 +182,19 @@ def set_base_headers(self) -> None:
             self.headers["Content-Type"] = do_the_magic(self.body)
 
     def set_extra_headers(self, headers: dict) -> None:
-        """Add extra headers to the response.
+        r"""Add extra headers to the response.
 
         Args:
             headers: Dictionary of additional headers
+
+        >>> r = Response(body="<html />")
+        >>> len(r.headers.keys())
+        6
+        >>> r.set_extra_headers({"foo-bar": "Foobar"})
+        >>> len(r.headers.keys())
+        7
+        >>> encode_to_bytes(r.headers.get("Foo-Bar")) == encode_to_bytes("Foobar")
+        True
         """
         for k, v in headers.items():
             self.headers["-".join(token.capitalize() for token in k.split("-"))] = v
@@ -294,13 +303,20 @@ def _can_handle(self, path: str, qs_dict: dict) -> bool:
         return can_handle
 
     def can_handle(self, data: bytes) -> bool:
-        """Check if this entry can handle the given request data.
+        r"""Check if this entry can handle the given request data.
 
         Args:
             data: Request data
 
         Returns:
             True if this entry can handle the request
+
+        >>> e = Entry('http://www.github.com/?bar=foo&foobar', Entry.GET, (Response(b'<html/>'),))
+        >>> e.can_handle(b'GET /?bar=foo HTTP/1.1\r\nHost: github.com\r\nAccept-Encoding: gzip, deflate\r\nConnection: keep-alive\r\nUser-Agent: python-requests/2.7.0 CPython/3.4.3 Linux/3.19.0-16-generic\r\nAccept: */*\r\n\r\n')
+        False
+        >>> e = Entry('http://www.github.com/?bar=foo&foobar', Entry.GET, (Response(b'<html/>'),))
+        >>> e.can_handle(b'GET /?bar=foo&foobar HTTP/1.1\r\nHost: github.com\r\nAccept-Encoding: gzip, deflate\r\nConnection: keep-alive\r\nUser-Agent: python-requests/2.7.0 CPython/3.4.3 Linux/3.19.0-16-generic\r\nAccept: */*\r\n\r\n')
+        True
         """
         try:
             requestline, _ = decode_from_bytes(data).split(CRLF, 1)
@@ -322,6 +338,8 @@ def can_handle(self, data: bytes) -> bool:
     def _parse_requestline(line: str) -> tuple:
         """Parse an HTTP request line.
 
+        http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5
+
         Args:
             line: HTTP request line string
 
@@ -330,6 +348,15 @@ def _parse_requestline(line: str) -> tuple:
 
         Raises:
             ValueError: If line is not a valid request line
+
+        >>> Entry._parse_requestline('GET / HTTP/1.0') == ('GET', '/', '1.0')
+        True
+        >>> Entry._parse_requestline('post /testurl htTP/1.1') == ('POST', '/testurl', '1.1')
+        True
+        >>> Entry._parse_requestline('Im not a RequestLine')
+        Traceback (most recent call last):
+            ...
+        ValueError: Not a Request-Line
         """
         m = re.match(
             r"({})\s+(.*)\s+HTTP/(1.[0|1])".format("|".join(Entry.METHODS)), line, re.I
