Version 2.0.0: Refactor PagerDuty into a multi-file module#36
Merged
Deconstrained merged 49 commits intomainfrom Apr 8, 2025
Merged
Version 2.0.0: Refactor PagerDuty into a multi-file module#36Deconstrained merged 49 commits intomainfrom
Deconstrained merged 49 commits intomainfrom
Conversation
…setup.py, remove pagerduty_old.py
788813b to
396deb4
Compare
d207c63 to
bfd390a
Compare
c62bc39 to
03cafd7
Compare
e847b67 to
b3bdbe6
Compare
This reverts commit eb31169.
… with manually updating the version in 2+ places
d2993bb to
73faca3
Compare
132b685 to
8e85cf1
Compare
another contrib guide change
ac2118b to
44f0f99
Compare
44f0f99 to
9716538
Compare
9716538 to
8b395ea
Compare
84534c2 to
41a9c49
Compare
41a9c49 to
478dde3
Compare
The original issue in #38 was not caused by the lack of a return statement but by the docstring specifying a string-type return value.
…mespace This is for backwards compatibility and so that links render properly in doc builds.
0a9593e to
eda166d
Compare
ea25237 to
3468737
Compare
3468737 to
f7df93f
Compare
asmith-pd
approved these changes
Apr 7, 2025
f7df93f to
7687e1f
Compare
The return value is the same as send_change_event which is expected to always return None.
7687e1f to
c92605d
Compare
Interros are not permitted in user-agent headers per specification.
c92605d to
a107946
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
This pull request addresses #27.
Summary
Multi-file Refactor
It includes significant structural changes to the
pagerdutypackage by refactoring what was a monolithic python module file into a multi-file module in thepagerdutydirectory.For backwards compatibility, all helper methods and classes are imported to the root namespace of the module (in
__init__.py). Any new API client classes (i.e. for the newer integration product APIs) are expected to be added in aptly-named files and similarly imported to the root of the module. Classes are expected to be usable as they always previously have. For example:Going forward, any specialized helpers that are declared only in the module where they are used are not necessary to import into the root module namespace (or add to
sphinx/source/module_reference.rstfor that matter) unless the intention is to publish them for use outside their original purpose. All methods should still have docstrings regardless.Minor changes
EventsApiV2Client.send_change_event. The return statement was removed in 1.0.0 because it is expected to always beNonebased on the schema, and Python functions without a return statement effectively returnNone, but the docstring and type hint were not updated. This caused an issue with Airflow CI/CD builds (see Fix: add missing Return event ID from change event submission #38).pagerdutytopython-pagerdutyBefore Releasing