dycw-utilities 0.126.6__tar.gz → 0.126.7__tar.gz

{dycw_utilities-0.126.6 → dycw_utilities-0.126.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.126.6
+Version: 0.126.7
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.126.6 → dycw_utilities-0.126.7}/pyproject.toml

@@ -95,7 +95,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.126.6"
+version = "0.126.7"
 
 [project.optional-dependencies]
 test = [
@@ -336,7 +336,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.126.6"
+current_version = "0.126.7"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.126.6 → dycw_utilities-0.126.7}/src/tests/test_click.py

@@ -31,6 +31,7 @@ import utilities.click
 import utilities.datetime
 import utilities.types
 from utilities.click import (
+    CONTEXT_SETTINGS_HELP_OPTION_NAMES,
     Date,
     DirPath,
     Enum,
@@ -86,6 +87,16 @@ if TYPE_CHECKING:
 _T = TypeVar("_T")
 
 
+class TestContextSettingsHelpOptionNames:
+    @given(help_=sampled_from(["-h", "--help"]))
+    def test_main(self, *, help_: str) -> None:
+        @command(**CONTEXT_SETTINGS_HELP_OPTION_NAMES)
+        def cli() -> None: ...
+
+        result = CliRunner().invoke(cli, [help_])
+        assert result.exit_code == 0
+
+
 class TestFileAndDirPaths:
     def test_existing_dir_path(self, *, tmp_path: Path) -> None:
         @command()

{dycw_utilities-0.126.6 → dycw_utilities-0.126.7}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.126.6"
+__version__ = "0.126.7"

{dycw_utilities-0.126.6 → dycw_utilities-0.126.7}/src/utilities/click.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import datetime as dt
 import pathlib
-from typing import TYPE_CHECKING, Generic, TypeVar, override
+from typing import TYPE_CHECKING, Generic, TypedDict, TypeVar, override
 from uuid import UUID
 
 import click
@@ -49,6 +49,19 @@ ExistingDirPath = click.Path(
 )
 
 
+class _HelpOptionNames(TypedDict):
+    help_option_names: Sequence[str]
+
+
+class _ContextSettings(TypedDict):
+    context_settings: _HelpOptionNames
+
+
+CONTEXT_SETTINGS_HELP_OPTION_NAMES = _ContextSettings(
+    context_settings=_HelpOptionNames(help_option_names=["-h", "--help"])
+)
+
+
 # parameters
 
 
@@ -480,6 +493,7 @@ def _make_metavar(param: Parameter, desc: str, /) -> str:
 
 
 __all__ = [
+    "CONTEXT_SETTINGS_HELP_OPTION_NAMES",
     "Date",
     "DirPath",
     "Duration",