Skip to content

update README.md & fix oneshot.py hidden essid error: KeyError: 'ESSID' #5

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 2 commits into
base: master
Choose a base branch
from

Conversation

DroidKali
Copy link

@DroidKali DroidKali commented May 24, 2025

Summary by Sourcery

Update documentation URLs to point to the kimocoder repository and add fallback for missing ESSID values to prevent KeyError in oneshot.py.

Bug Fixes:

  • Use network.get('ESSID', 'Unknown') instead of direct access to avoid KeyError when ESSID is missing
  • Apply the same fallback in the stored membership check for ESSID

Documentation:

  • Update all README.md download and clone URLs to reference the kimocoder/OneShot repository and installer

Copy link

sourcery-ai bot commented May 24, 2025

Reviewer's Guide

This PR updates all installation and download URLs in README.md to point to the new kimocoder repository and enhances oneshot.py to safely handle missing ESSID values by providing a default of 'Unknown', preventing KeyError exceptions.

State Diagram for ESSID Value Assignment in oneshot.py

stateDiagram-v2
    title State Diagram for ESSID Value Assignment in oneshot.py
    [*] --> CheckESSIDPresence
    CheckESSIDPresence: Network data received
    CheckESSIDPresence --> ESSID_Exists: 'ESSID' key found
    CheckESSIDPresence --> ESSID_Missing: 'ESSID' key not found

    ESSID_Exists --> AssignESSIDValue: essid = network['ESSID']
    ESSID_Missing --> AssignDefaultESSID: essid = "Unknown" (using .get())

    AssignESSIDValue --> ESSID_Ready
    AssignDefaultESSID --> ESSID_Ready
    ESSID_Ready --> [*]
Loading

File-Level Changes

Change Details Files
Update repository URLs in README.md to new owner
  • Replaced raw.githubusercontent wget links from drygdryg to kimocoder
  • Updated git clone URL to point to kimocoder repository
  • Adjusted Termux installer curl command URL to kimocoder
README.md
Handle missing ESSID in network listings
  • Replaced direct network['ESSID'] access with network.get('ESSID', 'Unknown') when truncating
  • Applied same get fallback in stored membership check to avoid KeyError
oneshot.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

@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 @DroidKali - I've reviewed your changes - here's some feedback:

  • Extract the default 'Unknown' ESSID placeholder into a constant and reuse the essid variable in the membership check to avoid duplicate .get calls.
  • Consider filtering out or flagging networks missing the ESSID instead of displaying them as 'Unknown' to reduce potential confusion in scan results.
  • Ensure any other references (e.g., badges, issue tracker links) are also updated to point to the new kimocoder/OneShot repository for consistency.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@@ -1013,14 +1013,14 @@ def colored(text, color=None):
for n, network in network_list_items:
number = f'{n})'
model = '{} {}'.format(network['Model'], network['Model number'])
essid = truncateStr(network['ESSID'], 25)
essid = truncateStr(network.get('ESSID', 'Unknown'), 25)
Copy link

Choose a reason for hiding this comment

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

suggestion: Extract raw ESSID before truncation to reduce duplication

Assign the result of network.get('ESSID', 'Unknown') to a variable before using it, to avoid duplication and improve maintainability.

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