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.

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

Add some utils #1

Merged
merged 29 commits into from
May 18, 2024
Merged

Add some utils #1

merged 29 commits into from
May 18, 2024

Conversation

RhinosF1
Copy link
Contributor

@RhinosF1 RhinosF1 commented May 18, 2024

Summary by CodeRabbit

  • New Features
    • Introducing functionality to reset a wiki by deleting, backing up, and dropping its database.
    • Providing functionality to rename a wiki by executing SQL commands and a MediaWiki rename script.
    • Added entry points for console scripts: partial-reset-wiki and rename-wiki.
    • Updated project URL in setup.py from https://github.com/FOSSBots/MirahezeBots to https://github.com/miraheze/python-functions.

Copy link
Contributor

coderabbitai bot commented May 18, 2024

Walkthrough

The recent update to the Miraheze Salt repository focuses on enhancing database cluster management and Salt command execution. These changes aim to streamline operations by improving the handling of multiple database clusters efficiently.

Changes

File Path Change Summary
miraheze/salt/utils.py Introduced functionality for managing database clusters and executing Salt commands, including mapping clusters to names and retrieving clusters based on wiki names.
miraheze/salt/mwcli/partial_reset_wiki.py, miraheze/salt/mwcli/rename_wiki.py Added new files partial_reset_wiki.py and rename_wiki.py in the miraheze/salt/mwcli module for resetting and renaming wikis using SaltStack commands.
.github/pythonchecks.txt Updated dependencies setuptools and requests versions in the pythonchecks.txt file.
.github/workflows/python.yml Modified commands in the python.yml workflow for building, installing, and linting Python code.
setup.cfg, setup.py Added entry points for console scripts in setup.cfg and updated project URL in setup.py.
miraheze/swift/__init__.py No visible changes in miraheze/swift/__init__.py.

🐇
Amidst the code's dance, where clusters convene,
Maps guide the way, a sight to be seen.
Commands crafted with precision and care,
Efficiency blooms in the Salt-laden air.
A rabbit's delight, in this elegant feat,
Miraheze's tasks now feel so complete!
🌟


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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 068e16b and 94b7034.
Files selected for processing (1)
  • miraheze/salt/utils.py (1 hunks)
Additional Context Used
Ruff (9)
miraheze/salt/utils.py (9)

3-3: Undefined name TypedDict


24-24: Undefined name Optional


24-24: Undefined name Optional


24-24: Undefined name Optional


24-24: Undefined name subprocess


28-28: Undefined name subprocess


29-29: Undefined name subprocess


36-36: Undefined name sys


42-42: Undefined name subprocess

Additional comments not posted (1)
miraheze/salt/utils.py (1)

19-20: This function correctly constructs a Salt command string.

miraheze/salt/utils.py Show resolved Hide resolved
miraheze/salt/utils.py Outdated Show resolved Hide resolved
miraheze/salt/utils.py Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 94b7034 and aeb9d4e.
Files selected for processing (1)
  • miraheze/salt/utils.py (1 hunks)
Additional Context Used
Ruff (1)
miraheze/salt/utils.py (1)

3-3: os imported but unused

Additional comments not posted (2)
miraheze/salt/utils.py (2)

14-19: LGTM! Good use of TypedDict for clear type definitions.


22-23: LGTM! The command formatting looks correct.

@RhinosF1
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented May 18, 2024

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@RhinosF1 RhinosF1 changed the title Create utils.py Add some utils May 18, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between aeb9d4e and ff6e334.
Files selected for processing (10)
  • .github/pythonchecks.txt (1 hunks)
  • .github/workflows/python.yml (1 hunks)
  • miraheze/salt/init.py (1 hunks)
  • miraheze/salt/mwcli/init.py (1 hunks)
  • miraheze/salt/mwcli/partial_reset_wiki.py (1 hunks)
  • miraheze/salt/mwcli/rename_wiki.py (1 hunks)
  • miraheze/salt/utils.py (1 hunks)
  • miraheze/swift/init.py (1 hunks)
  • setup.cfg (1 hunks)
  • setup.py (1 hunks)
Files skipped from review due to trivial changes (4)
  • miraheze/salt/init.py
  • miraheze/salt/mwcli/init.py
  • miraheze/swift/init.py
  • setup.py
Files skipped from review as they are similar to previous changes (1)
  • miraheze/salt/utils.py
Additional comments not posted (3)
setup.cfg (1)

14-15: The new entry points for console scripts are correctly defined.

.github/pythonchecks.txt (1)

24-24: The addition of build==1.2.1 aligns with the Python version updates and is correctly placed under the TESTING ONLY section.

.github/workflows/python.yml (1)

24-30: The updates to the workflow commands enhance the specificity and coverage of code checks, aligning with best practices.

miraheze/salt/mwcli/partial_reset_wiki.py Show resolved Hide resolved
miraheze/salt/mwcli/rename_wiki.py Show resolved Hide resolved
@RhinosF1 RhinosF1 merged commit 4759a82 into master May 18, 2024
6 checks passed
@RhinosF1 RhinosF1 deleted the RhinosF1-patch-1 branch May 18, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant