Skip to content

Commit 62e2ff8

Browse files
authored
Update syntax of tests. (#72)
1 parent 54b6036 commit 62e2ff8

File tree

6 files changed

+67
-103
lines changed

6 files changed

+67
-103
lines changed

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ releases are available on [Anaconda.org](https://anaconda.org/conda-forge/pytask
88

99
- {pull}`65` simplifies dependency management.
1010
- {pull}`66` removes using `MetaNode`.
11+
- {pull}`72` updates syntax of tests.
1112

1213
## 0.4.1 - 2023-10-12
1314

tests/test_execute.py

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ def test_pytask_execute_task_setup(monkeypatch):
3737
def test_compile_latex_document(runner, tmp_path):
3838
"""Test simple compilation."""
3939
task_source = """
40-
import pytask
40+
from pytask import mark
4141
42-
@pytask.mark.latex(script="document.tex", document="document.pdf")
42+
@mark.latex(script="document.tex", document="document.pdf")
4343
def task_compile_document():
4444
pass
4545
"""
@@ -63,9 +63,9 @@ def task_compile_document():
6363
def test_compile_latex_document_w_relative(runner, tmp_path):
6464
"""Test simple compilation."""
6565
task_source = f"""
66-
import pytask
66+
from pytask import mark
6767
68-
@pytask.mark.latex(
68+
@mark.latex(
6969
script="document.tex",
7070
document="{tmp_path.joinpath("bld", "document.pdf").as_posix()}"
7171
)
@@ -95,9 +95,9 @@ def task_compile_document():
9595
def test_compile_latex_document_to_different_name(runner, tmp_path):
9696
"""Compile a LaTeX document where source and output name differ."""
9797
task_source = """
98-
import pytask
98+
from pytask import mark
9999
100-
@pytask.mark.latex(script="in.tex", document="out.pdf")
100+
@mark.latex(script="in.tex", document="out.pdf")
101101
def task_compile_document():
102102
pass
103103
@@ -122,12 +122,11 @@ def task_compile_document():
122122
def test_compile_w_bibliography(runner, tmp_path):
123123
"""Compile a LaTeX document with bibliography."""
124124
task_source = """
125-
import pytask
126-
from pytask import task
125+
from pytask import task, mark
127126
from pathlib import Path
128127
129128
@task(kwargs={"path": Path("references.bib")})
130-
@pytask.mark.latex(script="in_w_bib.tex", document="out_w_bib.pdf")
129+
@mark.latex(script="in_w_bib.tex", document="out_w_bib.pdf")
131130
def task_compile_document():
132131
pass
133132
"""
@@ -162,9 +161,9 @@ def task_compile_document():
162161
@pytest.mark.end_to_end()
163162
def test_raise_error_if_latexmk_is_not_found(tmp_path, monkeypatch):
164163
task_source = """
165-
import pytask
164+
from pytask import mark
166165
167-
@pytask.mark.latex(script="document.tex", document="document.pdf")
166+
@mark.latex(script="document.tex", document="document.pdf")
168167
def task_compile_document():
169168
pass
170169
"""
@@ -196,10 +195,10 @@ def task_compile_document():
196195
@pytest.mark.end_to_end()
197196
def test_compile_latex_document_w_xelatex(runner, tmp_path):
198197
task_source = """
199-
import pytask
198+
from pytask import mark
200199
from pytask_latex import compilation_steps
201200
202-
@pytask.mark.latex(
201+
@mark.latex(
203202
script="document.tex",
204203
document="document.pdf",
205204
compilation_steps=compilation_steps.latexmk(
@@ -231,11 +230,11 @@ def task_compile_document():
231230
@pytest.mark.end_to_end()
232231
def test_compile_latex_document_w_two_dependencies(runner, tmp_path):
233232
task_source = """
234-
import pytask
233+
from pytask import mark
234+
from pathlib import Path
235235
236-
@pytask.mark.latex(script="document.tex", document="document.pdf")
237-
@pytask.mark.depends_on("in.txt")
238-
def task_compile_document():
236+
@mark.latex(script="document.tex", document="document.pdf")
237+
def task_compile_document(path: Path = Path("in.txt")):
239238
pass
240239
"""
241240
tmp_path.joinpath("task_dummy.py").write_text(textwrap.dedent(task_source))
@@ -259,11 +258,11 @@ def task_compile_document():
259258
@pytest.mark.end_to_end()
260259
def test_fail_because_script_is_not_latex(tmp_path):
261260
task_source = """
262-
import pytask
261+
from pytask import mark
262+
from pathlib import Path
263263
264-
@pytask.mark.latex(script="document.text", document="document.pdf")
265-
@pytask.mark.depends_on("in.txt")
266-
def task_compile_document():
264+
@mark.latex(script="document.text", document="document.pdf")
265+
def task_compile_document(path: Path = Path("in.txt")):
267266
pass
268267
"""
269268
tmp_path.joinpath("task_dummy.py").write_text(textwrap.dedent(task_source))
@@ -297,11 +296,11 @@ def test_compile_document_to_out_if_document_has_relative_resources(tmp_path):
297296
tmp_path.joinpath("sub", "resources").mkdir(parents=True)
298297

299298
task_source = """
300-
import pytask
299+
from pytask import mark
300+
from pathlib import Path
301301
302-
@pytask.mark.latex(script="document.tex", document="out/document.pdf")
303-
@pytask.mark.depends_on("resources/content.tex")
304-
def task_compile_document():
302+
@mark.latex(script="document.tex", document="out/document.pdf")
303+
def task_compile_document(path: Path = Path("resources/content.tex")):
305304
pass
306305
"""
307306
tmp_path.joinpath("sub", "task_dummy.py").write_text(textwrap.dedent(task_source))
@@ -333,10 +332,10 @@ def test_compile_document_w_wrong_flag(tmp_path):
333332
tmp_path.joinpath("sub").mkdir(parents=True)
334333

335334
task_source = """
336-
import pytask
335+
from pytask import mark
337336
from pytask_latex import compilation_steps
338337
339-
@pytask.mark.latex(
338+
@mark.latex(
340339
script="document.tex",
341340
document="out/document.pdf",
342341
compilation_steps=compilation_steps.latexmk("--wrong-flag"),
@@ -365,17 +364,19 @@ def task_compile_document():
365364
@pytest.mark.end_to_end()
366365
def test_compile_document_w_image(runner, tmp_path):
367366
task_source = f"""
368-
import pytask
367+
from pytask import Product
369368
import shutil
369+
from typing_extensions import Annotated
370+
from pathlib import Path
371+
from pytask import mark
370372
371-
@pytask.mark.produces("image.png")
372-
def task_create_image():
373+
def task_create_image(image: Annotated[Path, Product] = Path("image.png")):
373374
shutil.copy(
374375
"{TEST_RESOURCES.joinpath("image.png").as_posix()}",
375376
"{tmp_path.joinpath("image.png").as_posix()}"
376377
)
377378
378-
@pytask.mark.latex(script="document.tex", document="document.pdf")
379+
@mark.latex(script="document.tex", document="document.pdf")
379380
def task_compile_document():
380381
pass
381382
"""
@@ -400,10 +401,10 @@ def task_compile_document():
400401
def test_compile_latex_document_w_multiple_marks(runner, tmp_path):
401402
"""Test simple compilation."""
402403
task_source = """
403-
import pytask
404+
from pytask import mark
404405
405-
@pytask.mark.latex(script="document.text")
406-
@pytask.mark.latex(script="document.tex", document="document.pdf")
406+
@mark.latex(script="document.text")
407+
@mark.latex(script="document.tex", document="document.pdf")
407408
def task_compile_document():
408409
pass
409410
"""
@@ -428,9 +429,9 @@ def task_compile_document():
428429
def test_compile_latex_document_with_wrong_extension(runner, tmp_path):
429430
"""Test simple compilation."""
430431
task_source = """
431-
import pytask
432+
from pytask import mark
432433
433-
@pytask.mark.latex(script="document.tex", document="document.file")
434+
@mark.latex(script="document.tex", document="document.file")
434435
def task_compile_document():
435436
pass
436437
"""
@@ -455,15 +456,15 @@ def task_compile_document():
455456
def test_compile_w_bibliography_and_keep_bbl(runner, tmp_path):
456457
"""Compile a LaTeX document with bibliography."""
457458
task_source = """
458-
import pytask
459+
from pytask import mark, Product
460+
from pathlib import Path
461+
from typing_extensions import Annotated
459462
460-
@pytask.mark.produces("out_w_bib.bbl")
461-
@pytask.mark.latex(
462-
script="in_w_bib.tex",
463-
document="out_w_bib.pdf",
464-
)
465-
@pytask.mark.depends_on("references.bib")
466-
def task_compile_document():
463+
@mark.latex(script="in_w_bib.tex", document="out_w_bib.pdf")
464+
def task_compile_document(
465+
bibliography: Path = Path("references.bib"),
466+
bbl: Annotated[Path, Product] = Path("out_w_bib.bbl"),
467+
):
467468
pass
468469
"""
469470
tmp_path.joinpath("task_dummy.py").write_text(textwrap.dedent(task_source))
@@ -508,9 +509,9 @@ def test_compile_latex_document_w_unknown_compilation_step(
508509
):
509510
"""Test simple compilation."""
510511
task_source = f"""
511-
import pytask
512+
from pytask import mark
512513
513-
@pytask.mark.latex(
514+
@mark.latex(
514515
script="document.tex",
515516
document="document.pdf",
516517
compilation_steps={step},
@@ -539,10 +540,10 @@ def task_compile_document():
539540
def test_compile_latex_document_with_task_decorator(runner, tmp_path):
540541
"""Test simple compilation."""
541542
task_source = """
542-
import pytask
543+
from pytask import mark, task
543544
544-
@pytask.mark.latex(script="document.tex", document="document.pdf")
545-
@pytask.mark.task
545+
@mark.latex(script="document.tex", document="document.pdf")
546+
@task
546547
def compile_document():
547548
pass
548549
"""
@@ -594,12 +595,11 @@ def test_use_task_without_path(tmp_path):
594595
def test_collect_latex_document_with_product_from_another_task(runner, tmp_path):
595596
"""Test simple compilation."""
596597
task_source = """
597-
import pytask
598598
from pathlib import Path
599-
from pytask import Product
599+
from pytask import Product, mark
600600
from typing_extensions import Annotated
601601
602-
@pytask.mark.latex(script="document.tex", document="document.pdf")
602+
@mark.latex(script="document.tex", document="document.pdf")
603603
def task_compile_document(): pass
604604
605605

tests/test_latex_dependency_scanner.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
@pytest.mark.parametrize("infer_dependencies", ["true", "false"])
1717
def test_infer_dependencies_from_task(tmp_path, infer_dependencies):
1818
task_source = """
19-
import pytask
19+
from pytask import mark
2020
21-
@pytask.mark.latex(script="document.tex", document="document.pdf")
21+
@mark.latex(script="document.tex", document="document.pdf")
2222
def task_compile_document():
2323
pass
2424
"""

tests/test_normal_execution_w_plugin.py

Lines changed: 0 additions & 39 deletions
This file was deleted.

tests/test_parallel.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@
3434
@pytest.mark.end_to_end()
3535
def test_parallel_parametrization_over_source_files_w_loop(runner, tmp_path):
3636
source = """
37-
import pytask
37+
from pytask import mark, task
3838
3939
for i in range(1, 3):
4040
41-
@pytask.mark.task
42-
@pytask.mark.latex(script=f"document_{i}.tex", document=f"document_{i}.pdf")
41+
@task
42+
@mark.latex(script=f"document_{i}.tex", document=f"document_{i}.pdf")
4343
def task_compile_latex_document():
4444
pass
4545
"""
@@ -70,13 +70,13 @@ def task_compile_latex_document():
7070
@pytest.mark.end_to_end()
7171
def test_parallel_parametrization_over_source_file_w_loop(runner, tmp_path):
7272
source = """
73-
import pytask
73+
from pytask import mark, task
7474
from pytask_latex import compilation_steps as cs
7575
7676
for ending in ("pdf", "dvi"):
7777
78-
@pytask.mark.task
79-
@pytask.mark.latex(
78+
@task
79+
@mark.latex(
8080
script="document.tex",
8181
document=f"document.{ending}",
8282
compilation_steps=cs.latexmk(

tests/test_parametrize.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,13 @@
1515
@pytest.mark.end_to_end()
1616
def test_parametrized_compilation_of_latex_documents_w_loop(tmp_path):
1717
source = """
18+
from pytask import mark, task
1819
import pytask
1920
2021
for i in range(1, 3):
2122
22-
@pytask.mark.task
23-
@pytask.mark.latex(script=f"document_{i}.tex", document=f"document_{i}.pdf")
23+
@task
24+
@mark.latex(script=f"document_{i}.tex", document=f"document_{i}.pdf")
2425
def task_compile_latex_document():
2526
pass
2627
"""
@@ -50,13 +51,14 @@ def task_compile_latex_document():
5051
@pytest.mark.end_to_end()
5152
def test_parametrizing_latex_options_w_loop(tmp_path):
5253
source = """
54+
from pytask import mark, task
5355
import pytask
5456
from pytask_latex import compilation_steps as cs
5557
5658
for ending in ("pdf", "dvi"):
5759
58-
@pytask.mark.task
59-
@pytask.mark.latex(
60+
@task
61+
@mark.latex(
6062
script="document.tex",
6163
document=f"document.{ending}",
6264
compilation_steps=cs.latexmk(

0 commit comments

Comments
 (0)