Skip to content

Core: Libs: Commonwealth: Add on_settings_created#3235

Merged
patrickelectric merged 1 commit intobluerobotics:masterfrom
joaomariolago:add-on-settings-created-to-commonwealth
Mar 28, 2025
Merged

Core: Libs: Commonwealth: Add on_settings_created#3235
patrickelectric merged 1 commit intobluerobotics:masterfrom
joaomariolago:add-on-settings-created-to-commonwealth

Conversation

@joaomariolago
Copy link
Collaborator

@joaomariolago joaomariolago commented Mar 28, 2025

This allows for PydanticSettings classes to perform some initialization work when a new settings file is created is a pre requirement for #3232 since we will need to copy the settings from existing settings.json to initialize the PydanticSettings stack and keep the original one as backup for downgrading.

Summary by Sourcery

Add a callback method for initializing settings when a new settings file is created

New Features:

  • Introduce on_settings_created method in PydanticSettings base class to allow custom initialization when a new settings file is created

Enhancements:

  • Modify save method to call on_settings_created when the settings file does not exist, providing a hook for users to populate settings from alternative sources

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 28, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new on_settings_created method to the PydanticSettings class. This method is called when a new settings file is created, allowing subclasses to perform initialization tasks. The base implementation is empty.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Introduced a new on_settings_created method to the PydanticSettings class.
  • Added a new on_settings_created method to the PydanticSettings class.
  • Implemented a default, empty implementation of on_settings_created to be overridden by subclasses.
  • The save method now calls on_settings_created if the settings file does not exist.
core/libs/commonwealth/commonwealth/settings/bases/pydantic_base.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

@patrickelectric patrickelectric merged commit e19ed61 into bluerobotics:master Mar 28, 2025
6 checks passed
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Overall Comments:

  • Consider adding a more specific exception type than Exception to the except block in load.
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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments