Migrate to using propcache for property caching (#1169)

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <webknjaz@redhat.com>
aio-libs · Oct 8, 2024 · 4f35eda · 4f35eda
1 parent 31c9fee
commit 4f35eda
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 208 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -113,6 +113,15 @@ body:
       $ python -m pip show multidict
   validations:
     required: true
+- type: textarea
+  attributes:
+    label: propcache Version
+    description: Attach your version of propcache.
+    render: console
+    value: |
+      $ python -m pip show propcache
+  validations:
+    required: true
 - type: textarea
   attributes:
     label: yarl Version

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -116,6 +116,7 @@ repos:
     - hypothesis
     - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
     - multidict
+    - propcache >= 0.2.0
     - pytest
     - tomli  # requirement of packaging/pep517_backend/
     - types-setuptools  # requirement of packaging/pep517_backend/
@@ -132,6 +133,7 @@ repos:
     - hypothesis
     - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
     - multidict
+    - propcache >= 0.2.0
     - pytest
     - tomli  # requirement of packaging/pep517_backend/
     - types-setuptools  # requirement of packaging/pep517_backend/
@@ -148,6 +150,7 @@ repos:
     - hypothesis
     - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
     - multidict
+    - propcache >= 0.2.0
     - pytest
     - tomli  # requirement of packaging/pep517_backend/
     - types-setuptools  # requirement of packaging/pep517_backend/
@@ -166,6 +169,7 @@ repos:
     - hypothesis
     - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
     - multidict
+    - propcache >= 0.2.0
     - pytest
     - tomli  # requirement of packaging/pep517_backend/
     - types-setuptools  # requirement of packaging/pep517_backend/

diff --git a/CHANGES/1169.packaging.rst b/CHANGES/1169.packaging.rst
@@ -0,0 +1,6 @@
+Switched to using the :mod:`propcache <propcache.api>` package for property caching
+-- by :user:`bdraco`.
+
+The :mod:`propcache <propcache.api>` package is derived from the property caching
+code in :mod:`yarl` and has been broken out to avoid maintaining it for multiple
+projects.
diff --git a/README.rst b/README.rst
@@ -128,7 +128,7 @@ by this variable.
 Dependencies
 ------------
 
-YARL requires multidict_ library.
+YARL requires multidict_ and propcache_ libraries.
 
 
 API documentation
@@ -203,3 +203,5 @@ It's *Apache 2* licensed and freely available.
 .. _GitHub: https://github.com/aio-libs/yarl
 
 .. _multidict: https://github.com/aio-libs/multidict
+
+.. _propcache: https://github.com/aio-libs/propcache
diff --git a/docs/conf.py b/docs/conf.py
@@ -84,6 +84,7 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "multidict": ("https://multidict.aio-libs.org/en/stable", None),
+    "propcache": ("https://propcache.aio-libs.org/en/stable", None),
 }
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -116,7 +116,7 @@ by this variable.
 Dependencies
 ------------
 
-``yarl`` requires :mod:`multidict` library.
+``yarl`` requires the :mod:`multidict` and :mod:`propcache <propcache.api>` libraries.
 
 It installs it automatically.
 

diff --git a/requirements/test.txt b/requirements/test.txt
@@ -3,6 +3,7 @@ covdefaults
 hypothesis>=6.0
 idna==3.10
 multidict==6.1.0
+propcache==0.2.0
 pytest==8.3.3
 pytest-cov>=2.3.1
 pytest-xdist
diff --git a/setup.cfg b/setup.cfg
@@ -68,6 +68,7 @@ include_package_data = True
 install_requires =
   idna >= 2.0
   multidict >= 4.0
+  propcache >= 0.2.0
 
 [options.package_data]
 # Ref:

diff --git a/tests/test_helpers.py b/tests/test_helpers.py
diff --git a/yarl/_helpers.py b/yarl/_helpers.py
diff --git a/yarl/_helpers_c.pyi b/yarl/_helpers_c.pyi
diff --git a/yarl/_helpers_c.pyx b/yarl/_helpers_c.pyx
diff --git a/yarl/_helpers_py.py b/yarl/_helpers_py.py
diff --git a/yarl/_url.py b/yarl/_url.py
@@ -32,8 +32,8 @@
 
 import idna
 from multidict import MultiDict, MultiDictProxy, istr
+from propcache.api import under_cached_property as cached_property
 
-from ._helpers import cached_property
 from ._quoting import _Quoter, _Unquoter
 
 DEFAULT_PORTS = {"http": 80, "https": 443, "ws": 80, "wss": 443, "ftp": 21}