add ruff formatter #297

jan-janssen · 2024-05-14T19:47:09Z

Summary by CodeRabbit

New Features
- Added QueueAdapter to the exported list for easier access.
Bug Fixes
- Improved string handling in various functions to ensure robust dependency and version management.
- Corrected variable names for better readability and maintainability.
Documentation
- Updated pre-commit hooks for ruff lint and ruff format to maintain code quality.
Refactor
- Reformatted code for better readability and consistency across multiple test files.
- Standardized string representations and file I/O operations.
Style
- Adjusted string literals to use double quotes for consistency.
Tests
- Updated test cases with improved formatting and assertions for clarity and consistency.

coderabbitai · 2024-05-14T19:47:24Z

Walkthrough

The recent updates enhance string manipulation and dependency handling in release.py, improve code formatting and readability across various test files, and introduce new pre-commit hooks for code linting and formatting. These changes aim to boost the maintainability and robustness of the codebase, ensuring accurate dependency updates and consistent code style.

Changes

File/Path	Change Summary
`.ci_support/release.py`	Updated string manipulation for better dependency handling and version extraction. Enhanced update logic for dependencies.
`.pre-commit-config.yaml`	Added hooks for `ruff lint` and `ruff format` from the `ruff-pre-commit` repository.
`pysqa/__init__.py`	Added `QueueAdapter` to the `__all__` list.
`pysqa/executor/__init__.py`	Imported `Executor` and added to `__all__` list.
`pysqa/wrapper/lsf.py`	Renamed loop variable for clarity.
`setup.py`	Minor formatting changes.
`tests/test_basic.py`	Minor formatting changes.
`tests/test_cmd.py`, `tests/test_execute_command.py`	Reformatted code for better readability and consistency.
`tests/test_flux.py`, `tests/test_gent.py`	Switched single quotes to double quotes in assertions. Minor formatting adjustments.
`tests/test_lsf.py`, `tests/test_moab.py`	Switched single quotes to double quotes in assertions. Minor formatting adjustments.
`tests/test_multi.py`, `tests/test_remote.py`	Added `tqdm` import. Updated string literals and formatting for clarity.
`tests/test_scheduler_commands.py`	Removed `get_queue_status_command` method.
`tests/test_slurm.py`	Minor formatting changes.

🐇 In the land of code so bright,
Changes brought new light.
With strings now handled right,
And tests formatted tight,
Our scripts now take flight,
In a world of code delight. 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 7

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5f3db0e and 3b94954.

Files selected for processing (20)

.ci_support/release.py (3 hunks)
.pre-commit-config.yaml (1 hunks)
pysqa/init.py (1 hunks)
pysqa/executor/init.py (1 hunks)
pysqa/wrapper/lsf.py (1 hunks)
setup.py (1 hunks)
tests/test_basic.py (1 hunks)
tests/test_cmd.py (5 hunks)
tests/test_execute_command.py (1 hunks)
tests/test_executor.py (6 hunks)
tests/test_flux.py (5 hunks)
tests/test_gent.py (4 hunks)
tests/test_lsf.py (3 hunks)
tests/test_moab.py (1 hunks)
tests/test_multi.py (2 hunks)
tests/test_remote.py (4 hunks)
tests/test_scheduler_commands.py (1 hunks)
tests/test_sge.py (3 hunks)
tests/test_slurm.py (7 hunks)
tests/test_torque.py (2 hunks)

Files skipped from review due to trivial changes (6)

.pre-commit-config.yaml
setup.py
tests/test_cmd.py
tests/test_execute_command.py
tests/test_lsf.py
tests/test_torque.py

Additional Context Used

Ruff (11)

.ci_support/release.py (4)

3-3: Ambiguous variable name: l

25-25: Ambiguous variable name: l

46-46: Ambiguous variable name: l

49-49: Ambiguous variable name: l

tests/test_flux.py (2)

5-5: time.sleep imported but unused

13-13: flux imported but unused; consider using importlib.util.find_spec to test for availability

tests/test_multi.py (2)

9-9: paramiko imported but unused; consider using importlib.util.find_spec to test for availability

10-10: tqdm.tqdm imported but unused; consider using importlib.util.find_spec to test for availability

tests/test_remote.py (2)

9-9: paramiko imported but unused; consider using importlib.util.find_spec to test for availability

10-10: tqdm.tqdm imported but unused; consider using importlib.util.find_spec to test for availability

tests/test_sge.py (1)

11-11: defusedxml.ElementTree imported but unused; consider using importlib.util.find_spec to test for availability

Additional comments not posted (48)

pysqa/executor/__init__.py (1)

2-3: LGTM! The import and __all__ declaration are correctly added.

pysqa/__init__.py (1)

5-5: LGTM! The import and __all__ declaration are correctly added.

tests/test_multi.py (2)

26-36: LGTM! The skipIf decorator and setUpClass method are correctly implemented.

43-43: LGTM! The test methods are correctly implemented.

tests/test_moab.py (3)

Line range hint 1-6: LGTM! The imports are correctly implemented.

Line range hint 15-15: LGTM! The class definition and setUpClass method are correctly implemented.

28-28: LGTM! The test methods are correctly implemented.

tests/test_scheduler_commands.py (3)

Line range hint 1-2: LGTM! The imports are correctly implemented.

Line range hint 5-7: LGTM! The class definitions and methods are correctly implemented.

Line range hint 20-20: LGTM! The test methods are correctly implemented.

pysqa/wrapper/lsf.py (1)

43-44: Improved variable naming for readability.

tests/test_basic.py (1)

67-67: Improved formatting for readability.

tests/test_flux.py (1)

34-34: Updated string literals to use double quotes for consistency.

Also applies to: 46-48, 57-71, 75-95, 118-122

tests/test_remote.py (1)

26-29: Updated string literals to use double quotes for consistency.

Also applies to: 35-37, 44-44, 54-56, 74-74, 79-82, 85-88, 93-93, 99-99, 107-111

tests/test_executor.py (4)

23-23: Good formatting improvement for readability.

26-26: Appropriate use of skipIf to handle platform-specific issues.

29-31: Good formatting improvement for readability.

42-42: Good formatting improvement for readability.

tests/test_sge.py (2)

26-29: Appropriate use of skipIf to handle missing dependencies.

41-41: Good standardization of string representation to use double quotes.

tests/test_gent.py (22)

22-28: Good formatting improvement for readability.

33-33: Good use of a blank line to separate code blocks for better readability.

45-45: Good standardization of string representation to use double quotes.

71-73: Good standardization of string representation to use double quotes.

76-78: Good standardization of string representation to use double quotes.

94-94: Good standardization of string representation to use double quotes.

99-102: Good standardization of string representation to use double quotes.

107-111: Good formatting improvement for readability.

117-118: Good formatting improvement for readability.

119-126: Good formatting improvement for readability.

131-135: Good formatting improvement for readability.

141-142: Good formatting improvement for readability.

143-151: Good formatting improvement for readability.

156-160: Good formatting improvement for readability.

166-166: Good formatting improvement for readability.

172-176: Good formatting improvement for readability.

182-182: Good formatting improvement for readability.

188-193: Good formatting improvement for readability.

199-199: Good formatting improvement for readability.

201-204: Good formatting improvement for readability.

209-213: Good formatting improvement for readability.

220-225: Good formatting improvement for readability.

tests/test_slurm.py (6)

23-29: Good formatting improvement for readability.

37-37: Good formatting improvement for readability.

53-53: Good standardization of string representation to use double quotes.

118-118: Good formatting improvement for readability.

127-127: Good formatting improvement for readability.

153-154: Good formatting improvement for readability.

coderabbitai · 2024-05-14T19:56:46Z

tests/test_sge.py

@@ -9,6 +9,7 @@

 try:
    import defusedxml.ElementTree as ETree
+


Remove the unused import defusedxml.ElementTree.

- import defusedxml.ElementTree as ETree

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

coderabbitai · 2024-05-14T19:56:46Z

tests/test_multi.py

    import paramiko
    from tqdm import tqdm


Remove unused imports paramiko and tqdm.

- import paramiko - from tqdm import tqdm

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

import paramiko

from tqdm import tqdm

coderabbitai · 2024-05-14T19:56:46Z

.ci_support/release.py

@@ -1,12 +1,19 @@
 def get_setup_version_and_pattern(setup_content):
    depend_lst, version_lst = [], []
    for l in setup_content:


Rename the variable l to a more descriptive name for clarity.

- for l in setup_content: + for line in setup_content:

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

for l in setup_content:

for line in setup_content:

coderabbitai · 2024-05-14T19:56:46Z

.ci_support/release.py

@@ -16,14 +23,14 @@
    read_flag = False
    depend_lst, version_lst = [], []
    for l in env_content:


Rename the variable l to a more descriptive name for clarity.

- for l in env_content: + for line in env_content:

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

for l in env_content:

for line in env_content:

coderabbitai · 2024-05-14T19:56:46Z

.ci_support/release.py

@@ -35,27 +42,29 @@
            version_combo_dict[dep] = dep + "==" + ver

    setup_content_new = ""
-    pattern_dict = {d:d + "==" + v for d, v in version_high_dict.items()}
+    pattern_dict = {d: d + "==" + v for d, v in version_high_dict.items()}
    for l in setup_content:


Rename the variable l to a more descriptive name for clarity.

- for l in setup_content: + for line in setup_content:

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

for l in setup_content:

for line in setup_content:

coderabbitai · 2024-05-14T19:56:46Z

tests/test_flux.py

@@ -11,12 +11,15 @@

 try:
    import flux


Consider using importlib.util.find_spec to check for module availability instead of importing flux.

- import flux + import importlib.util + flux_spec = importlib.util.find_spec("flux") + skip_flux_test = flux_spec is None

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

import flux

import importlib.util

flux_spec = importlib.util.find_spec("flux")

skip_flux_test = flux_spec is None

coderabbitai · 2024-05-14T19:56:47Z

tests/test_remote.py

    import paramiko
    from tqdm import tqdm


Consider using importlib.util.find_spec to check for module availability instead of importing paramiko and tqdm.

- import paramiko - from tqdm import tqdm + import importlib.util + paramiko_spec = importlib.util.find_spec("paramiko") + tqdm_spec = importlib.util.find_spec("tqdm") + skip_remote_test = paramiko_spec is None or tqdm_spec is None

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

import paramiko

from tqdm import tqdm

import importlib.util

paramiko_spec = importlib.util.find_spec("paramiko")

tqdm_spec = importlib.util.find_spec("tqdm")

skip_remote_test = paramiko_spec is None or tqdm_spec is None

add ruff formatter

3b94954

jan-janssen merged commit bba08c9 into main May 14, 2024
17 of 18 checks passed

jan-janssen deleted the ruff branch May 14, 2024 19:50

coderabbitai bot reviewed May 14, 2024

View reviewed changes

This was referenced Sep 28, 2024

Implement default submission template #338

Merged

Extend QueueAdapter to support dynamic configuration #345

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add ruff formatter #297

add ruff formatter #297

jan-janssen commented May 14, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 14, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot May 14, 2024

coderabbitai bot May 14, 2024

coderabbitai bot May 14, 2024

coderabbitai bot May 14, 2024

coderabbitai bot May 14, 2024

coderabbitai bot May 14, 2024

coderabbitai bot May 14, 2024

-    import flux
+    import importlib.util
+    flux_spec = importlib.util.find_spec("flux")
+    skip_flux_test = flux_spec is None

add ruff formatter #297

add ruff formatter #297

Conversation

jan-janssen commented May 14, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented May 14, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot May 14, 2024

Choose a reason for hiding this comment

coderabbitai bot May 14, 2024

Choose a reason for hiding this comment

coderabbitai bot May 14, 2024

Choose a reason for hiding this comment

coderabbitai bot May 14, 2024

Choose a reason for hiding this comment

coderabbitai bot May 14, 2024

Choose a reason for hiding this comment

coderabbitai bot May 14, 2024

Choose a reason for hiding this comment

coderabbitai bot May 14, 2024

Choose a reason for hiding this comment

jan-janssen commented May 14, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 14, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)