feature/SOF 7894 3

[VsevolodX]

• update: restructure job api
• update: import of job api

Summary by CodeRabbit

• Chores
  • Reorganized job utility imports. Job-related functions including wait_for_jobs_to_finish_async, create_job, and submit_jobs are now accessed from mat3ra.notebooks_utils.api.job. If you directly import these utilities, update your import statements to reference the new module path.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR moves the wait_for_jobs_to_finish_async polling helper from the generic job module into the API-specific api/job module with a new implementation using decorators. The source module is cleaned up by removing the moved function and related imports, and two example notebooks are updated to import from the new location.

Changes

Job wait helper reorganization

Layer / File(s)	Summary
New job-wait implementation and API module setup src/py/mat3ra/notebooks_utils/api/job.py	Adds imports from ..core.entity.job.api and interruptible_polling_loop, implements wait_for_jobs_to_finish_async to poll job statuses and format a summary row with aggregated counts, and updates __all__ to export the job API functions and the new implementation while removing get_convergence_series.
Source module cleanup src/py/mat3ra/notebooks_utils/job.py	Removes the polling implementation, __all__ export list, and unused imports (datetime, Counter, pretty_print, JobEndpoints, interruptible_polling_loop); makes Material and Workflow unconditional imports; retains create_job and get_convergence_series.
Example notebook import updates examples/job/get-file-from-job.ipynb, examples/job/ml-train-model-predict-properties.ipynb	Both notebooks update the import source for wait_for_jobs_to_finish_async from mat3ra.notebooks_utils.job to mat3ra.notebooks_utils.api.job.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• Exabyte-io/api-examples#272: Implements the same async job-wait helper around interruptible_polling_loop with status aggregation and changed return semantics.
• Exabyte-io/api-examples#305: Updates a QE SCF notebook's wait_for_jobs_to_finish_async usage to match the new polling helper behavior and signature.
• Exabyte-io/api-examples#302: Modifies examples/job/get-file-from-job.ipynb around the same wait_for_jobs_to_finish_async import.

Suggested reviewers

• timurbazhirov

Poem

🐰 A helper hops from home to API,
Where job-status waits in harmony,
Decorators dance, summaries align,
Old imports fade, new paths shine!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'feature/SOF 7894 3' is vague and does not clearly describe the main changes, which involve restructuring the job API and moving the wait_for_jobs_to_finish_async function to a new module location.	Consider a more descriptive title such as 'Restructure job API and move wait_for_jobs_to_finish_async to api.job module' that clearly conveys the primary intent of the changes.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/SOF-7894-3

---

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.}