fix: streamline inheritance annotation

[johanneskoester]

Summary by CodeRabbit

• New Features

  • Added capability checks to determine if an environment can be deployed, cached, or pinned.
  • More consistent deployment path resolution and environment configuration handling.

• Refactor

  • Centralized environment metadata and prefixes for cache, deployment, and pin files.
  • Simplified subclassing for deployable, pinnable, and cacheable environments, improving consistency and extensibility.
  • Reduced brittle runtime assertions for more robust operations.

• Tests

  • Updated tests to use capability-based checks and renamed the archive test to cache.

[coderabbitai]

Warning

Rate limit exceeded

@johanneskoester has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 34 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 0c1a2ee and 76ea04f.

📒 Files selected for processing (2)

• snakemake_interface_software_deployment_plugins/__init__.py (7 hunks)
• snakemake_interface_software_deployment_plugins/tests.py (3 hunks)

📝 Walkthrough

Walkthrough

Refactors the core environment base API to centralize context and capability checks, adding explicit attributes, a post-init hook, and per-instance is_deployable/is_pinnable/is_cacheable methods. Inheritance is unified under EnvBase. Assertions are relaxed/centralized. Tests are updated to use capability methods and rename archive test to cache.

Changes

Cohort / File(s)	Summary
Core API refactor snakemake_interface_software_deployment_plugins/__init__.py	EnvBase expanded with explicit context fields, path-prefixes, optional hash stores, ClassVar cache, and post_init. Adds is_deployable/is_pinnable/is_cacheable. PinnableEnvBase/CacheableEnvBase/DeployableEnvBase now inherit from EnvBase. Removes several isinstance assertions; adjusts deployment path assertion. Typing imports updated to include ClassVar.
Tests updated for capability checks snakemake_interface_software_deployment_plugins/tests.py	Tests switch from isinstance checks to is_cacheable/is_pinnable/is_deployable guards with follow-up assertions. Rename test_archive to test_cache. _deploy now accepts EnvBase and guards via is_deployable before asserting DeployableEnvBase and deploying.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Test
  participant Env as EnvBase instance
  participant Cache as CacheableEnvBase
  participant Pin as PinnableEnvBase
  participant Deploy as DeployableEnvBase

  Test->>Env: is_cacheable()
  alt cacheable
    Test->>Cache: cache_assets()
  end

  Test->>Env: is_pinnable()
  alt pinnable
    Test->>Pin: pin()
  end

  Test->>Env: is_deployable()
  alt deployable
    Test->>Deploy: deploy()
  else not deployable
    Note over Test,Env: Skip deployment
  end

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

• fix: adapt tests to API changes #19 — Also refactors EnvBase and capability checks with test adjustments; likely part of the same API evolution.
• feat: deploy from archive #18 — Touches EnvBase and Deployable/Cacheable/Pinnable classes and path logic; overlaps with this restructuring.
• feat: pass tempdir to EnvBase #16 — Introduces tempdir in EnvBase.init, which this PR also includes among broader changes.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/protocols

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}