Finish annotating return types in builder.py.

Author: Sachaa-Thanasius

src/rfc3986/builder.py

@@ -19,6 +19,7 @@
 from . import normalizers
 from . import uri
 from . import uri_reference
+from ._typing_compat import Self as _Self
 
 # Modified from urllib.parse in typeshed.
 _QueryType = t.Union[
@@ -87,7 +88,7 @@ def __repr__(self):
         return formatstr.format(b=self)
 
     @classmethod
-    def from_uri(cls, reference: t.Union["uri.URIReference", str]):
+    def from_uri(cls, reference: t.Union["uri.URIReference", str]) -> _Self:
         """Initialize the URI builder from another URI.
 
         Takes the given URI reference and creates a new URI builder instance
@@ -106,7 +107,7 @@ def from_uri(cls, reference: t.Union["uri.URIReference", str]):
             fragment=reference.fragment,
         )
 
-    def add_scheme(self, scheme: str):
+    def add_scheme(self, scheme: str) -> "URIBuilder":
         """Add a scheme to our builder object.
 
         After normalizing, this will generate a new URIBuilder instance with
@@ -130,7 +131,11 @@ def add_scheme(self, scheme: str):
             fragment=self.fragment,
         )
 
-    def add_credentials(self, username: str, password: t.Optional[str]):
+    def add_credentials(
+        self,
+        username: str,
+        password: t.Optional[str],
+    ) -> "URIBuilder":
         """Add credentials as the userinfo portion of the URI.
 
         .. code-block:: python
@@ -163,7 +168,7 @@ def add_credentials(self, username: str, password: t.Optional[str]):
             fragment=self.fragment,
         )
 
-    def add_host(self, host: str):
+    def add_host(self, host: str) -> "URIBuilder":
         """Add hostname to the URI.
 
         .. code-block:: python
@@ -183,7 +188,7 @@ def add_host(self, host: str):
             fragment=self.fragment,
         )
 
-    def add_port(self, port: t.Union[str, int]):
+    def add_port(self, port: t.Union[str, int]) -> "URIBuilder":
         """Add port to the URI.
 
         .. code-block:: python
@@ -222,7 +227,7 @@ def add_port(self, port: t.Union[str, int]):
             fragment=self.fragment,
         )
 
-    def add_path(self, path: str):
+    def add_path(self, path: str) -> "URIBuilder":
         """Add a path to the URI.
 
         .. code-block:: python
@@ -249,7 +254,7 @@ def add_path(self, path: str):
             fragment=self.fragment,
         )
 
-    def extend_path(self, path: str):
+    def extend_path(self, path: str) -> "URIBuilder":
         """Extend the existing path value with the provided value.
 
         .. versionadded:: 1.5.0
@@ -278,7 +283,7 @@ def extend_path(self, path: str):
 
         return self.add_path(path)
 
-    def add_query_from(self, query_items: _QueryType):
+    def add_query_from(self, query_items: _QueryType) -> "URIBuilder":
         """Generate and add a query a dictionary or list of tuples.
 
         .. code-block:: python
@@ -304,7 +309,7 @@ def add_query_from(self, query_items: _QueryType):
             fragment=self.fragment,
         )
 
-    def extend_query_with(self, query_items: _QueryType):
+    def extend_query_with(self, query_items: _QueryType) -> "URIBuilder":
         """Extend the existing query string with the new query items.
 
         .. versionadded:: 1.5.0
@@ -325,7 +330,7 @@ def extend_query_with(self, query_items: _QueryType):
 
         return self.add_query_from(original_query_items + query_items)
 
-    def add_query(self, query: str):
+    def add_query(self, query: str) -> "URIBuilder":
         """Add a pre-formated query string to the URI.
 
         .. code-block:: python
@@ -345,7 +350,7 @@ def add_query(self, query: str):
             fragment=self.fragment,
         )
 
-    def add_fragment(self, fragment: str):
+    def add_fragment(self, fragment: str) -> "URIBuilder":
         """Add a fragment to the URI.
 
         .. code-block:: python
@@ -390,7 +395,7 @@ def finalize(self) -> "uri.URIReference":
             self.fragment,
         )
 
-    def geturl(self):
+    def geturl(self) -> str:
         """Generate the URL from this builder.
 
         .. versionadded:: 1.5.0