Change import dependency graph

config/__init__.py now only imports objects for the public API
get_service function is now defined in services/__init__.py

Author: Lotram

bugwarrior/collect.py

@@ -1,7 +1,5 @@
 from collections.abc import Iterable, Iterator
 import copy
-from functools import cache
-from importlib.metadata import entry_points
 import json
 import logging
 import multiprocessing
@@ -11,7 +9,7 @@
 from jinja2 import Template
 from taskw.task import Task
 
-from bugwarrior.types import CollectedIssue, CollectionErrorData, TaskwarriorData
+from bugwarrior.services import CollectedIssue, CollectionErrorData, get_service
 
 if TYPE_CHECKING:
     from bugwarrior.config.validation import Config
@@ -24,26 +22,6 @@
 SERVICE_FINISHED_ERROR = 1
 
 
-@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()
-
-
 def get_service_instances(conf: "Config") -> list["Service"]:
     return [
         get_service(service_config.service)(service_config, conf.main)
@@ -116,8 +94,7 @@ def aggregate_issues(
     while currently_running > 0:
         issue = queue.get(True)
         try:
-            record = TaskConstructor(issue).get_data_to_sync()
-            yield record
+            yield TaskConstructor(issue).get_data_to_sync()
         except AttributeError:
             if isinstance(issue, tuple):
                 currently_running -= 1
@@ -132,7 +109,7 @@ def aggregate_issues(
 
 
 def make_unique_identifier(
-    unique_keys: Iterable[str], taskwarrior_data: TaskwarriorData
+    unique_keys: Iterable[str], taskwarrior_data: dict[str, Any]
 ) -> str:
     """For a given issue, make an identifier from its unique keys.
 

bugwarrior/command.py

@@ -12,7 +12,8 @@
 from lockfile.pidlockfile import PIDLockFile
 
 from bugwarrior.collect import aggregate_issues, get_service
-from bugwarrior.config import get_config_path, get_keyring, load_config
+from bugwarrior.config.load import get_config_path, load_config
+from bugwarrior.config.secrets import get_keyring
 from bugwarrior.db import get_defined_udas_as_strings, synchronize
 
 if TYPE_CHECKING:

bugwarrior/config/__init__.py

@@ -4,19 +4,7 @@
 """
 
 from .data import BugwarriorData
-from .load import BUGWARRIORRC, get_config_path, load_config  # noqa: F401
-from .schema import (
-    ConfigList,  # noqa: F401
-    ExpandedPath,  # noqa: F401
-    MainSectionConfig,
-    NoSchemeUrl,  # noqa: F401
-    Priority,  # noqa: F401
-    ServiceConfig,
-    StrippedTrailingSlashUrl,  # noqa: F401
-    TaskrcPath,  # noqa: F401
-    UnsupportedOption,  # noqa: F401
-)
-from .secrets import get_keyring  # noqa: F401
+from .schema import MainSectionConfig, ServiceConfig
 
 # NOTE: __all__ determines the stable, public API.
 __all__ = [BugwarriorData.__name__, MainSectionConfig.__name__, ServiceConfig.__name__]

bugwarrior/config/validation.py

@@ -5,7 +5,7 @@
 from pydantic import Field, TypeAdapter, ValidationError
 from pydantic_core import ErrorDetails
 
-from bugwarrior.collect import get_service
+from bugwarrior.services import get_service
 
 from .schema import BaseConfig, Hooks, MainSectionConfig, Notifications, ServiceConfig
 

bugwarrior/db.py

@@ -8,9 +8,8 @@
 from taskw import TaskWarriorShellout
 from taskw.exceptions import TaskwarriorError
 
-from bugwarrior.collect import get_service
 from bugwarrior.notifications import send_notification
-from bugwarrior.types import CollectedIssue, CollectionErrorData
+from bugwarrior.services import CollectedIssue, CollectionErrorData, get_service
 
 if TYPE_CHECKING:
     from bugwarrior.config.schema import MainSectionConfig

bugwarrior/services/__init__.py

@@ -6,20 +6,22 @@
 import abc
 from collections.abc import Iterable, Iterator
 import datetime
+from functools import cache
+from importlib.metadata import entry_points
 import logging
 import math
 import os
 import re
-from typing import Any, Generic, Optional, TypeVar
+from typing import Any, Generic, NamedTuple, Optional, TypeVar
 import zoneinfo
 
 from dateutil.parser import parse as parse_date
 import dogpile.cache
 from jinja2 import Template
 import requests
 
-from bugwarrior.config import schema, secrets
-from bugwarrior.types import TaskwarriorData
+from bugwarrior.config.schema import MainSectionConfig, Priority, ServiceConfig
+from bugwarrior.config.secrets import get_service_password
 
 log = logging.getLogger(__name__)
 
@@ -41,6 +43,17 @@
 LATEST_API_VERSION = 1.0
 
 
+class CollectedIssue(NamedTuple):
+    taskwarrior_data: dict[str, Any]
+    target: str
+    identifier: str
+
+
+class CollectionErrorData(NamedTuple):
+    error_message: str
+    target: str
+
+
 class URLShortener:
     _instance = None
 
@@ -57,7 +70,7 @@ def shorten(self, url: str) -> str:
         return requests.get(base, params=dict(url=url)).text.strip()
 
 
-def get_processed_url(main_config: schema.MainSectionConfig, url: str) -> str:
+def get_processed_url(main_config: MainSectionConfig, url: str) -> str:
     """Returns a URL with conditional processing.
 
     If the following config key are set:
@@ -107,22 +120,22 @@ class Issue(abc.ABC):
     def __init__(
         self,
         foreign_record: dict[str, Any],
-        config: schema.ServiceConfig,
-        main_config: schema.MainSectionConfig,
+        config: ServiceConfig,
+        main_config: MainSectionConfig,
         extra: dict[str, Any],
     ) -> None:
         #: Data retrieved from the external service.
         self.record = foreign_record
         #: An object whose attributes are this service's configuration values.
-        self.config: schema.ServiceConfig = config
+        self.config = config
         #: An object whose attributes are the
         #: :ref:`common_configuration:Main Section` configuration values.
-        self.main_config: schema.MainSectionConfig = main_config
+        self.main_config = main_config
         #: Data computed by the :class:`Service` class.
         self.extra = extra
 
     @abc.abstractmethod
-    def to_taskwarrior(self) -> TaskwarriorData:
+    def to_taskwarrior(self) -> dict[str, Any]:
         """Transform a foreign record into a taskwarrior dictionary."""
         raise NotImplementedError()
 
@@ -167,7 +180,7 @@ def get_tags_from_labels(
 
         return tags
 
-    def get_priority(self) -> schema.Priority:
+    def get_priority(self) -> Priority:
         """Return the priority of this issue, falling back to ``default_priority`` configuration."""
         return self.PRIORITY_MAP.get(
             self.record.get('priority'), self.config.default_priority
@@ -253,11 +266,9 @@ class Service(abc.ABC, Generic[T_Issue]):
     #: Which class should this service instantiate for holding these issues?
     ISSUE_CLASS: type[T_Issue]
     #: Which class defines this service's configuration options?
-    CONFIG_SCHEMA: type[schema.ServiceConfig]
+    CONFIG_SCHEMA: type[ServiceConfig]
 
-    def __init__(
-        self, config: schema.ServiceConfig, main_config: schema.MainSectionConfig
-    ) -> None:
+    def __init__(self, config: ServiceConfig, main_config: MainSectionConfig) -> None:
         over_version = math.floor(LATEST_API_VERSION) + 1
         if self.API_VERSION >= over_version:
             raise ValueError(
@@ -286,9 +297,7 @@ def get_secret(self, key: str, login: str = 'nousername') -> str:
         password = getattr(self.config, key)
         keyring_service = self.get_keyring_service(self.config)
         if not password or password.startswith("@oracle:"):
-            password = secrets.get_service_password(
-                keyring_service, login, oracle=password
-            )
+            password = get_service_password(keyring_service, login, oracle=password)
         return password
 
     def get_issue_for_record(
@@ -362,7 +371,7 @@ def issues(self) -> Iterator[T_Issue]:
 
     @staticmethod
     @abc.abstractmethod
-    def get_keyring_service(config: schema.ServiceConfig) -> str:
+    def get_keyring_service(config: ServiceConfig) -> str:
         """Return the keyring name for this service."""
         raise NotImplementedError
 
@@ -386,5 +395,25 @@ def json_response(response: requests.Response) -> Any:
         return response.json()
 
 
+@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()
+
+
 # NOTE: __all__ determines the stable, public API.
 __all__ = [Client.__name__, Issue.__name__, Service.__name__]

bugwarrior/services/azuredevops.py

@@ -8,21 +8,21 @@
 from pydantic import BeforeValidator
 import requests
 
-from bugwarrior import config
+from bugwarrior.config import schema
 from bugwarrior.services import Client, Issue, Service
 
 log = logging.getLogger(__name__)
 
 EscapedStr = Annotated[str, BeforeValidator(quote)]
 
 
-class AzureDevopsConfig(config.ServiceConfig):
+class AzureDevopsConfig(schema.ServiceConfig):
     service: Literal['azuredevops']
     PAT: str
     project: EscapedStr
     organization: EscapedStr
 
-    host: config.NoSchemeUrl = 'dev.azure.com'
+    host: schema.NoSchemeUrl = 'dev.azure.com'
     wiql_filter: str = ''
 
 
@@ -135,9 +135,9 @@ class AzureDevopsIssue(Issue):
     }
     UNIQUE_KEY = (URL,)
 
-    PRIORITY_MAP: dict[str, config.Priority] = {"1": "H", "2": "M", "3": "L", "4": "L"}
+    PRIORITY_MAP: dict[str, schema.Priority] = {"1": "H", "2": "M", "3": "L", "4": "L"}
 
-    def get_priority(self) -> config.Priority:
+    def get_priority(self) -> schema.Priority:
         value = self.record["fields"].get(
             "Microsoft.VSTS.Common.Priority", self.config.default_priority
         )
@@ -188,7 +188,7 @@ class AzureDevopsService(Service[AzureDevopsIssue]):
     CONFIG_SCHEMA = AzureDevopsConfig
 
     def __init__(
-        self, config: AzureDevopsConfig, main_config: config.MainSectionConfig
+        self, config: AzureDevopsConfig, main_config: schema.MainSectionConfig
     ) -> None:
         super().__init__(config, main_config)
         self.client = AzureDevopsClient(

bugwarrior/services/bitbucket.py

@@ -4,13 +4,13 @@
 from pydantic import model_validator
 import requests
 
-from bugwarrior import config
+from bugwarrior.config import schema
 from bugwarrior.services import Client, Issue, Service
 
 log = logging.getLogger(__name__)
 
 
-class BitbucketConfig(config.ServiceConfig):
+class BitbucketConfig(schema.ServiceConfig):
     _DEPRECATE_FILTER_MERGE_REQUESTS = True
     filter_merge_requests: Union[bool, Literal['Undefined']] = 'Undefined'
 
@@ -24,8 +24,8 @@ class BitbucketConfig(config.ServiceConfig):
     key: str
     secret: str
 
-    include_repos: config.ConfigList = []
-    exclude_repos: config.ConfigList = []
+    include_repos: schema.ConfigList = []
+    exclude_repos: schema.ConfigList = []
     include_merge_requests: Union[bool, Literal['Undefined']] = 'Undefined'
     project_owner_prefix: bool = False
 
@@ -88,7 +88,7 @@ class BitbucketService(Service[BitbucketIssue]):
     BASE_URL = 'https://bitbucket.org/'
 
     def __init__(
-        self, config: BitbucketConfig, main_config: config.MainSectionConfig
+        self, config: BitbucketConfig, main_config: schema.MainSectionConfig
     ) -> None:
         super().__init__(config, main_config)