dycw-actions 0.2.2__py3-none-any.whl → 0.3.2__py3-none-any.whl

actions/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.2.2"
+__version__ = "0.3.2"

actions/publish/cli.py

@@ -3,36 +3,34 @@ from __future__ import annotations
 from rich.pretty import pretty_repr
 from typed_settings import click_options
 from utilities.logging import basic_config
+from utilities.os import is_pytest
+from utilities.text import strip_and_dedent
 
 from actions import __version__
 from actions.logging import LOGGER
 from actions.publish.lib import publish_package
 from actions.publish.settings import PublishSettings
 from actions.settings import CommonSettings
-from actions.utilities import ENV_LOADER
+from actions.utilities import LOADER
 
 
-@click_options(
-    CommonSettings, [ENV_LOADER], show_envvars_in_help=True, argname="common"
-)
-@click_options(
-    PublishSettings, [ENV_LOADER], show_envvars_in_help=True, argname="publish"
-)
+@click_options(CommonSettings, [LOADER], show_envvars_in_help=True, argname="common")
+@click_options(PublishSettings, [LOADER], show_envvars_in_help=True, argname="publish")
 def publish_sub_cmd(*, common: CommonSettings, publish: PublishSettings) -> None:
+    if is_pytest():
+        return
     basic_config(obj=LOGGER)
     LOGGER.info(
-        """\
-Running '%r' (version %s) with settings:
-%s
-%s""",
+        strip_and_dedent("""
+            Running '%r' (version %s) with settings:
+            %s
+            %s
+        """),
         publish_package.__name__,
         __version__,
         pretty_repr(common),
         pretty_repr(publish),
     )
-    if common.dry_run:
-        LOGGER.info("Dry run; exiting...")
-        return
     publish_package(
         username=publish.username,
         password=publish.password,

actions/publish/settings.py

@@ -2,14 +2,11 @@ from __future__ import annotations
 
 from typed_settings import Secret, load_settings, option, secret, settings
 
-from actions.utilities import ENV_LOADER, empty_str_to_none
+from actions.utilities import LOADER, empty_str_to_none
 
 
 @settings
 class PublishSettings:
-    token: Secret[str] | None = secret(
-        default=None, converter=empty_str_to_none, help="GitHub token"
-    )
     username: str | None = option(
         default=None, converter=empty_str_to_none, help="The username of the upload"
     )
@@ -26,10 +23,9 @@ class PublishSettings:
         default=False,
         help="Whether to load TLS certificates from the platform's native certificate store",
     )
-    dry_run: bool = option(default=False, help="Dry run the CLI")
 
 
-PUBLISH_SETTINGS = load_settings(PublishSettings, [ENV_LOADER])
+PUBLISH_SETTINGS = load_settings(PublishSettings, [LOADER])
 
 
 __all__ = ["PUBLISH_SETTINGS", "PublishSettings"]

actions/settings.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-from typed_settings import Secret, load_settings, option, secret, settings
+from typed_settings import Secret, load_settings, secret, settings
 
-from actions.utilities import ENV_LOADER, empty_str_to_none
+from actions.utilities import LOADER, empty_str_to_none
 
 
 @settings
@@ -10,10 +10,9 @@ class CommonSettings:
     token: Secret[str] | None = secret(
         default=None, converter=empty_str_to_none, help="GitHub token"
     )
-    dry_run: bool = option(default=False, help="Dry run the CLI")
 
 
-COMMON_SETTINGS = load_settings(CommonSettings, [ENV_LOADER])
+COMMON_SETTINGS = load_settings(CommonSettings, [LOADER])
 
 
 __all__ = ["COMMON_SETTINGS", "CommonSettings"]

actions/sleep/cli.py

@@ -3,34 +3,34 @@ from __future__ import annotations
 from rich.pretty import pretty_repr
 from typed_settings import click_options
 from utilities.logging import basic_config
+from utilities.os import is_pytest
+from utilities.text import strip_and_dedent
 
 from actions import __version__
 from actions.logging import LOGGER
 from actions.settings import CommonSettings
 from actions.sleep.lib import random_sleep
 from actions.sleep.settings import SleepSettings
-from actions.utilities import ENV_LOADER
+from actions.utilities import LOADER
 
 
-@click_options(
-    CommonSettings, [ENV_LOADER], show_envvars_in_help=True, argname="common"
-)
-@click_options(SleepSettings, [ENV_LOADER], show_envvars_in_help=True, argname="sleep")
+@click_options(CommonSettings, [LOADER], show_envvars_in_help=True, argname="common")
+@click_options(SleepSettings, [LOADER], show_envvars_in_help=True, argname="sleep")
 def sleep_sub_cmd(*, common: CommonSettings, sleep: SleepSettings) -> None:
+    if is_pytest():
+        return
     basic_config(obj=LOGGER)
     LOGGER.info(
-        """\
-Running '%r' (version %s) with settings:
-%s
-%s""",
+        strip_and_dedent("""
+            Running '%r' (version %s) with settings:
+            %s
+            %s
+        """),
         random_sleep.__name__,
         __version__,
         pretty_repr(common),
         pretty_repr(sleep),
     )
-    if common.dry_run:
-        LOGGER.info("Dry run; exiting...")
-        return
     random_sleep(
         min_=sleep.min, max_=sleep.max, step=sleep.step, log_freq=sleep.log_freq
     )

actions/sleep/settings.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typed_settings import load_settings, option, settings
 
-from actions.utilities import ENV_LOADER
+from actions.utilities import LOADER
 
 
 @settings
@@ -13,7 +13,7 @@ class SleepSettings:
     log_freq: int = option(default=60, help="Log frequency, in seconds")
 
 
-SLEEP_SETTINGS = load_settings(SleepSettings, [ENV_LOADER])
+SLEEP_SETTINGS = load_settings(SleepSettings, [LOADER])
 
 
 __all__ = ["SLEEP_SETTINGS", "SleepSettings"]

actions/tag/cli.py

@@ -3,34 +3,34 @@ from __future__ import annotations
 from rich.pretty import pretty_repr
 from typed_settings import click_options
 from utilities.logging import basic_config
+from utilities.os import is_pytest
+from utilities.text import strip_and_dedent
 
 from actions import __version__
 from actions.logging import LOGGER
 from actions.settings import CommonSettings
 from actions.tag.lib import tag_commit
 from actions.tag.settings import TagSettings
-from actions.utilities import ENV_LOADER
+from actions.utilities import LOADER
 
 
-@click_options(
-    CommonSettings, [ENV_LOADER], show_envvars_in_help=True, argname="common"
-)
-@click_options(TagSettings, [ENV_LOADER], show_envvars_in_help=True, argname="tag")
+@click_options(CommonSettings, [LOADER], show_envvars_in_help=True, argname="common")
+@click_options(TagSettings, [LOADER], show_envvars_in_help=True, argname="tag")
 def tag_sub_cmd(*, common: CommonSettings, tag: TagSettings) -> None:
+    if is_pytest():
+        return
     basic_config(obj=LOGGER)
     LOGGER.info(
-        """\
-Running '%r' (version %s) with settings:
-%s
-%s""",
+        strip_and_dedent("""
+            Running '%r' (version %s) with settings:
+            %s
+            %s
+        """),
         tag_commit.__name__,
         __version__,
         pretty_repr(common),
         pretty_repr(tag),
     )
-    if common.dry_run:
-        LOGGER.info("Dry run; exiting...")
-        return
     tag_commit(
         user_name=tag.user_name,
         user_email=tag.user_email,

actions/tag/lib.py

@@ -38,7 +38,9 @@ Running %r (version %s) with settings:
     )
     _ = log_run("git", "config", "--global", "user.name", user_name)
     _ = log_run("git", "config", "--global", "user.email", user_email)
-    version = parse_version(log_run("bump-my-version", "show", "current_version"))
+    version = parse_version(
+        log_run("bump-my-version", "show", "current_version", return_=True)
+    )
     _tag(str(version))
     if major_minor:
         _tag(f"{version.major}.{version.minor}")

actions/tag/settings.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typed_settings import load_settings, option, settings
 
-from actions.utilities import ENV_LOADER
+from actions.utilities import LOADER
 
 
 @settings
@@ -14,7 +14,7 @@ class TagSettings:
     latest: bool = option(default=False, help="Add the 'latest' tag")
 
 
-TAG_SETTINGS = load_settings(TagSettings, [ENV_LOADER])
+TAG_SETTINGS = load_settings(TagSettings, [LOADER])
 
 
 __all__ = ["TAG_SETTINGS", "TagSettings"]

actions/types.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from typed_settings import Secret
+
+type SecretLike = str | Secret[str]
+
+
+__all__ = ["SecretLike"]

actions/utilities.py

@@ -1,23 +1,50 @@
 from __future__ import annotations
 
-from subprocess import check_output
+from typing import TYPE_CHECKING, Literal, overload
 
-from typed_settings import EnvLoader, Secret
+from typed_settings import EnvLoader
+from utilities.subprocess import run
 
 from actions.logging import LOGGER
 
-ENV_LOADER = EnvLoader("")
+if TYPE_CHECKING:
+    from actions.types import SecretLike
 
 
-def empty_str_to_none(text: str, /) -> str | None:
-    return None if text == "" else text
+LOADER = EnvLoader("")
 
 
-def log_run(*cmds: str | Secret[str]) -> str:
-    LOGGER.info("Running '%s'...", " ".join(map(str, cmds)))
-    return check_output(
-        [c if isinstance(c, str) else c.get_secret_value() for c in cmds], text=True
-    ).rstrip("\n")
+def empty_str_to_none(text: str, /) -> str | None:
+    return None if text == "" else text
 
 
-__all__ = ["ENV_LOADER", "empty_str_to_none", "log_run"]
+@overload
+def log_run(
+    cmd: SecretLike, /, *cmds: SecretLike, print: bool = False, return_: Literal[True]
+) -> str: ...
+@overload
+def log_run(
+    cmd: SecretLike,
+    /,
+    *cmds: SecretLike,
+    print: bool = False,
+    return_: Literal[False] = False,
+) -> None: ...
+@overload
+def log_run(
+    cmd: SecretLike, /, *cmds: SecretLike, print: bool = False, return_: bool = False
+) -> str | None: ...
+def log_run(
+    cmd: SecretLike,
+    /,
+    *cmds: SecretLike,
+    print: bool = False,  # noqa: A002
+    return_: bool = False,
+) -> str | None:
+    all_cmds = [cmd, *cmds]
+    LOGGER.info("Running '%s'...", " ".join(map(str, all_cmds)))
+    unwrapped = [c if isinstance(c, str) else c.get_secret_value() for c in all_cmds]
+    return run(*unwrapped, print=print, return_=return_)
+
+
+__all__ = ["LOADER", "empty_str_to_none", "log_run"]

{dycw_actions-0.2.2.dist-info → dycw_actions-0.3.2.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.3
 Name: dycw-actions
-Version: 0.2.2
+Version: 0.3.2
 Summary: GitHub actions
 Requires-Dist: click>=8.3.1,<8.4
-Requires-Dist: dycw-utilities>=0.170.0,<0.171
+Requires-Dist: dycw-utilities>=0.172.5,<0.173
 Requires-Dist: rich>=14.2.0,<14.3
 Requires-Dist: typed-settings[attrs,click]>=25.3.0,<25.4
 Requires-Python: >=3.13

dycw_actions-0.3.2.dist-info/RECORD

@@ -0,0 +1,22 @@
+actions/__init__.py,sha256=xm1u7RHIf6fYv7ou5-vxQ9OiaAwZ0vJK7AngPQ7IBek,58
+actions/cli.py,sha256=S2q5iRqZ-AsB-IF0GxExRBBnguPcKRH_97o-kxg-RLU,536
+actions/logging.py,sha256=rMTcQMGndUHTCaXXtyOHt_VXUMhQGRHoN7okpoX0y5I,120
+actions/publish/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+actions/publish/cli.py,sha256=dcodn7jxjfaf2OfWaZh1ae5j2fZ5jXlma1OXkeRcSw4,1334
+actions/publish/lib.py,sha256=4efV3RnJNrPPebCHS_a6FzSRM9ifFJtBXZXXc5ORNFw,1651
+actions/publish/settings.py,sha256=4WgKG_ZhGkrlyRActam2ponIHZDu5U9aQHrnO2F1Vi4,969
+actions/settings.py,sha256=nLebb6eRHcY2F48WTuFrF8ir4v6mT_cTWs9e4VHRGMA,421
+actions/sleep/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+actions/sleep/cli.py,sha256=ilPHPYygoIQgG_Nggot2w5vNKdes0L6XxUG6Pb67DmI,1181
+actions/sleep/lib.py,sha256=uMre9J4A4ZEOfDntxn-PZmi7glaHI_QaXuZmmvpq0go,1660
+actions/sleep/settings.py,sha256=1hMd5mUsFb6gLajdAZ8bvFYjDhE1BWiPSKOYiHJEvqM,556
+actions/tag/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+actions/tag/cli.py,sha256=5mZ7inpLAdtIkQXp4c-t2C3Iw7tnJedR8GRN0ijatco,1231
+actions/tag/lib.py,sha256=Xoc3i6kR0jCbakDOlGDN8eO8PiPe1shc0egcaCkC0jQ,1723
+actions/tag/settings.py,sha256=s6QBI4bZFjk2mIPKIlyb3sLET5ZpXsTb-2bzjW9m5Ew,646
+actions/types.py,sha256=4k6WkQ0ByQxzJtajoufdx8VQ9xAPPq6WU4nseQcwmyw,134
+actions/utilities.py,sha256=OkwoVUd00JtBctCUlVuAriMjMPRl8W8nJorgWpedOkI,1222
+dycw_actions-0.3.2.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
+dycw_actions-0.3.2.dist-info/entry_points.txt,sha256=2Uu7wAZOm0mmcsGBEsGB370HAWgVWECRFJ9rKgfC3-I,46
+dycw_actions-0.3.2.dist-info/METADATA,sha256=NPpbP9_F61qYpr7HhvXM99AKBYT68ec45CP3EMcipoE,343
+dycw_actions-0.3.2.dist-info/RECORD,,

dycw_actions-0.2.2.dist-info/RECORD

@@ -1,21 +0,0 @@
-actions/__init__.py,sha256=p-v1DNzSSlMZQrSYK8zcIuyQfiDyhSSgIRE1gXXYcJ0,58
-actions/cli.py,sha256=S2q5iRqZ-AsB-IF0GxExRBBnguPcKRH_97o-kxg-RLU,536
-actions/logging.py,sha256=rMTcQMGndUHTCaXXtyOHt_VXUMhQGRHoN7okpoX0y5I,120
-actions/publish/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
-actions/publish/cli.py,sha256=QN9I8jdZVeRLG0DuYFigV-3uTrAkBfa9XHkpzfpJgJk,1263
-actions/publish/lib.py,sha256=4efV3RnJNrPPebCHS_a6FzSRM9ifFJtBXZXXc5ORNFw,1651
-actions/publish/settings.py,sha256=LPuU3PMDByuxukaDsEVLnZQVRX9Fzwm11ashvn1Gm8g,1160
-actions/settings.py,sha256=__Lu6E960DTvP05C0C0NCauOazn6SS5-fu6y3ENWz7Y,503
-actions/sleep/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
-actions/sleep/cli.py,sha256=3AGGpovn1pdVYn6TOmB_TOusGnjUDMjstemVTvJ3Ci8,1104
-actions/sleep/lib.py,sha256=uMre9J4A4ZEOfDntxn-PZmi7glaHI_QaXuZmmvpq0go,1660
-actions/sleep/settings.py,sha256=M3nn8r9P5lYWz_I-lBNX_dhpWPvtprC48bW55uSgwIA,564
-actions/tag/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
-actions/tag/cli.py,sha256=txW0XDc71eVrQuyKpfk8rrbK2UWU4LuwbuFk03KQkAY,1154
-actions/tag/lib.py,sha256=BHRedlrgk-JpECcPc7yxj7JnAQIScwecoGTFNWwkzUY,1695
-actions/tag/settings.py,sha256=Lg5rE08dSl9rQ_EuqJ5CoW9D_6pxcxiNZEJwQOfcW5w,654
-actions/utilities.py,sha256=F1p07eXZt0m0Ho92_70u-85E-CBWGYfzhiwFJUzdKwo,572
-dycw_actions-0.2.2.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
-dycw_actions-0.2.2.dist-info/entry_points.txt,sha256=2Uu7wAZOm0mmcsGBEsGB370HAWgVWECRFJ9rKgfC3-I,46
-dycw_actions-0.2.2.dist-info/METADATA,sha256=uqq2NqHNuqX4k69OOd00Gave-paWkRiDhFs0uBDpuBg,343
-dycw_actions-0.2.2.dist-info/RECORD,,