Skip to content
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

docs(stream_processor): complete docstrings #81

Merged
merged 73 commits into from
Oct 5, 2023
Merged

Conversation

heitorlessa
Copy link
Collaborator

@heitorlessa heitorlessa commented Oct 4, 2023

closes #76

Summary

Please provide a summary of what's being changed

Add docstrings to remaining code in stream_processor, including pydantic models and events, and exceptions.

Quick refactor EventHandler emit() to base class as it's now generic enough.

User experience

If applicable, please share what the user experience looks like before and after this change

image image

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented
  • PR title follows conventional commit semantics
Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
…on already

Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
* main:
  fix: fix broken main, add automatic github oages publish (#80)
  feat(stream_processor): initial version for processing product changes (#76)

Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@heitorlessa
Copy link
Collaborator Author

waiting for CI before merging.

@heitorlessa heitorlessa temporarily deployed to dev October 4, 2023 20:31 — with GitHub Actions Inactive
@codecov
Copy link

codecov bot commented Oct 4, 2023

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (f57699d) 98.03% compared to head (de6f465) 98.05%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #81      +/-   ##
==========================================
+ Coverage   98.03%   98.05%   +0.01%     
==========================================
  Files          32       32              
  Lines         510      515       +5     
==========================================
+ Hits          500      505       +5     
  Misses         10       10              
Files Coverage Δ
product/models/products/product.py 100.00% <100.00%> (ø)
...eam_processor/domain_logic/product_notification.py 90.90% <ø> (ø)
...roduct/stream_processor/handlers/process_stream.py 95.65% <ø> (ø)
.../stream_processor/integrations/events/constants.py 100.00% <ø> (ø)
...stream_processor/integrations/events/exceptions.py 100.00% <100.00%> (ø)
.../stream_processor/integrations/events/functions.py 100.00% <100.00%> (ø)
...ream_processor/integrations/events/models/input.py 100.00% <ø> (ø)
...essor/integrations/events/providers/eventbridge.py 96.49% <100.00%> (ø)
...eam_processor/integrations/events/event_handler.py 88.88% <0.00%> (+7.07%) ⬆️
...oduct/stream_processor/integrations/events/base.py 83.33% <33.33%> (-4.17%) ⬇️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -34,6 +35,7 @@ theme:
- navigation.instant
- navigation.indexes
- navigation.tracking
- navigation.tabs
Copy link
Owner

Choose a reason for hiding this comment

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

you really like them tabs :)

@ran-isenberg ran-isenberg merged commit cab217e into main Oct 5, 2023
6 of 7 checks passed
@ran-isenberg ran-isenberg deleted the stream_processor branch October 5, 2023 04:47
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