Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement default submission template #338

Merged
merged 21 commits into from
Sep 28, 2024
Merged

Implement default submission template #338

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
fa52e04
Implement default submission template
jan-janssen Sep 28, 2024
ee4928b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 28, 2024
2a60f35
fix render
jan-janssen Sep 28, 2024
445e7d7
fix default
jan-janssen Sep 28, 2024
ca0e6a4
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 28, 2024
9088dc7
Rename generic to abstract
jan-janssen Sep 28, 2024
8cf1ac6
Merge remote-tracking branch 'origin/submission_template' into submis…
jan-janssen Sep 28, 2024
512895e
Spit queue adapter core
jan-janssen Sep 28, 2024
8f44370
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 28, 2024
bf9fe2b
Exception when None
jan-janssen Sep 28, 2024
40a8465
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 28, 2024
12c1964
Fix typehint
jan-janssen Sep 28, 2024
9445af8
Merge remote-tracking branch 'origin/submission_template' into submis…
jan-janssen Sep 28, 2024
3ed1b18
Fix typehint
jan-janssen Sep 28, 2024
666687a
Fix typehint
jan-janssen Sep 28, 2024
777d6f3
fix gent
jan-janssen Sep 28, 2024
c1214fa
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 28, 2024
1ada972
fix type hint
jan-janssen Sep 28, 2024
ffd620b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 28, 2024
3de9d29
Merge remote-tracking branch 'origin/main' into submission_template
jan-janssen Sep 28, 2024
d7c33c3
Fix copyright
jan-janssen Sep 28, 2024
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
6 changes: 4 additions & 2 deletions pysqa/queueadapter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Copyright (c) Jan Janssen

import os
from typing import List, Optional
from typing import List, Optional, Tuple, Union

import pandas

Expand Down Expand Up @@ -326,7 +326,9 @@ def check_queue_parameters(
run_time_max: Optional[int] = None,
memory_max: Optional[int] = None,
active_queue: Optional[dict] = None,
) -> List:
) -> Tuple[
Union[float, int, None], Union[float, int, None], Union[float, int, None]
]:
Comment on lines +318 to +320
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Approve signature change and update docstring.

The method signature update improves type safety and code readability by providing a more specific return type annotation. This change is beneficial for maintainability and helps catch potential type-related errors early.

However, the method's docstring still mentions returning a List, which is now inconsistent with the new Tuple return type.

Please update the docstring to reflect the new return type. For example:

"""
...
Returns:
    Tuple[Union[float, int, None], Union[float, int, None], Union[float, int, None]]: A tuple containing the checked parameters (cores, run_time_max, memory_max).
"""

Also, ensure that the method implementation returns a tuple that matches this new type annotation.

"""
Check the parameters of a queue.

Expand Down
Loading
Loading