Add API changelog

Fix import of get_service after rebase

Author: Lotram

bugwarrior/config/__init__.py

@@ -15,9 +15,9 @@
     StrippedTrailingSlashUrl,  # noqa: F401
     TaskrcPath,  # noqa: F401
     UnsupportedOption,  # noqa: F401
+    get_service,  # noqa:F401
 )
 from .secrets import get_keyring  # noqa: F401
-from .validation import get_service  # noqa:F401
 
 # NOTE: __all__ determines the stable, public API.
 __all__ = [BugwarriorData.__name__, MainSectionConfig.__name__, ServiceConfig.__name__]

bugwarrior/config/schema.py

@@ -1,9 +1,11 @@
+from functools import cache
+from importlib.metadata import entry_points
 import logging
 import os
 from pathlib import Path
 import re
 import typing
-from typing import Annotated, Any, Literal
+from typing import TYPE_CHECKING, Annotated, Any, Literal
 
 import pydantic
 from pydantic import (
@@ -23,6 +25,9 @@
 
 from .data import BugwarriorData, get_data_path
 
+if TYPE_CHECKING:
+    from bugwarrior.services import Service
+
 log = logging.getLogger(__name__)
 
 Priority = Literal['', 'L', 'M', 'H']
@@ -215,8 +220,6 @@ class ServiceConfig(_ServiceConfig):
 
     @property
     def keyring_service(self) -> str:
-        # FIXME change this import and move it outside method after rebase
-        from bugwarrior.collect import get_service
 
         service = get_service(self.service)
         if service.API_VERSION < 2:
@@ -291,3 +294,23 @@ def deprecate_project_name(cls, value: str) -> str:
             if value != '':
                 log.warning('project_name is deprecated in favor of project_template')
         return value
+
+
+@cache
+def get_service(service_name: str) -> type["Service"]:
+    try:
+        (service,) = entry_points(group='bugwarrior.service', name=service_name)
+    except ValueError as e:
+        if service_name in [
+            'activecollab',
+            'activecollab2',
+            'megaplan',
+            'teamlab',
+            'versionone',
+        ]:
+            log.warning(f"The {service_name} service has been removed.")
+        raise ValueError(
+            f"Configured service '{service_name}' not found. "
+            "Is it installed? Or misspelled?"
+        ) from e
+    return service.load()

bugwarrior/config/validation.py

@@ -1,37 +1,21 @@
-from functools import cache
-from importlib.metadata import entry_points
 import logging
 import sys
 from typing import TYPE_CHECKING, Annotated, Any, NoReturn, Union
 
 from pydantic import Field, TypeAdapter, ValidationError
 from pydantic_core import ErrorDetails
 
-from .schema import BaseConfig, Hooks, MainSectionConfig, Notifications, ServiceConfig
+from .schema import (
+    BaseConfig,
+    Hooks,
+    MainSectionConfig,
+    Notifications,
+    ServiceConfig,
+    get_service,
+)
 
 if TYPE_CHECKING:
     ServiceConfigType = ServiceConfig
-    from bugwarrior.services import Service
-
-
-@cache
-def get_service(service_name: str) -> type["Service"]:
-    try:
-        (service,) = entry_points(group='bugwarrior.service', name=service_name)
-    except ValueError as e:
-        if service_name in [
-            'activecollab',
-            'activecollab2',
-            'megaplan',
-            'teamlab',
-            'versionone',
-        ]:
-            log.warning(f"The {service_name} service has been removed.")
-        raise ValueError(
-            f"Configured service '{service_name}' not found. "
-            "Is it installed? Or misspelled?"
-        ) from e
-    return service.load()
 
 
 log = logging.getLogger(__name__)

bugwarrior/docs/other-services/api.rst

@@ -15,3 +15,14 @@ warning, release notes, or semantic version bumping.
    :exclude-members: __init__,compute_templates,model_config
    :imported-members:
    :member-order: bysource
+
+Changelog
+---------
+
+v2.0
+~~~~
+
+- Removed ``Service.get_keyring_service(config)``. Service configurations should
+  define ``KEYRING_SERVICE`` instead.
+- Added ``ServiceConfig.KEYRING_SERVICE`` as a format string for generating the
+  keyring service identifier from service configuration fields.

tests/test_service.py

@@ -111,7 +111,7 @@ def get_keyring_service(config):
 
         service_config = ServiceConfig(service='legacy', target='legacy-target')
         with unittest.mock.patch(
-            'bugwarrior.collect.get_service', lambda _: LegacyService
+            'bugwarrior.config.schema.get_service', lambda _: LegacyService
         ):
             self.assertEqual(service_config.keyring_service, 'legacy://legacy-target')