yamloom 0.1.0__cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.whl

yamloom/actions/github/artifacts.py

@@ -0,0 +1,237 @@
+from __future__ import annotations
+from yamloom.actions.utils import validate_choice, check_string
+
+from typing import TYPE_CHECKING
+
+from ..._yamloom import Step
+from ..._yamloom import action
+from ..types import (
+    Oboollike,
+    Oboolstr,
+    Ointlike,
+    Ostr,
+    Ostrlike,
+    StringLike,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping, Sequence
+
+WARN_RETENTION_DAYS: int = 90
+MAX_COMPRESSION_LEVEL: int = 9
+
+__all__ = ['download_artifact', 'upload_artifact', 'upload_artifact_merge']
+
+
+def upload_artifact(
+    *,
+    path: StringLike,
+    name: Ostrlike = None,
+    version: str = 'v6',
+    artifact_name: Ostrlike = None,
+    if_no_files_found: Ostrlike = None,
+    retention_days: Ointlike = None,
+    compression_level: Ointlike = None,
+    overwrite: Oboollike = None,
+    include_hidden_files: Oboollike = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'path': path,
+        'name': artifact_name,
+        'if_no_files_found': validate_choice(
+            'if_no_files_found', if_no_files_found, ['warn', 'error', 'ignore']
+        ),
+        'retention-days': retention_days,
+        'compression-level': compression_level,
+        'overwrite': overwrite,
+        'include-hidden-files': include_hidden_files,
+    }
+
+    if retention_days is not None:
+        if isinstance(retention_days, int) and not isinstance(retention_days, bool):
+            if retention_days < 1:
+                msg = 'retention days must be > 0'
+                raise ValueError(msg)
+            if retention_days > WARN_RETENTION_DAYS:
+                print(
+                    f'Warning: retention days should be <= {WARN_RETENTION_DAYS} unless a higher limit is made in the repository settings!'
+                )
+        options['retention-days'] = retention_days
+
+    if compression_level is not None:
+        if (
+            isinstance(compression_level, int)
+            and not isinstance(compression_level, bool)
+        ) and (compression_level < 0 or compression_level > MAX_COMPRESSION_LEVEL):
+            msg = f'compression level must be in the range 0-{MAX_COMPRESSION_LEVEL}'
+            raise ValueError(msg)
+        options['compression-level'] = compression_level
+
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        artifact_str = check_string(options.get('artifact_name'))
+        if artifact_str:
+            name = f'Upload {artifact_str}'
+        else:
+            name = 'Upload Artifact'
+
+    return action(
+        name,
+        'actions/upload-artifact',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )
+
+
+def upload_artifact_merge(
+    *,
+    pattern: Ostrlike = None,
+    name: Ostrlike = None,
+    version: str = 'v6',
+    artifact_name: Ostrlike = None,
+    separate_directories: Oboollike = None,
+    delete_merged: Oboollike = None,
+    retention_days: Ointlike = None,
+    compression_level: Ointlike = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'name': artifact_name,
+        'pattern': pattern,
+        'separate-directories': separate_directories,
+        'delete-merged': delete_merged,
+        'retention-days': retention_days,
+        'compression-level': compression_level,
+    }
+
+    if retention_days is not None:
+        if isinstance(retention_days, int) and not isinstance(retention_days, bool):
+            if retention_days < 1:
+                msg = 'retention days must be > 0'
+                raise ValueError(msg)
+            if retention_days > WARN_RETENTION_DAYS:
+                print(
+                    f'Warning: retention days should be <= {WARN_RETENTION_DAYS} unless a higher limit is made in the repository settings!'
+                )
+        options['retention-days'] = retention_days
+
+    if compression_level is not None:
+        if (
+            isinstance(compression_level, int)
+            and not isinstance(compression_level, bool)
+        ) and (compression_level < 0 or compression_level > MAX_COMPRESSION_LEVEL):
+            msg = f'compression level must be in the range 0-{MAX_COMPRESSION_LEVEL}'
+            raise ValueError(msg)
+        options['compression-level'] = compression_level
+
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        artifact_str = check_string(options.get('artifact_name'))
+        if artifact_str:
+            name = f'Upload (merged) {artifact_str}'
+        else:
+            name = 'Upload (merged) Artifact'
+
+    return action(
+        name,
+        'actions/upload-artifact/merge',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )
+
+
+def download_artifact(
+    *,
+    path: Ostrlike = None,
+    name: Ostrlike = None,
+    version: str = 'v7',
+    artifact_name: Ostrlike = None,
+    artifact_ids: Sequence[StringLike] | None = None,
+    pattern: Ostrlike = None,
+    merge_multiple: Oboollike = None,
+    github_token: Ostrlike = None,
+    repository: Ostrlike = None,
+    run_id: Ostrlike = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'name': artifact_name,
+        'artifact-ids': ','.join(str(s) for s in artifact_ids)
+        if artifact_ids is not None
+        else None,
+        'pattern': pattern,
+        'path': path,
+        'merge-multiple': merge_multiple,
+        'github-token': github_token,
+        'repository': repository,
+        'run-id': run_id,
+    }
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        artifact_str = check_string(options.get('artifact_name'))
+        if artifact_str:
+            name = f'Download {artifact_str}'
+        else:
+            name = 'Download Artifact'
+
+    return action(
+        name,
+        'actions/download-artifact',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )

yamloom/actions/github/cache.py

@@ -0,0 +1,189 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ..._yamloom import Step
+from ..._yamloom import action
+from ..types import (
+    Obool,
+    Oboollike,
+    Oboolstr,
+    Oint,
+    Ointlike,
+    Ostr,
+    Ostrlike,
+    StringLike,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping, Sequence
+
+__all__ = ['cache', 'cache_restore', 'cache_save']
+
+
+def cache(
+    *,
+    key: str,
+    name: Ostrlike = None,
+    version: str = 'v5',
+    path: Sequence[str] | None = None,
+    restore_keys: Sequence[str] | None = None,
+    enable_cross_os_archive: Obool = None,
+    fail_on_cache_miss: Obool = None,
+    lookup_only: Obool = None,
+    segment_download_timeout_mins: Oint = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'key': key,
+        'path': list(path) if path is not None else None,
+        'restore-keys': list(restore_keys) if restore_keys is not None else None,
+        'ensembleCrossOsArchive': enable_cross_os_archive,
+        'fail-on-cache-miss': fail_on_cache_miss,
+        'lookup-only': lookup_only,
+    }
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        name = 'Save/Restore Cache'
+
+    if segment_download_timeout_mins is not None:
+        merged_env = dict(env or {})
+        merged_env['SEGMENT_DOWNLOAD_TIMEOUT_MINS'] = str(segment_download_timeout_mins)
+        env = merged_env
+
+    return action(
+        name,
+        'actions/cache',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )
+
+
+def cache_save(
+    *,
+    key: str,
+    name: Ostrlike = None,
+    version: str = 'v5',
+    path: Sequence[str] | None = None,
+    restore_keys: Sequence[str] | None = None,
+    enable_cross_os_archive: Obool = None,
+    fail_on_cache_miss: Obool = None,
+    lookup_only: Obool = None,
+    segment_download_timeout_mins: Oint = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'key': key,
+        'path': list(path) if path is not None else None,
+        'restore-keys': list(restore_keys) if restore_keys is not None else None,
+        'ensembleCrossOsArchive': enable_cross_os_archive,
+        'fail-on-cache-miss': fail_on_cache_miss,
+        'lookup-only': lookup_only,
+    }
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        name = 'Save Cache'
+
+    if segment_download_timeout_mins is not None:
+        merged_env = dict(env or {})
+        merged_env['SEGMENT_DOWNLOAD_TIMEOUT_MINS'] = str(segment_download_timeout_mins)
+        env = merged_env
+
+    return action(
+        name,
+        'actions/cache/save',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )
+
+
+def cache_restore(
+    *,
+    key: StringLike,
+    name: Ostrlike = None,
+    version: str = 'v5',
+    path: Sequence[StringLike] | None = None,
+    restore_keys: Sequence[StringLike] | None = None,
+    enable_cross_os_archive: Oboollike = None,
+    fail_on_cache_miss: Oboollike = None,
+    lookup_only: Oboollike = None,
+    segment_download_timeout_mins: Ointlike = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'key': key,
+        'path': list(path) if path is not None else None,
+        'restore-keys': list(restore_keys) if restore_keys is not None else None,
+        'ensembleCrossOsArchive': enable_cross_os_archive,
+        'fail-on-cache-miss': fail_on_cache_miss,
+        'lookup-only': lookup_only,
+    }
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        name = 'Restore Cache'
+
+    if segment_download_timeout_mins is not None:
+        merged_env = dict(env or {})
+        merged_env['SEGMENT_DOWNLOAD_TIMEOUT_MINS'] = str(segment_download_timeout_mins)
+        env = merged_env
+
+    return action(
+        name,
+        'actions/cache/restore',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )

yamloom/actions/github/release.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+from yamloom.actions.utils import check_string
+
+from typing import TYPE_CHECKING
+
+from ..._yamloom import Step
+from ..._yamloom import action
+from ..types import (
+    Obool,
+    Oboollike,
+    Oboolstr,
+    Ointlike,
+    Ostr,
+    Ostrlike,
+    StringLike,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+__all__ = ['release']
+
+
+def release(
+    *,
+    name: Ostrlike = None,
+    version: str = 'v2',
+    body: Ostr = None,
+    body_path: Ostr = None,
+    draft: Obool = None,
+    prerelease: Obool = None,
+    preserve_order: Obool = None,
+    files: Ostr = None,
+    overwrite_files: Obool = None,
+    release_name: Ostr = None,
+    tag_name: Ostr = None,
+    fail_on_unmatched_files: Obool = None,
+    repository: Ostr = None,
+    target_commitish: Ostr = None,
+    token: Ostr = None,
+    discussion_category_name: Ostr = None,
+    generate_release_notes: Obool = None,
+    append_body: Obool = None,
+    make_latest: Ostr = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'body': body,
+        'body_path': body_path,
+        'draft': draft,
+        'prerelease': prerelease,
+        'preserve_order': preserve_order,
+        'files': files,
+        'overwrite_files': overwrite_files,
+        'name': release_name,
+        'tag_name': tag_name,
+        'fail_on_unmatched_files': fail_on_unmatched_files,
+        'repository': repository,
+        'target_commitish': target_commitish,
+        'token': token,
+        'discussion_category_name': discussion_category_name,
+        'generate_release_notes': generate_release_notes,
+        'append_body': append_body,
+        'make_latest': make_latest,
+    }
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        repository_str = check_string(options.get('repository'))
+        if repository_str:
+            name = f"Make Release for '{repository_str}'"
+        else:
+            name = 'Make Release'
+
+    return action(
+        name,
+        'softprops/action-gh-release',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )

yamloom/actions/github/scm.py

@@ -0,0 +1,102 @@
+from __future__ import annotations
+from yamloom.actions.utils import check_string
+
+from typing import TYPE_CHECKING
+
+from ..._yamloom import Step
+from ..._yamloom import action
+from ..types import (
+    Oboollike,
+    Oboolstr,
+    Ointlike,
+    Ostr,
+    Ostrlike,
+    StringLike,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+__all__ = ['checkout']
+
+
+def checkout(
+    *,
+    name: Ostrlike = None,
+    version: str = 'v6',
+    repository: Ostrlike = None,
+    ref: Ostrlike = None,
+    token: Ostrlike = None,
+    ssh_key: Ostrlike = None,
+    ssh_known_hosts: Ostrlike = None,
+    ssh_strict: Oboollike = None,
+    ssh_user: Ostrlike = None,
+    persist_credentials: Oboollike = None,
+    path: Ostrlike = None,
+    clean: Oboollike = None,
+    filter: Ostrlike = None,  # noqa: A002
+    sparse_checkout: Ostrlike = None,
+    sparse_checkout_cone_mode: Oboollike = None,
+    fetch_depth: Ointlike = None,
+    fetch_tags: Oboollike = None,
+    show_progress: Oboollike = None,
+    lfs: Oboollike = None,
+    submodules: Oboollike = None,
+    get_safe_directory: Oboollike = None,
+    github_server_url: Ostrlike = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'repository': repository,
+        'ref': ref,
+        'token': token,
+        'ssh-key': ssh_key,
+        'ssh-known-hosts': ssh_known_hosts,
+        'ssh-strict': ssh_strict,
+        'ssh-user': ssh_user,
+        'persist-credentials': persist_credentials,
+        'path': path,
+        'clean': clean,
+        'filter': filter,
+        'sparse-checkout': sparse_checkout,
+        'sparse-checkout-cone-mode': sparse_checkout_cone_mode,
+        'fetch-depth': fetch_depth,
+        'fetch-tags': fetch_tags,
+        'show-progress': show_progress,
+        'lfs': lfs,
+        'submodules': submodules,
+        'get-safe-directory': get_safe_directory,
+        'github-server-url': github_server_url,
+    }
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        repository_str = check_string(options.get('repository'))
+        if repository_str:
+            name = f"Checkout '{repository_str}'"
+        else:
+            name = 'Checkout Repository'
+
+    return action(
+        name,
+        'actions/checkout',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )

yamloom/actions/packaging/python.py

@@ -0,0 +1,84 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ..._yamloom import Step
+from ..._yamloom import action
+from ..types import (
+    Oboollike,
+    Oboolstr,
+    Ointlike,
+    Ostr,
+    Ostrlike,
+    StringLike,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping, Sequence
+
+__all__ = ['maturin']
+
+
+def maturin(
+    *,
+    name: Ostrlike = None,
+    version: str = 'v1',
+    token: Ostrlike = None,
+    command: Ostrlike = None,
+    maturin_version: Ostrlike = None,
+    manylinux: Ostrlike = None,
+    container: Ostrlike = None,
+    docker_options: Ostrlike = None,
+    host_home_mount: Ostrlike = None,
+    target: Ostrlike = None,
+    rust_toolchain: Ostrlike = None,
+    rustup_components: Sequence[StringLike] | None = None,
+    maturin_working_directory: Ostrlike = None,
+    sccache: Oboollike = None,
+    before_script_linux: Ostrlike = None,
+    args: Ostrlike = None,
+    entrypoint: Ostrlike = None,
+    condition: Oboolstr = None,
+    working_directory: Ostrlike = None,
+    shell: Ostr = None,
+    id: Ostr = None,  # noqa: A002
+    env: Mapping[str, StringLike] | None = None,
+    continue_on_error: Oboollike = None,
+    timeout_minutes: Ointlike = None,
+) -> Step:
+    options: dict[str, object] = {
+        'command': command,
+        'maturin-version': maturin_version,
+        'manylinux': manylinux,
+        'target': target,
+        'container': container,
+        'docker-options': docker_options,
+        'rust-toolchain': rust_toolchain,
+        'rustup-components': ','.join(str(s) for s in rustup_components)
+        if rustup_components is not None
+        else None,
+        'working-directory': maturin_working_directory,
+        'sccache': sccache,
+        'before-script-linux': before_script_linux,
+    }
+
+    options = {key: value for key, value in options.items() if value is not None}
+
+    if name is None:
+        name = 'Maturin Action'
+
+    return action(
+        name,
+        'PyO3/maturin-action',
+        ref=version,
+        with_opts=options or None,
+        args=args,
+        entrypoint=entrypoint,
+        condition=condition,
+        working_directory=working_directory,
+        shell=shell,
+        id=id,
+        env=env,
+        continue_on_error=continue_on_error,
+        timeout_minutes=timeout_minutes,
+    )