Skip to content

refactor(net): add report_error to stubs#323

Merged
cesarcoatl merged 1 commit into
mainfrom
refactor/net/stubs-report_error
Jun 3, 2026
Merged

refactor(net): add report_error to stubs#323
cesarcoatl merged 1 commit into
mainfrom
refactor/net/stubs-report_error

Conversation

@cesarcoatl

@cesarcoatl cesarcoatl commented Jun 3, 2026

Copy link
Copy Markdown
Member

update all with unexport

Summary by Sourcery

Define explicit public exports for core modules and extend network stubs to cover new error reporting functionality.

New Features:

  • Add type stub for the net.report_error helper to report detailed errors via email.
  • Expose the HTML_ESCAPE_TABLE mapping in the net stubs for external use.

Enhancements:

  • Declare all in constants and helper.types to explicitly control their public APIs.
  • Annotate the HTML_ESCAPE_TABLE in net with a precise type to improve type checking and clarity.

update __all__ with unexport
@sourcery-ai

sourcery-ai Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Refines the public API surface by explicitly defining exports in constants and helper types, adds type-accurate stubs (including a new report_error function and HTML escape table) for the net module, and annotates the HTML escape table in the runtime implementation to match the stubs.

File-Level Changes

Change Details Files
Define explicit public exports for constants and helper types to control module API surface.
  • Add all list to constants module enumerating exported UI text and error-related constants.
  • Add all list to helper.types module enumerating exported type aliases and InnerException.
src/incendium/constants.py
src/incendium/helper/types.py
Align net module implementation with type stubs and expand stubs to cover internal helpers and new functionality.
  • Introduce HTML_ESCAPE_TABLE variable with Dict[AnyStr, AnyStr] type in net stubs to reflect the HTML escaping map.
  • Add report_error(subject, message, details, to) signature to net stubs to expose new error-reporting functionality to type checkers.
  • Tighten typing in runtime net implementation by adding Dict[AnyStr, AnyStr] type comment to the HTML escape mapping to match the stub definition.
stubs/stubs/incendium/net.pyi
src/incendium/net.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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


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.

@cesarcoatl cesarcoatl merged commit 315b7ef into main Jun 3, 2026
6 checks passed
@cesarcoatl cesarcoatl deleted the refactor/net/stubs-report_error branch June 3, 2026 22:04
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