Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Define available page sizes in backend class #57

Merged
merged 1 commit into from
Feb 27, 2025
Merged

Conversation

mportesdev
Copy link
Owner

@mportesdev mportesdev commented Feb 27, 2025

Summary by Sourcery

Define available page sizes in the backend class to allow for easier customization and to avoid a global constant.

Copy link

sourcery-ai bot commented Feb 27, 2025

Reviewer's Guide by Sourcery

The pull request defines available page sizes in the backend class. This change involves moving the PAGE_SIZES definition from pictureshow/core.py to pictureshow/backends.py as a class attribute of ReportlabBackend. Additionally, the PictureShow class was updated to access page sizes from the backend class.

Updated class diagram for PictureShow and ReportlabBackend

classDiagram
  class PictureShow {
    - _pic_files
    - _backend
    + __init__(*pic_files)
    + save_pdf()
    + add_pictures()
    + _validate_target_path()
    + _validate_page_size()
  }
  class ReportlabBackend {
    + page_sizes
    read_errors
  }
  PictureShow -- ReportlabBackend : has a
Loading

File-Level Changes

Change Details Files
Defined available page sizes in the backend class.
  • Moved the PAGE_SIZES definition from pictureshow/core.py to pictureshow/backends.py as a class attribute of ReportlabBackend.
  • Updated PictureShow to access page sizes from the backend class.
src/pictureshow/core.py
src/pictureshow/backends.py
src/pictureshow/cli.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

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

Overall Comments:

  • Consider using a property instead of a static/class method for _validate_page_size.
  • It might be cleaner to define page_sizes as a dictionary instead of a tuple in ReportlabBackend.
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.


class PictureShow:
_page_sizes = dict(_backend_class.page_sizes)
Copy link

Choose a reason for hiding this comment

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

suggestion: Consider the naming of _page_sizes for external use.

Since _page_sizes is referenced outside of the class, such as in the CLI, you might consider renaming it to a public name (e.g., page_sizes) or providing a public accessor to avoid relying on an underscore-prefixed attribute.

Suggested implementation:

class PictureShow:
    page_sizes = dict(_backend_class.page_sizes)

Ensure that any external code referencing PictureShow._page_sizes is updated to reference PictureShow.page_sizes instead.

@mportesdev mportesdev merged commit 1e09594 into main Feb 27, 2025
12 checks passed
@mportesdev mportesdev deleted the page-sizes branch February 27, 2025 23:07
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant