Skip to content

Fix writing of BytesIO data #310

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

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Fix writing of BytesIO data #310

merged 1 commit into from
Feb 13, 2025

Conversation

awicenec
Copy link
Contributor

@awicenec awicenec commented Feb 12, 2025

Type

  • Feature (addition)
  • Bug fix
  • Refactor (change)
  • Documentation

Problem/Issue

This PR fixes an issue with the writing of BytesIO data, which can be selected as one of the port encodings. When trying to use that encoding the engine raised a TypeError Exception. The encoding was required to fix an issue with the wallaby_hires graphs.

Solution

The fix was very simply to write the buffer instead of the BytesIO object.

In addition a very small change of one of the log messages has been introduced as well.

Summary by Sourcery

Bug Fixes:

  • Fixed a TypeError exception when using BytesIO encoding, which was required to fix an issue with the wallaby_hires graphs.

Copy link
Contributor

sourcery-ai bot commented Feb 12, 2025

Reviewer's Guide by Sourcery

This pull request fixes an issue with writing BytesIO data by ensuring that the buffer is written instead of the BytesIO object. In addition, it introduces minor log message changes and code style improvements in handling port encodings and argument parsing.

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

File-Level Changes

Change Details Files
Fix writing of BytesIO data
  • In load_binary, the buffer writes data from BytesIO correctly before decoding and returning its value.
  • In save_binary, the function now writes the buffer obtained from BytesIO using getbuffer() instead of writing the BytesIO object directly.
daliuge-engine/dlg/drop_loaders.py
Minor logging and formatting improvements
  • Adjusted a log message in memory.py to include the lowercased data type from the pd_dict rather than using the type of byte data.
  • Reformatted dictionary access in named_port_utils.py by standardizing the use of double quotes and cleaning up the applicationArgs processing.
  • Removed trailing spaces and made minor whitespace adjustments for consistency.
daliuge-engine/dlg/named_port_utils.py
daliuge-engine/dlg/data/drops/memory.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

Copy link
Contributor

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

Overall Comments:

  • Consider adding a test case that specifically covers the BytesIO encoding to prevent regressions.
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.

Comment on lines +130 to +131
data = drop.read(desc)
if data:

This comment was marked as abuse.

Copy link
Collaborator

@myxie myxie left a comment

Choose a reason for hiding this comment

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

Changes look great @awicenec!

@awicenec awicenec merged commit 989f07e into master Feb 13, 2025
12 of 18 checks passed
@awicenec awicenec deleted the binary_fix branch February 13, 2025 09:08
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