Skip to content

Commit a4db8cf

Browse files
committed
Issue #15/#17 Add TODO notes about code structure and schema validation
1 parent 56ed471 commit a4db8cf

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

openeo_udp/examples/max_ndvi/generate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from openeo.api.process import Parameter
77
from openeo.rest.udp import build_process_dict
88

9-
# TODO: where to put reusable helpers? e.g. load description from README.md, dummy openeo connection, properly write to JSON file, ...
9+
# TODO #15 where to put reusable helpers? e.g. load description from README.md, dummy openeo connection, properly write to JSON file, ...
1010

1111

1212
def generate() -> dict:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TODO: Flatten apex_algorithm_qa_tools to a single module and push as much functionality to https://github.com/ESA-APEx/esa-apex-toolbox-python
1+
# TODO #15 Flatten apex_algorithm_qa_tools to a single module and push as much functionality to https://github.com/ESA-APEx/esa-apex-toolbox-python
22

33

44
__version__ = "0.0.1"

qa/tools/apex_algorithm_qa_tools/common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from pathlib import Path
55
from typing import Iterator
66

7-
# TODO: Flatten apex_algorithm_qa_tools to a single module and push as much functionality to https://github.com/ESA-APEx/esa-apex-toolbox-python
7+
# TODO #15 Flatten apex_algorithm_qa_tools to a single module and push as much functionality to https://github.com/ESA-APEx/esa-apex-toolbox-python
88

99

1010
_log = logging.getLogger(__name__)

qa/tools/apex_algorithm_qa_tools/scenarios.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
_log = logging.getLogger(__name__)
1313

1414

15-
# TODO: Flatten apex_algorithm_qa_tools to a single module and push as much functionality to https://github.com/ESA-APEx/esa-apex-toolbox-python
15+
# TODO #15 Flatten apex_algorithm_qa_tools to a single module and push as much functionality to https://github.com/ESA-APEx/esa-apex-toolbox-python
1616

1717

1818
@dataclasses.dataclass(kw_only=True)
@@ -53,12 +53,12 @@ def lint_benchmark_scenario(scenario: BenchmarkScenario):
5353
Various sanity checks for scenario data.
5454
To be used in unit tests and pre-commit hooks.
5555
"""
56+
# TODO #17 use JSON Schema based validation instead of ad-hoc checks?
5657
# TODO integrate this as a pre-commit hook
5758
# TODO raise descriptive exceptions instead of asserts?
5859
assert re.match(r"^[a-zA-Z0-9_-]+$", scenario.id)
5960
# TODO: proper allow-list of backends?
6061
assert scenario.backend in ["openeofed.dataspace.copernicus.eu"]
61-
# TODO: refactor this out to a more generic process graph validator? Or use an existing tool?
6262
# TODO: more advanced process graph validation?
6363
assert isinstance(scenario.process_graph, dict)
6464
for node_id, node in scenario.process_graph.items():

qa/unittests/tests/test_algorithm_catalog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ def test_lint_algorithm_catalog_json_file(path):
2020
assert data["properties"]["type"] == "apex_algorithm"
2121

2222
assert "openeo-process" in {k["rel"] for k in data["links"]}
23-
# TODO more checks
23+
# TODO #17 more checks

qa/unittests/tests/test_openeo_udp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ def test_lint_openeo_udp_json_file(path):
1919
assert "description" in data
2020
assert "parameters" in data
2121
assert "process_graph" in data
22-
# TODO more checks
22+
# TODO #17 more checks
2323
# TODO require a standardized openEO "type"? https://github.com/Open-EO/openeo-api/issues/539

0 commit comments

Comments
 (0)