v5.1.1

[Frix-x]

fix the output folders creation

Summary by Sourcery

Bug Fixes:

• Fixes an issue where output folders were not being created, ensuring that the application can correctly save and access generated files.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request fixes an issue where output folders were not being created, adds folder creation logic, refactors the _initialize_config method for better readability, and removes redundant folder creation logic.

Sequence diagram for output folder creation during Klippy connection

sequenceDiagram
    participant KlippyConnection as KC
    participant ShakeTune as ST
    participant ShakeTuneConfig as STC
    participant Path as P

    KC->>ST: _on_klippy_connect()
    ST->>STC: get_results_subfolders()
    loop For each subfolder
        ST->>P: mkdir(parents=True, exist_ok=True)
    end

Loading

Updated class diagram for ShakeTune

classDiagram
    class ShakeTune {
        -ShakeTuneConfig _st_config
        -float timeout
        -bool _show_macros
        +__init__(config)
        -_initialize_config(config)
        -_register_commands()
        -_on_klippy_connect()
    }
    class ShakeTuneConfig {
        -Path result_folder_path
        -int keep_n_results
        -bool keep_raw_data
        -int chunk_size
        -float max_freq
        -int dpi
        +get_results_subfolders()
    }
    ShakeTune -- ShakeTuneConfig : has a

Loading

File-Level Changes

Change	Details	Files
Ensures output folders are created if they don't exist.	Creates the output directory for graphs in cli.py. Creates all subfolders defined in ShakeTuneConfig during Klippy connection in shaketune.py.	shaketune/cli.py shaketune/shaketune.py
Refactors the _initialize_config method to improve readability and maintainability.	Extracts the return statement from the _initialize_config method. Renames the config parameter in _initialize_config to k_conf to avoid shadowing.	shaketune/shaketune.py
Removes redundant folder creation logic from shaketune_process.py.	Removes the folder creation logic from the _shaketune_process method.	shaketune/shaketune_process.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Frix-x - I've reviewed your changes - here's some feedback:

Overall Comments:

• The changes to _initialize_config seem unnecessary - can you explain why you're assigning the config values to local variables before assigning them to self?
• It looks like you're creating the output folders in multiple places - can you consolidate this logic?

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}