Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/on-pull-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,18 @@ jobs:
- uses: actions/checkout@v6
- uses: ./.github/actions/linting

check-stubs:
name: Check compute types
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: ./.github/actions/install-uv
- name: Check generated compute stub
shell: bash
run: make check-stubs-compute
- name: Check typing examples with mypy and pyright
shell: bash
run: make check-types-compute

run-tests:
uses: ./.github/workflows/run-all-tests.yaml
9 changes: 9 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ lint-fix:
uv run --only-dev ruff check --fix
uv run --only-dev ruff format

stubs-compute:
uv run --package evo-compute python -m evo.compute._stubgen generate

check-stubs-compute:
uv run --package evo-compute python -m evo.compute._stubgen generate --check

check-types-compute:
uv run --package evo-compute --group test pytest packages/evo-compute/tests/test_stubgen.py::TestTypeCheckers -q

test-common:
uv run --package evo-sdk-common pytest packages/evo-sdk-common/tests

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_empty_octants" cl


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_empty_octants</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">le</span><span class="o">=</span><span class="mi">8</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_empty_octants</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">le</span><span class="o">=</span><span class="mi">8</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -224,7 +224,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_octan


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples_per_octant</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples_per_octant</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -244,7 +244,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_empty_quadrants"


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_empty_quadrants</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">le</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_empty_quadrants</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">le</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -265,7 +265,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_quadr


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples_per_quadrant</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples_per_quadrant</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -285,7 +285,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_drill


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples_per_drillhole</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples_per_drillhole</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -305,7 +305,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_drillholes_per_es


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_drillholes_per_estimate</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_drillholes_per_estimate</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down
8 changes: 8 additions & 0 deletions packages/evo-compute/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ To get up and running quickly with the Evo Compute Task SDK, start by configurin

For some interactive Jupyter notebook examples, see the [examples folder](docs/examples).

### Static typing for the generic engine

`ComputeClient` resolves `client.<topic>.<task>.run(...)` from the live task catalogue, so
there is no hand-written code for a type checker to read. A generated type stub gives
editors completion, signature help and parameter checking for every task in a checked-in
catalogue snapshot, while execution stays fully generic. See
[stubs/README.md](stubs/README.md) for how to regenerate it and refresh the snapshot.

## Contributing

For instructions on contributing to the development of this library, please refer to the [evo-python-sdk documentation](https://github.com/seequentevo/evo-python-sdk).
Expand Down
8 changes: 8 additions & 0 deletions packages/evo-compute/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,16 @@ notebooks = ["evo-sdk-common[notebooks]"]
# Dev dependencies. The version is left unspecified so the latest is installed.
test = [
"evo-sdk-common[aiohttp]",
# tests/test_stubgen.py runs a real checker over the generated stub; without one
# installed those tests skip and the stub's static guarantees go unverified.
"mypy",
"parameterized==0.9.0",
"pytest",
"pyright",
# The stub generator formats its output with ruff rather than imitating it, so
# generation -- and `test_stub_is_up_to_date` -- needs it. Pinned to match the root
# pyproject and .pre-commit-config.yaml, since formatting must be reproducible.
"ruff==0.15.16",
]
dev = [
"evo-sdk-common[notebooks]",
Expand Down
Loading
Loading