devopsdriver 0.1.51__tar.gz → 0.1.53__tar.gz

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devopsdriver
-Version: 0.1.51
+Version: 0.1.53
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -47,11 +47,11 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.3
-Requires-Dist: keyring==25.6.0
-Requires-Dist: setuptools==80.9.0
+Requires-Dist: keyring==25.7.0
+Requires-Dist: setuptools==82.0.1
 Requires-Dist: azure-devops==7.1.0b4
-Requires-Dist: Mako==1.3.10
-Requires-Dist: PyGithub==2.5.0
+Requires-Dist: Mako==1.3.11
+Requires-Dist: PyGithub==2.9.1
 Provides-Extra: dev
 Requires-Dist: black>=24.3.0; extra == "dev"
 Requires-Dist: pylint>=3.1.0; extra == "dev"
@@ -64,7 +64,7 @@ Dynamic: license-file
 # devops-driver
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.51&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.51/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.53&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.53/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
@@ -75,7 +75,7 @@ Dynamic: license-file
 [![size sheild](https://img.shields.io/github/languages/code-size/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver)
 
 [![example workflow](https://github.com/marcpage/devops-driver/actions/workflows/pr.yml/badge.svg)](https://github.com/marcpage/devops-driver/actions/workflows/pr.yml)
-[![status sheild](https://img.shields.io/static/v1?label=test+coverage&message=98%&color=active&style=plastic)](https://github.com/marcpage/devops-driver/blob/main/Makefile#L4)
+[![status sheild](https://img.shields.io/static/v1?label=test+coverage&message=97%&color=active&style=plastic)](https://github.com/marcpage/devops-driver/blob/main/Makefile#L4)
 [![issues sheild](https://img.shields.io/github/issues-raw/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/issues)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/pulls)
 

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/README.md

@@ -1,7 +1,7 @@
 # devops-driver
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.51&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.51/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.53&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.53/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
@@ -12,7 +12,7 @@
 [![size sheild](https://img.shields.io/github/languages/code-size/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver)
 
 [![example workflow](https://github.com/marcpage/devops-driver/actions/workflows/pr.yml/badge.svg)](https://github.com/marcpage/devops-driver/actions/workflows/pr.yml)
-[![status sheild](https://img.shields.io/static/v1?label=test+coverage&message=98%&color=active&style=plastic)](https://github.com/marcpage/devops-driver/blob/main/Makefile#L4)
+[![status sheild](https://img.shields.io/static/v1?label=test+coverage&message=97%&color=active&style=plastic)](https://github.com/marcpage/devops-driver/blob/main/Makefile#L4)
 [![issues sheild](https://img.shields.io/github/issues-raw/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/issues)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/pulls)
 

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/__init__.py

@@ -6,7 +6,6 @@ from .template import Template
 from .azdo.clients import Azure
 from .github.client import Github
 
-
-__version__ = "0.1.51"
+__version__ = "0.1.53"
 __author__ = "Marc Page"
 __credits__ = ""

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/__init__.py

@@ -6,6 +6,6 @@ from .clients import Azure
 from .timestamp import Timestamp
 
 from .workitem.wiql import Wiql, Value, Field
-from .workitem.wiql import Ascending, Descending, And, Or, In, NotIn
+from .workitem.wiql import Ascending, Descending, And, Or, In, NotIn, Under
 from .workitem.wiql import Equal, NotEqual, LessThanOrEqual, GreaterThanOrEqual
 from .workitem.wiql import IsEmpty, IsNotEmpty, LessThan, GreaterThan

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/azureobject.py

@@ -3,7 +3,6 @@
 
 """An Azure Devops WorkItem"""
 
-
 from msrest.serialization import Model
 
 from devopsdriver.azdo.timestamp import Timestamp
@@ -17,13 +16,13 @@ class AzureObject(DataObject):  # pylint: disable=too-few-public-methods
         self.raw = azure_object
         super().__init__(self.raw.as_dict())
 
-    def _parse_value(self, data: any) -> any:
+    def _parse_value(self, data):
         if isinstance(data, str) and Timestamp.is_timestamp(data):
             return Timestamp(data)
 
         return super()._parse_value(data)
 
-    def _get_field(self, name: str, data: dict) -> any:
+    def _get_field(self, name: str, data: dict):
         value = super()._get_field(name, data)
 
         if value is None and "fields" in data:

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/builds/client.py

@@ -3,7 +3,6 @@
 
 """Azure Build Client"""
 
-
 from datetime import datetime
 from azure.devops.v7_1.build import BuildClient
 

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/clients.py

@@ -7,7 +7,6 @@ API Documented here:
 https://github.com/microsoft/azure-devops-python-api
 """
 
-
 from azure.devops.connection import Connection as AzureConnection
 from msrest.authentication import BasicAuthentication as MSBasicAuthentication
 
@@ -16,7 +15,6 @@ from devopsdriver.azdo.workitem.client import Client as WIClient
 from devopsdriver.azdo.pipeline.client import Client as PLClient
 from devopsdriver.azdo.builds.client import Client as BClient
 
-
 # for testing
 CONNECTION = AzureConnection
 AUTHENTICATION = MSBasicAuthentication

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/pipeline/client.py

@@ -3,7 +3,6 @@
 
 """Pipeline client"""
 
-
 from azure.devops.v7_1.pipelines import PipelinesClient
 
 from .pipeline import Pipeline

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/pipeline/log.py

@@ -3,15 +3,13 @@
 
 """Azure Pipeline Run Log"""
 
-
 from azure.devops.v7_1.pipelines.models import Log as AzureLog
 
 from requests import get as get_url
 
 from devopsdriver.azdo.azureobject import AzureObject
 
-
-GET_URL = get_url
+GET_URL = get_url  # pylint: disable=invalid-name
 
 
 class Log(AzureObject):  # pylint: disable=too-few-public-methods

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/pipeline/pipeline.py

@@ -3,7 +3,6 @@
 
 """Azure Pipeline"""
 
-
 from azure.devops.v7_1.pipelines.models import Pipeline as AzurePipeline
 from azure.devops.v7_1.pipelines import PipelinesClient
 

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/pipeline/run.py

@@ -3,7 +3,6 @@
 
 """Pipeline Run"""
 
-
 from azure.devops.v7_1.pipelines.models import Pipeline
 from azure.devops.v7_1.pipelines.models import Run as AzureRun
 from azure.devops.v7_1.pipelines import PipelinesClient

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/timestamp.py

@@ -3,7 +3,6 @@
 
 """Tools that help when working with Azure"""
 
-
 from datetime import datetime, timezone, timedelta
 from functools import total_ordering
 

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/workitem/client.py

@@ -3,7 +3,6 @@
 
 """Azure WorkItem Client"""
 
-
 from azure.devops.v7_1.work_item_tracking.models import Wiql as AzureWiql
 from azure.devops.v7_1.work_item_tracking.models import WorkItem as AzureWorkItem
 from azure.devops.v7_1.work_item_tracking.models import TeamContext
@@ -21,9 +20,9 @@ class Client:
     def query(
         self,
         wiql: Wiql | str,
-        team_context: TeamContext = None,
-        time_precision: bool = None,
-        top: int = None,
+        team_context: TeamContext | None = None,
+        time_precision: bool | None = None,
+        top: int | None = None,
     ) -> WorkItemQueryResult:
         """Perform a wiql query
 
@@ -46,15 +45,15 @@ class Client:
     def get_history(  # pylint: disable=too-many-positional-arguments,too-many-arguments
         self,
         wi_id: int,
-        project: str = None,
-        top: int = None,
-        skip: int = None,
-        expand: str = None,
+        project: str | None = None,
+        top: int | None = None,
+        skip: int | None = None,
+        expand: str | None = None,
     ) -> list[AzureWorkItem]:
         """Simple wrapper around get_revisions"""
         return self.client.get_revisions(wi_id, project, top, skip, expand)
 
-    def find_ids(self, wiql: Wiql | str, top: int = None) -> list[int]:
+    def find_ids(self, wiql: Wiql | str, top: int | None = None) -> list[int]:
         """Given a query, find the work item ids
 
         Args:
@@ -73,9 +72,9 @@ class Client:
         # query_results_type: workItem
         # query_type: flat
         # columns: list of name, reference_name, url
-        return [i.id for i in found.work_items]
+        return [i.id for i in found.work_items] if found.work_items else []
 
-    def find(self, wiql: Wiql | str, top: int = None) -> list[list[AzureObject]]:
+    def find(self, wiql: Wiql | str, top: int | None = None) -> list[list[AzureObject]]:
         """Gets the full history of items found in a WIQL search
 
         Args:

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/azdo/workitem/wiql.py

@@ -19,7 +19,6 @@ ORDER BY [System.ChangedDate] DESC
 ASOF '02-11-2020'
 """
 
-
 from datetime import datetime, date
 
 
@@ -145,13 +144,20 @@ class Compare:  # pylint: disable=too-few-public-methods
         return f"{str(self.left)} {self.operator} {str(self.right)}"
 
 
+class Under(Compare):  # pylint: disable=too-few-public-methods
+    """checks for under, like area path or iteration path"""
+
+    def __init__(self, field_name: Field | str, value: Value | str):
+        super().__init__(field_name, value, "UNDER")
+
+
 class In(Compare):  # pylint: disable=too-few-public-methods
     """checks for field in a list of values"""
 
     def __init__(
         self,
         field: Field | str,
-        *values: list[Value | str | date | datetime | int | float],
+        *values: Value | str | date | datetime | int | float,
     ):
         super().__init__(
             field,
@@ -167,7 +173,7 @@ class NotIn(Compare):  # pylint: disable=too-few-public-methods
     def __init__(
         self,
         field: Field | str,
-        *values: list[Value | str | date | datetime | int | float],
+        *values: Value | str | date | datetime | int | float,
     ):
         super().__init__(
             field,
@@ -234,7 +240,7 @@ class GreaterThanOrEqual(Compare):  # pylint: disable=too-few-public-methods
 class Expression:  # pylint: disable=too-few-public-methods
     """Join several compares"""
 
-    def __init__(self, operator: str, *compares: list[Compare]):
+    def __init__(self, operator: str, *compares):
         self.operator = operator
         self.expressions = compares
 
@@ -245,14 +251,14 @@ class Expression:  # pylint: disable=too-few-public-methods
 class And(Expression):  # pylint: disable=too-few-public-methods
     """Join compares via AND"""
 
-    def __init__(self, *compares: list[Compare | Expression]):
+    def __init__(self, *compares: Compare | Expression):
         super().__init__("AND", *compares)
 
 
 class Or(Expression):  # pylint: disable=too-few-public-methods
     """join compares via OR"""
 
-    def __init__(self, *compares: list[Compare | Expression]):
+    def __init__(self, *compares: Compare | Expression):
         super().__init__("OR", *compares)
 
 
@@ -264,8 +270,10 @@ class Wiql:
         self.search = None
         self.order = []
         self.snapshot = None
+        self.source = "WorkItems"
+        self.mode_type = None
 
-    def select(self, *fields: list[Field | str]):
+    def select(self, *fields: Field | str):
         """The fields to select
 
         Returns:
@@ -286,6 +294,18 @@ class Wiql:
         self.search = expression
         return self
 
+    def from_source(self, source: str):
+        """Sets the FROM field"""
+        self.source = source
+        return self
+
+    def mode(self, results_mode: str):
+        """Sets the mode for link queries
+        results_mode may be one of: MustContain, MayContain, DoesNotContain, Recursive, None
+        """
+        self.mode_type = results_mode
+        return self
+
     def order_by(self, *orders):
         """Set the fields to order the results by
 
@@ -315,4 +335,5 @@ class Wiql:
             f" ORDER BY {', '.join(str(o) for o in self.order)}" if self.order else ""
         )
         asof = f" ASOF {str(self.snapshot)}" if self.snapshot else ""
-        return f"SELECT {select} FROM workitems{where}{order}{asof}"
+        mode = f" MODE({self.mode_type})" if self.mode_type else ""
+        return f"SELECT {select} FROM {self.source}{where}{order}{asof}{mode}"

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/dataobject.py

@@ -2,7 +2,6 @@
 
 """Data Objects"""
 
-
 from json import dumps
 
 

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/github/client.py

@@ -2,7 +2,6 @@
 
 """Manages GitHub connection"""
 
-
 from github import Github as Github_connection, Auth
 
 from devopsdriver.settings import Settings

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/manage_settings.py

@@ -3,7 +3,6 @@
 
 """Module Doc"""
 
-
 from os.path import dirname, join, abspath
 from sys import argv as sys_argv
 from getpass import getpass as os_getpass
@@ -14,9 +13,9 @@ from .settings import Settings
 from .template import Template
 
 ARGV = sys_argv
-PRINT = print
-SET_PASSWORD = set_password
-GET_PASS = os_getpass
+PRINT = print  # pylint: disable=invalid-name
+SET_PASSWORD = set_password  # pylint: disable=invalid-name
+GET_PASS = os_getpass  # pylint: disable=invalid-name
 
 
 def main() -> None:

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/sendmail.py

@@ -3,7 +3,6 @@
 
 """Ability to send emails with embedded images"""
 
-
 from smtplib import SMTP as OS_SMTP, SMTP_SSL as OS_SMTP_SSL
 from email.mime.multipart import MIMEMultipart as OS_MIMEMultipart
 from email.mime.text import MIMEText as OS_MIMEText
@@ -11,7 +10,6 @@ from email.mime.image import MIMEImage as OS_MIMEImage
 
 from devopsdriver.settings import Settings
 
-
 IMAGE_HEADERS = {".png": b"\x89PNG\r\n\x1a\n", ".jpg": b"\xff\xd8\xff"}
 
 # for testing
@@ -41,11 +39,11 @@ def image_extension(data: bytes) -> str:
     raise AttributeError("Image not a known format: " + ",".join(IMAGE_HEADERS))
 
 
-def send_email(
+def send_email(  # pylint: disable=too-many-locals
     recipients: str | list[str],
     subject: str,
     html_body: str,
-    settings: Settings = None,
+    settings: Settings | None = None,
     **image_data,
 ):
     """Sends an email with embedded images
@@ -65,7 +63,9 @@ def send_email(
         ", ".join(missing) + " not found in:\n" + "\n".join(settings.search_files)
     )
     sender = settings["smtp.sender"]
+    assert isinstance(sender, str), sender
     username = settings.get("smtp.username", sender)
+    assert isinstance(username, str), username
     message = MIMEMULTIPART()
     message["Subject"] = subject
     message["From"] = sender
@@ -85,8 +85,14 @@ def send_email(
         )
         message.attach(image)
 
-    with connection_type(settings["smtp.server"], settings["smtp.port"]) as smtp:
+    server = settings["smtp.server"]
+    assert isinstance(server, str), server
+    port = settings["smtp.port"]
+    assert isinstance(port, int), port
+    password = settings["smtp.password"]
+    assert isinstance(password, str), password
+    with connection_type(server, port) as smtp:
         smtp.set_debuglevel(False)
-        smtp.login(username, settings["smtp.password"])
+        smtp.login(username, password)
         smtp.sendmail(sender, recipients, message.as_string())
         smtp.quit()

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/settings.py

@@ -75,7 +75,8 @@ api:
 johndoe and janedoe share the same password, so you just need to update the `user`
 """
 
-
+from __future__ import annotations
+from dataclasses import MISSING, fields, is_dataclass
 from json import load
 from os.path import dirname, basename, splitext, join
 from os import environ as os_environ, makedirs as os_makedirs
@@ -83,22 +84,81 @@ from re import compile as regex
 from platform import system as os_system
 from sys import argv as sys_argv
 from getpass import getpass as os_getpass
+from typing import Any, TypeVar, Union, cast, get_args, get_origin, get_type_hints
 
 from yaml import safe_load
 from keyring import get_password, set_password
 from keyring.backends import fail
 
-
 # for testing
 ENVIRON = os_environ
 ARGV = sys_argv
-SYSTEM = os_system
-MAKEDIRS = os_makedirs
+SYSTEM = os_system  # pylint: disable=invalid-name
+MAKEDIRS = os_makedirs  # pylint: disable=invalid-name
 SHARED = "devopsdriver"
-PRINT = print
-GET_PASSWORD = get_password
-SET_PASSWORD = set_password
-GET_PASS = os_getpass
+PRINT = print  # pylint: disable=invalid-name
+GET_PASSWORD = get_password  # pylint: disable=invalid-name
+SET_PASSWORD = set_password  # pylint: disable=invalid-name
+GET_PASS = os_getpass  # pylint: disable=invalid-name
+T = TypeVar("T")
+
+
+def _is_instance_of_type(  # pylint: disable=too-many-branches, too-many-return-statements
+    value: Any, expected: Any
+) -> bool:
+    """Check if a value matches an expected type, including support for common typing constructs."""
+    if expected is Any:
+        return True
+
+    origin = get_origin(expected)
+    args = get_args(expected)
+
+    if origin is Union:  # Optional[T] / Union[T1, T2, ...]
+        return any(_is_instance_of_type(value, t) for t in args)
+
+    if origin is list:  # list[T]
+        if not isinstance(value, list):
+            return False
+
+        if not args:
+            return True
+
+        item_type = args[0]
+        return all(_is_instance_of_type(v, item_type) for v in value)
+
+    if origin is dict:  # dict[K, V]
+        if not isinstance(value, dict):
+            return False
+
+        if len(args) != 2:
+            return True
+
+        key_type, val_type = args
+        return all(
+            _is_instance_of_type(k, key_type) and _is_instance_of_type(v, val_type)
+            for k, v in value.items()
+        )
+
+    if origin is tuple:  # tuple[T1, T2] or tuple[T, ...]
+        if not isinstance(value, tuple):
+            return False
+
+        if not args:
+            return True
+
+        if len(args) == 2 and args[1] is Ellipsis:
+            return all(_is_instance_of_type(v, args[0]) for v in value)
+
+        if len(value) != len(args):
+            return False
+
+        return all(_is_instance_of_type(v, t) for v, t in zip(value, args))
+
+    try:  # Fallback to normal isinstance
+        return isinstance(value, expected)
+
+    except TypeError:
+        return False  # Covers unsupported runtime checks for some typing constructs
 
 
 def load_json(path: str) -> dict:
@@ -147,7 +207,9 @@ class Settings:
     }
     ENV_VAR_PATTERN = regex(r"\${(\S+)}")
 
-    def __init__(self, file: str, *directories, shared_name: str = None, **settings):
+    def __init__(
+        self, file: str, *directories, shared_name: str | None = None, **settings
+    ):
         """Create a settings object using a file, directories to search, and settings overrides
 
         Args:
@@ -172,7 +234,7 @@ class Settings:
         self.environ = {}
         self.secrets = {}
 
-    def __bypass(self, key: str, name: str, store: dict):
+    def __bypass(self, key: str, name: str | None, store: dict):
         if name is None:
             for setting_key, store_name in self.settings.get(key, {}).items():
                 store[setting_key] = store_name
@@ -181,7 +243,7 @@ class Settings:
         store[key] = name
         return self
 
-    def key(self, key: str, name: str = None):
+    def key(self, key: str, name: str | None = None):
         """Sets a keychain name to map to a settings value.
 
         Args:
@@ -195,7 +257,7 @@ class Settings:
         """
         return self.__bypass(key, name, self.secrets)
 
-    def cli(self, key: str, name: str = None):
+    def cli(self, key: str, name: str | None = None):
         """Sets a command line switch to map to a settings value.
 
         Args:
@@ -209,7 +271,7 @@ class Settings:
         """
         return self.__bypass(key, name, self.opts)
 
-    def env(self, key: str, name: str = None):
+    def env(self, key: str, name: str | None = None):
         """Sets an environment variable to map to a settings value.
 
         Args:
@@ -223,6 +285,37 @@ class Settings:
         """
         return self.__bypass(key, name, self.environ)
 
+    def parse(self, cls: type[T]) -> T:
+        """Extract settings into a dataclass for type safety"""
+        if not is_dataclass(cls):
+            raise TypeError(f"{cls} must be a dataclass type")
+
+        type_hints = get_type_hints(cls)
+        kwargs = {}
+
+        for f in fields(cls):
+            expected_type = type_hints.get(f.name, Any)
+
+            # Pull from settings if present, otherwise use dataclass default/default_factory
+            if self.has(f.name):
+                value = self.get(f.name)
+            elif f.default is not MISSING:
+                value = f.default
+            elif f.default_factory is not MISSING:
+                value = f.default_factory()
+            else:
+                raise KeyError(f"Missing required setting: {f.name}")
+
+            if not _is_instance_of_type(value, expected_type):
+                raise TypeError(
+                    f"Invalid type for '{f.name}': expected {expected_type}, "
+                    + f"got {type(value).__name__}"
+                )
+
+            kwargs[f.name] = value
+
+        return cast(T, cls(**kwargs))
+
     @staticmethod
     def __patch_instance(key: str) -> str:
         for env_key, value in ENVIRON.items():
@@ -232,7 +325,7 @@ class Settings:
         return "${" + key + "}"
 
     @staticmethod
-    def __patch(value: any) -> any:
+    def __patch(value):
         if isinstance(value, str):
             return Settings.ENV_VAR_PATTERN.sub(
                 lambda m: Settings.__patch_instance(m.group(1)), value
@@ -257,7 +350,7 @@ class Settings:
         secret_name = parts[1] if len(parts) == 2 else parts[0]
         return (service, secret_name)
 
-    def __lookup(self, key: str, check: bool, default: any = None) -> any:
+    def __lookup(self, key: str, check: bool, default=None):
         # Settings passed in override everything
         if key in self.overrides:
             return True if check else self.overrides[key]
@@ -293,7 +386,7 @@ class Settings:
 
         return Settings.__patch(level.get(keys[-1], default))
 
-    def get(self, key: str, default: any = None) -> any:
+    def get(self, key: str, default=None):
         """Dictionary-like get
 
         Args:
@@ -314,12 +407,12 @@ class Settings:
         Returns:
             bool: True if the key exists
         """
-        return self.__lookup(key, check=True)
+        return bool(self.__lookup(key, check=True))
 
     def __contains__(self, key: str) -> bool:
         return self.has(key)
 
-    def __getitem__(self, key: str) -> any:
+    def __getitem__(self, key: str):
         if not self.has(key):
             raise KeyError(key)
 
@@ -371,6 +464,6 @@ class Settings:
 
         for extension, name, directory, loader in search_info:
             contents = loader(join(directory, name + extension))
-            Settings.__merge(settings, contents)
+            Settings.__merge(settings, contents if contents else {})
 
         return settings

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver/template.py

@@ -3,7 +3,6 @@
 
 """Module Doc"""
 
-
 from os.path import dirname, basename, splitext
 
 from mako.lookup import TemplateLookup

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devopsdriver
-Version: 0.1.51
+Version: 0.1.53
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -47,11 +47,11 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.3
-Requires-Dist: keyring==25.6.0
-Requires-Dist: setuptools==80.9.0
+Requires-Dist: keyring==25.7.0
+Requires-Dist: setuptools==82.0.1
 Requires-Dist: azure-devops==7.1.0b4
-Requires-Dist: Mako==1.3.10
-Requires-Dist: PyGithub==2.5.0
+Requires-Dist: Mako==1.3.11
+Requires-Dist: PyGithub==2.9.1
 Provides-Extra: dev
 Requires-Dist: black>=24.3.0; extra == "dev"
 Requires-Dist: pylint>=3.1.0; extra == "dev"
@@ -64,7 +64,7 @@ Dynamic: license-file
 # devops-driver
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.51&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.51/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.53&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.53/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
@@ -75,7 +75,7 @@ Dynamic: license-file
 [![size sheild](https://img.shields.io/github/languages/code-size/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver)
 
 [![example workflow](https://github.com/marcpage/devops-driver/actions/workflows/pr.yml/badge.svg)](https://github.com/marcpage/devops-driver/actions/workflows/pr.yml)
-[![status sheild](https://img.shields.io/static/v1?label=test+coverage&message=98%&color=active&style=plastic)](https://github.com/marcpage/devops-driver/blob/main/Makefile#L4)
+[![status sheild](https://img.shields.io/static/v1?label=test+coverage&message=97%&color=active&style=plastic)](https://github.com/marcpage/devops-driver/blob/main/Makefile#L4)
 [![issues sheild](https://img.shields.io/github/issues-raw/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/issues)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/pulls)
 

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/devopsdriver.egg-info/requires.txt

@@ -1,9 +1,9 @@
 PyYAML==6.0.3
-keyring==25.6.0
-setuptools==80.9.0
+keyring==25.7.0
+setuptools==82.0.1
 azure-devops==7.1.0b4
-Mako==1.3.10
-PyGithub==2.5.0
+Mako==1.3.11
+PyGithub==2.9.1
 
 [dev]
 black>=24.3.0

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/pyproject.toml

@@ -7,11 +7,11 @@ dynamic = ["version"]
 requires-python = ">= 3.10"
 dependencies = [
   "PyYAML==6.0.3",
-  "keyring==25.6.0",
-  "setuptools==80.9.0",    # neded for azure-devops to use 7.1 API
+  "keyring==25.7.0",
+  "setuptools==82.0.1",    # neded for azure-devops to use 7.1 API
   "azure-devops==7.1.0b4",
-  "Mako==1.3.10",
-  "PyGithub==2.5.0",
+  "Mako==1.3.11",
+  "PyGithub==2.9.1",
 ]
 keywords = [
   "azure",

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/tests/test_azure_workitem_wiql.py

@@ -1,19 +1,19 @@
 #!/usr/bin/env python3
 
-""" Test work item query language """
+"""Test work item query language"""
 
 from datetime import date, datetime
 
 from devopsdriver.azdo import Wiql
 from devopsdriver.azdo import Ascending, Descending, Value
-from devopsdriver.azdo import IsEmpty, IsNotEmpty, And, Or, In, NotIn
+from devopsdriver.azdo import IsEmpty, IsNotEmpty, And, Or, In, NotIn, Under
 from devopsdriver.azdo import GreaterThan, LessThan, Equal, NotEqual
 from devopsdriver.azdo import GreaterThanOrEqual, LessThanOrEqual
 
 
 def test_no_params() -> None:
     """Test empty, default wiql"""
-    assert str(Wiql()) == "SELECT [System.Id] FROM workitems", str(Wiql())
+    assert str(Wiql()) == "SELECT [System.Id] FROM WorkItems", str(Wiql())
 
 
 def test_expressions() -> None:
@@ -43,7 +43,7 @@ def test_expressions() -> None:
         .asof(start)
     )
     expected = (
-        """SELECT [System.State], [System.Id] FROM workitems """
+        """SELECT [System.State], [System.Id] FROM WorkItems """
         + """WHERE [System.State] = "New" AND [System.Title] IS EMPTY """
         + """AND [Microsoft.VSTS.Common.Priority] IS NOT EMPTY """
         + """AND [System.CreatedDate] > "06/30/2024" """
@@ -71,14 +71,56 @@ def test_in_and_not_in() -> None:
         And(In("State", "New", "Ready for Development"), NotIn("Priority", 1, 2))
     )
     expected = (
-        """SELECT [System.Id] FROM workitems WHERE [System.State] """
+        """SELECT [System.Id] FROM WorkItems WHERE [System.State] """
         + """IN ("New", "Ready for Development") AND [Microsoft.VSTS.Common.Priority] """
         + """NOT IN (1, 2)"""
     )
     assert str(builder) == expected, str(builder)
 
 
+def test_under() -> None:
+    """Test under operator"""
+    builder = Wiql().where(Under("System.AreaPath", "/Project/Team/Product"))
+    expected = (
+        """SELECT [System.Id] FROM WorkItems WHERE [System.AreaPath] """
+        + """UNDER "/Project/Team/Product\""""
+    )
+    assert str(builder) == expected, str(builder)
+
+
+def test_from() -> None:
+    """Test from"""
+    builder = (
+        Wiql()
+        .from_source("Wiki")
+        .where(Under("System.AreaPath", "/Project/Team/Product"))
+    )
+    expected = (
+        """SELECT [System.Id] FROM Wiki WHERE [System.AreaPath] """
+        + """UNDER "/Project/Team/Product\""""
+    )
+    assert str(builder) == expected, str(builder)
+
+
+def test_mode() -> None:
+    """Test mode"""
+    builder = (
+        Wiql()
+        .mode("Recursive")
+        .where(Under("System.AreaPath", "/Project/Team/Product"))
+    )
+    expected = (
+        """SELECT [System.Id] FROM WorkItems WHERE [System.AreaPath] """
+        + """UNDER "/Project/Team/Product" """
+        + """MODE(Recursive)"""
+    )
+    assert str(builder) == expected, [str(builder), expected]
+
+
 if __name__ == "__main__":
+    test_under()
+    test_from()
+    test_mode()
     test_in_and_not_in()
     test_invalid_value_type()
     test_expressions()

{devopsdriver-0.1.51 → devopsdriver-0.1.53}/tests/test_settings.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python3
 
-""" Tests Settings class """
+"""Tests Settings class"""
 
-from tempfile import TemporaryDirectory
+from dataclasses import dataclass, field
+from itertools import product
 from os.path import join
 from string import ascii_lowercase
-from itertools import product
+from tempfile import TemporaryDirectory
+from typing import Any
 
 from helpers import setup_settings, ensure, write
 
@@ -13,6 +15,21 @@ from devopsdriver import settings  # debug access
 from devopsdriver.settings import Settings
 
 
+@dataclass
+class MockSettings:  # pylint: disable=too-many-instance-attributes
+    """Testing type-safe class"""
+
+    name: str
+    names: list[str]
+    age_names: dict[int, str]
+    age: int
+    stuff: list
+    info: dict
+    alive: bool = True
+    years: list[int] = field(default_factory=lambda: [2004, 2104])
+    random: Any = None
+
+
 def __setup_files(directory: str, dir1: str, dir2: str) -> None:
     """
     Priorities:
@@ -67,7 +84,7 @@ def __setup_files(directory: str, dir1: str, dir2: str) -> None:
         letters.pop()
 
 
-def test_basic():
+def test_basic() -> None:  # pylint: disable=too-many-statements
     """test the basic functionality"""
     with TemporaryDirectory() as working_dir:
         base_dir = join(working_dir, "base")
@@ -196,7 +213,7 @@ def test_basic():
                 pass
 
 
-def test_cli_env_in_yaml():
+def test_cli_env_in_yaml() -> None:
     """test setting cli and env lookups in the yaml itself"""
     with TemporaryDirectory() as working_dir:
         base_dir = join(working_dir, "base")
@@ -245,7 +262,7 @@ def test_cli_env_in_yaml():
         assert opts["zz"] == "environ zz", opts["zz"]
 
 
-def test_environ_values():
+def test_environ_values() -> None:
     """test environment variable substitution"""
     with TemporaryDirectory() as working_dir:
         base_dir = join(working_dir, "base")
@@ -272,7 +289,7 @@ def test_environ_values():
         assert opts["value"] == "testing ${noenv} for noenv", opts["value"]
 
 
-def test_secret():
+def test_secret() -> None:
     """test os secret storage"""
     with TemporaryDirectory() as working_dir:
         base_dir = join(working_dir, "base")
@@ -290,7 +307,225 @@ def test_secret():
         assert opts["password"] == "setec astronomy", opts["password"]
 
 
+def test_parse():  # pylint: disable=too-many-statements
+    """Test parsing into type-safe type"""
+    with TemporaryDirectory() as working_dir:
+        base_dir = join(working_dir, "base")
+        settings_path = join(base_dir, "parse.yml")
+        setup_settings(
+            os="Unknown",
+            shared="test",
+            Linux=join(base_dir, "Linux"),
+            Darwin=join(base_dir, "macOS"),
+            Windows=join(base_dir, "Windows"),
+        )
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=["John", "Doe"],
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            age=50,
+            alive=True,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        test_settings = Settings(settings_path).parse(MockSettings)
+
+        assert test_settings.name == "John Doe", test_settings.name
+        assert len(test_settings.names) == 2, test_settings.names
+        assert test_settings.names[0] == "John", test_settings.names
+        assert test_settings.names[1] == "Doe", test_settings.names
+        assert len(test_settings.age_names) == 3, test_settings.age_names
+        assert 0 in test_settings.age_names, test_settings.age_names
+        assert 50 in test_settings.age_names, test_settings.age_names
+        assert 100 in test_settings.age_names, test_settings.age_names
+        assert test_settings.age_names[0] == "Newborn", test_settings.age_names
+        assert test_settings.age_names[50] == "Middle age", test_settings.age_names
+        assert test_settings.age_names[100] == "Old", test_settings.age_names
+        assert test_settings.age == 50
+        assert test_settings.alive
+        assert len(test_settings.years) == 2, test_settings.years
+        assert test_settings.years[0] == 1973, test_settings.years
+        assert test_settings.years[1] == 2073, test_settings.years
+        assert test_settings.random is None, test_settings.random
+        assert len(test_settings.stuff) == 0, test_settings.stuff
+        assert len(test_settings.info) == 0, test_settings.info
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=["John", "Doe"],
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            age=50,
+            stuff=[],
+            info={},
+        )
+        test_settings = Settings(settings_path).parse(MockSettings)
+
+        assert test_settings.name == "John Doe", test_settings.name
+        assert len(test_settings.names) == 2, test_settings.names
+        assert test_settings.names[0] == "John", test_settings.names
+        assert test_settings.names[1] == "Doe", test_settings.names
+        assert len(test_settings.age_names) == 3, test_settings.age_names
+        assert 0 in test_settings.age_names, test_settings.age_names
+        assert 50 in test_settings.age_names, test_settings.age_names
+        assert 100 in test_settings.age_names, test_settings.age_names
+        assert test_settings.age_names[0] == "Newborn", test_settings.age_names
+        assert test_settings.age_names[50] == "Middle age", test_settings.age_names
+        assert test_settings.age_names[100] == "Old", test_settings.age_names
+        assert test_settings.age == 50
+        assert test_settings.alive
+        assert len(test_settings.years) == 2, test_settings.years
+        assert test_settings.years[0] == 2004, test_settings.years
+        assert test_settings.years[1] == 2104, test_settings.years
+        assert test_settings.random is None, test_settings.random
+        assert len(test_settings.stuff) == 0, test_settings.stuff
+        assert len(test_settings.info) == 0, test_settings.info
+
+        write(
+            settings_path,
+            name=None,
+            names=["John", "Doe"],
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            age=50,
+            alive=True,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=[1, 2],
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            age=50,
+            alive=True,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=None,
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            age=50,
+            alive=True,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=["John", "Doe"],
+            age_names={"0": "Newborn", "50": "Middle age", "100": "Old"},
+            age=50,
+            alive=True,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=["John", "Doe"],
+            age_names=None,
+            age=50,
+            alive=True,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=["John", "Doe"],
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            age=None,
+            alive=True,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=["John", "Doe"],
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            age=50,
+            alive=None,
+            years=(1973, 2073),
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+        write(
+            settings_path,
+            name="John Doe",
+            names=["John", "Doe"],
+            age_names={0: "Newborn", 50: "Middle age", 100: "Old"},
+            stuff=[],
+            info={},
+        )
+        try:
+            test_settings = Settings(settings_path).parse(MockSettings)
+            assert False, "Expected KeyError Exception"
+        except KeyError:
+            pass
+
+        try:
+            test_settings = Settings(settings_path).parse(Settings)
+            assert False, "Expected TypeError Exception"
+        except TypeError:
+            pass
+
+
 if __name__ == "__main__":
+    test_parse()
     test_secret()
     test_environ_values()
     test_cli_env_in_yaml()