Add new method without_query_params to drop query keys

CHANGES/898.feature.rst

@@ -0,0 +1 @@
+Added ``without_query_params`` method, to drop some parameters from query string -- by :user:`hongquan`.

docs/api.rst

@@ -733,6 +733,12 @@ section generates a new :class:`URL` instance.
  Support subclasses of :class:`int` (except :class:`bool`) and :class:`float`
  as a query parameter value.
 
+.. method:: URL.without_query_params(*keys)
+
+ Return a new URL whose *query* part does not contain specified keys.
+
+ It does nothing if none of specified keys are present in the query.
+
 .. method:: URL.with_fragment(fragment)
 
  Return a new URL with *fragment* replaced, auto-encode *fragment* if needed.

tests/test_url_query.py

@@ -1,4 +1,4 @@
-from typing import List, Tuple
+from typing import List, Sequence, Tuple
 from urllib.parse import parse_qs, urlencode
 
 import pytest
@@ -171,3 +171,41 @@ def test_query_from_empty_update_query(
 
  if "b" in original_url.query:
  assert new_url.query["b"] == original_url.query["b"]
+
+
+@pytest.mark.parametrize(
+ ("original_query_string", "keys_to_drop", "expected_query_string"),
+ [
+ ("a=10&b=M%C3%B9a+xu%C3%A2n&u%E1%BB%91ng=cafe", ["a"], "b=Mùa xuân&uống=cafe"),
+ ("a=10&b=M%C3%B9a+xu%C3%A2n", ["b"], "a=10"),
+ ("a=10&b=M%C3%B9a+xu%C3%A2n&c=30", ["b"], "a=10&c=30"),
+ (
+ "a=10&b=M%C3%B9a+xu%C3%A2n&u%E1%BB%91ng=cafe",
+ ["uống"],
+ "a=10&b=Mùa xuân",
+ ),
+ ("a=10&b=M%C3%B9a+xu%C3%A2n", ["a", "b"], ""),
+ ],
+)
+def test_without_query_params(
+ original_query_string: str, keys_to_drop: Sequence[str], expected_query_string: str
+):
+ url = URL(f"http://example.com?{original_query_string}")
+ new_url = url.without_query_params(*keys_to_drop)
+ assert new_url.query_string == expected_query_string
+ assert new_url is not url
+
+
+@pytest.mark.parametrize(
+ ("original_query_string", "keys_to_drop"),
+ [
+ ("a=10&b=M%C3%B9a+xu%C3%A2n&c=30", ["invalid_key"]),
+ ("a=10&b=M%C3%B9a+xu%C3%A2n", []),
+ ],
+)
+def test_skip_dropping_query_params(
+ original_query_string: str, keys_to_drop: Sequence[str]
+):
+ url = URL(f"http://example.com?{original_query_string}")
+ new_url = url.without_query_params(*keys_to_drop)
+ assert new_url is url

yarl/_url.py

@@ -63,7 +63,6 @@ class CacheInfo(TypedDict):
 
 
 class _SplitResultDict(TypedDict, total=False):
-
  scheme: str
  netloc: str
  path: str
@@ -1163,6 +1162,19 @@ def update_query(self, *args: Any, **kwargs: Any) -> "URL":
  self._val._replace(query=self._get_str_query(query) or ""), encoded=True
  )
 
+ def without_query_params(self, *query_params: str) -> "URL":
+ """Remove some keys from query part and return new URL."""
+ params_to_remove = set(query_params) & self.query.keys()
+ if not params_to_remove:
+ return self
+ return self.with_query(
+ tuple(
+ (name, value)
+ for name, value in self.query.items()
+ if name not in params_to_remove
+ )
+ )
+
  def with_fragment(self, fragment: Optional[str]) -> "URL":
  """Return a new URL with fragment replaced.