refactor: Python 3.11 support, update URL map field (#433)

Author: tony

.github/workflows/docs.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.11"]
     steps:
       - uses: actions/checkout@v3
       - name: Filter changed file paths to outputs

.github/workflows/tests.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.9', '3.10' ]
+        python-version: [ '3.9', '3.11' ]
     steps:
       - uses: actions/checkout@v3
       - name: Install poetry
@@ -59,7 +59,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.11"]
 
     steps:
       - uses: actions/checkout@v3

.python-version

@@ -1 +1 @@
-3.10.7 3.9.13
+3.11.0 3.10.7 3.9.13

.tool-versions

@@ -1,2 +1,2 @@
 poetry 1.2.1
-python 3.10.7 3.9.13
+python 3.11.0 3.10.7 3.9.13

CHANGES

@@ -15,6 +15,28 @@ $ pip install --user --upgrade --pre libvcs
 
 <!-- Maintainers, insert changes / features for the next release here -->
 
+### What's new
+
+#### Python 3.11 support (#433)
+
+Official support for python 3.11
+
+#### URLs: Mapping now class attributes (#433)
+
+`URL.rule_map` is now a class attribute rather than a dataclass attribute.
+
+```console
+  File "/home/user/.python/3.11.0/lib/python3.11/dataclasses.py", line 1211, in wrap
+    return _process_class(cls, init, repr, eq, order, unsafe_hash,
+           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  File "/home/user/.python/3.11.0/lib/python3.11/dataclasses.py", line 959, in _process_class
+    cls_fields.append(_get_field(cls, name, type, kw_only))
+                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  File "/home/user/.python/3.11.0/lib/python3.11/dataclasses.py", line 816, in _get_field
+    raise ValueError(f'mutable default {type(f.default)} for field '
+ValueError: mutable default <class 'libvcs.url.base.RuleMap'> for field rule_map is not allowed: use default_factory
+```
+
 ## libvcs 0.19.1 (2022-10-23)
 
 #### Tests
@@ -23,8 +45,7 @@ $ pip install --user --upgrade --pre libvcs
 
 #### Documentation
 
-- CLI, git: Split subcommands into separate pages (remote, stash, submodule),
-  via #432
+- CLI, git: Split subcommands into separate pages (remote, stash, submodule), via #432
 
 ## libvcs 0.19.0 (2022-10-23)
 

MIGRATION

@@ -24,6 +24,47 @@ _Notes on the upcoming release will be added here_
 
 <!-- Maintainers, insert migration notes for the next release here -->
 
+### URLs: Mapping now class attributes (#433)
+
+`URL.rule_map` is now a class attribute rather than a dataclass attribute.
+
+Before:
+
+```python
+@dataclasses.dataclass(repr=False)
+class GitLabURL(GitURL):
+    rule_map: RuleMap = RuleMap(
+        _rule_map={'gitlab_prefix': GitLabPrefix}
+    )
+```
+
+In python 3.11, that raises an error:
+
+```console
+  File "/home/user/.python/3.11.0/lib/python3.11/dataclasses.py", line 1211, in wrap
+    return _process_class(cls, init, repr, eq, order, unsafe_hash,
+           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  File "/home/user/.python/3.11.0/lib/python3.11/dataclasses.py", line 959, in _process_class
+    cls_fields.append(_get_field(cls, name, type, kw_only))
+                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  File "/home/user/.python/3.11.0/lib/python3.11/dataclasses.py", line 816, in _get_field
+    raise ValueError(f'mutable default {type(f.default)} for field '
+ValueError: mutable default <class 'libvcs.url.base.RuleMap'> for field rule_map is not allowed: use default_factory
+```
+
+After release:
+
+```python
+>>> import dataclasses
+>>> from libvcs.url.base import RuleMap
+>>> from libvcs.url.git import GitURL, DEFAULT_RULES
+>>> @dataclasses.dataclass(repr=False)
+... class MyGitURL(GitURL):
+...     rule_map = RuleMap(
+...         _rule_map={'gitlab_prefix': DEFAULT_RULES}
+...     )
+```
+
 <!---
 # vim: set filetype=markdown:
 -->

docs/url/registry.md

@@ -60,7 +60,7 @@ Prefix for KDE infrastructure, `kde:group/repository`:
 
 >>> @dataclasses.dataclass(repr=False)
 ... class MyGitURLParser(GitURL):
-...    rule_map: RuleMap = RuleMap(
+...    rule_map = RuleMap(
 ...        _rule_map={
 ...            **GitURL.rule_map._rule_map,
 ...            'github_prefix': GitHubPrefix,

src/libvcs/url/base.py

@@ -101,7 +101,7 @@ def register(self, cls: Rule) -> None:
 
         >>> @dataclasses.dataclass(repr=False)
         ... class GitHubURL(GitURL):
-        ...    rule_map: RuleMap = RuleMap(
+        ...    rule_map = RuleMap(
         ...        _rule_map={'github_prefix': GitHubPrefix}
         ...    )
 
@@ -151,7 +151,7 @@ def register(self, cls: Rule) -> None:
 
         >>> @dataclasses.dataclass(repr=False)
         ... class GitLabURL(GitURL):
-        ...     rule_map: RuleMap = RuleMap(
+        ...     rule_map = RuleMap(
         ...         _rule_map={'gitlab_prefix': GitLabPrefix}
         ...     )
 
@@ -187,7 +187,7 @@ def register(self, cls: Rule) -> None:
 
         >>> @dataclasses.dataclass(repr=False)
         ... class GitURLWithPip(GitBaseURL):
-        ...    rule_map: RuleMap = RuleMap(
+        ...    rule_map = RuleMap(
         ...        _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
         ...    )
 

src/libvcs/url/git.py

@@ -262,8 +262,11 @@ class GitBaseURL(URLProtocol, SkipDefaultFieldsReprMixin):
     # Decoration
     suffix: Optional[str] = None
 
+    # Matched
     rule: Optional[str] = None
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_RULES})
+
+    # Settings
+    rule_map = RuleMap(_rule_map={m.label: m for m in DEFAULT_RULES})
 
     def __post_init__(self) -> None:
         url = self.url
@@ -382,7 +385,7 @@ class GitPipURL(GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin):
     # commit-ish (rev): tag, branch, ref
     rev: Optional[str] = None
 
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in PIP_DEFAULT_RULES})
+    rule_map = RuleMap(_rule_map={m.label: m for m in PIP_DEFAULT_RULES})
 
     def to_url(self) -> str:
         """Exports a pip-compliant URL.
@@ -490,7 +493,7 @@ class GitURL(GitPipURL, GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin):
       - :meth:`GitBaseURL.to_url`
     """
 
-    rule_map: RuleMap = RuleMap(
+    rule_map = RuleMap(
         _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
     )
 

src/libvcs/url/hg.py

@@ -204,7 +204,7 @@ class HgBaseURL(URLProtocol, SkipDefaultFieldsReprMixin):
     rule: Optional[str] = None
     # name of the :class:`Rule`
 
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_RULES})
+    rule_map = RuleMap(_rule_map={m.label: m for m in DEFAULT_RULES})
 
     def __post_init__(self) -> None:
         url = self.url
@@ -342,7 +342,7 @@ class HgPipURL(HgBaseURL, URLProtocol, SkipDefaultFieldsReprMixin):
     # commit-ish (rev): tag, branch, ref
     rev: Optional[str] = None
 
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in PIP_DEFAULT_RULES})
+    rule_map = RuleMap(_rule_map={m.label: m for m in PIP_DEFAULT_RULES})
 
     @classmethod
     def is_valid(cls, url: str, is_explicit: Optional[bool] = None) -> bool:
@@ -424,7 +424,7 @@ class HgURL(HgPipURL, HgBaseURL, URLProtocol, SkipDefaultFieldsReprMixin):
       - :meth:`HgBaseURL.to_url`
     """
 
-    rule_map: RuleMap = RuleMap(
+    rule_map = RuleMap(
         _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
     )