Skip to content

Set +x for __main__ entrypoints and remove unused shebangs #549

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

polyfloyd
Copy link
Contributor

@polyfloyd polyfloyd commented May 25, 2025

Small adjustment. A shebang is not used if the file is not executable. This change removes the shebang from non-entrypoints and makes the files that are entrypoints executable.

Summary by Sourcery

Remove unnecessary shebang lines from library modules and set the executable bit on Python entrypoint scripts

Enhancements:

  • Strip shebang lines from non-entrypoint source files
  • Enable execute permission (+x) on modules with main entrypoints

Copy link

sourcery-ai bot commented May 25, 2025

Reviewer's Guide

This PR standardizes shebang usage by removing unnecessary shebang lines from library modules and marking true entry-point scripts as executable (chmod +x).

File-Level Changes

Change Details Files
Removed unused shebang lines from non-entry modules
  • Strip "#!/usr/bin/env python3" from top of files without a main block
  • Update file headers to remove now-redundant executable markers
src/emhass/machine_learning_forecaster.py
src/emhass/optimization.py
src/emhass/utils.py
Made entry-point scripts executable
  • Ensure scripts with main blocks retain shebangs
  • Change file mode to +x so they can be run directly
src/emhass/forecast.py
src/emhass/retrieve_hass.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!

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

Copy link

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 @polyfloyd - I've reviewed your changes and they look great!

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.

1 participant