Generate instrumentation packages setup.py files #474
Merged
Conversation
This file contains 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
owais
force-pushed
the
generate-setuppy
branch
10 times, most recently
from
d47e628 to
9a20509
Compare
owais
requested review from
a team,
aabmass and
ocelotl
and removed request for
a team
owais
force-pushed
the
generate-setuppy
branch
3 times, most recently
from
ebd5239 to
ab36898
Compare
codeboten
reviewed
Apr 28, 2021
| @@ -11,6 +11,12 @@ | |||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| # See the License for the specific language governing permissions and | |||
| # limitations under the License. | |||
|
|
|||
|
|
|||
| # DO NOT EDIT. THIS FILE WAS AUTOGENERATED FROM templaes/wsgi. | |||
There was a problem hiding this comment.
looks like a typo sneaked into the generated code, though it doesnt appear in the generator 🤔
There was a problem hiding this comment.
Yea, looks like I updated the generator but didn't run it before checking in.
codeboten
reviewed
Apr 28, 2021
| @@ -11,6 +11,12 @@ | |||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| # See the License for the specific language governing permissions and | |||
| # limitations under the License. | |||
|
|
|||
|
|
|||
| # DO NOT EDIT. THIS FILE WAS AUTOGENERATED FROM templaes/urllib3. | |||
There was a problem hiding this comment.
should this say it was generated from instrumentation_setup.py?
There was a problem hiding this comment.
Yes. This is incorrect. Fixing.
|
|
||
|
|
||
| # DO NOT EDIT. THIS FILE WAS AUTOGENERATED FROM templaes/wsgi. | ||
| # Run `python scripts/generate_setuppy.py` to regenerate. |
There was a problem hiding this comment.
Nit: I see why you named this the way you did, but I would rename the script generate_setup.py, it's easier to read.
owais
force-pushed
the
generate-setuppy
branch
3 times, most recently
from
90a11ec to
538c3f1
Compare
All instrumentations packages have almost exactly same setup.py files. This commit adds a python script that generates it from a source template. This dramatically reduces the time and effort required to update all instrumentation setup.py files, and also reduces chances of making manual mistakes.
codeboten
approved these changes
Apr 29, 2021
ocelotl
pushed a commit
to ocelotl/opentelemetry-python-contrib
that referenced
this pull request
Apr 30, 2021
All instrumentations packages have almost exactly same setup.py files. This commit adds a python script that generates it from a source template. This dramatically reduces the time and effort required to update all instrumentation setup.py files, and also reduces chances of making manual mistakes.
ocelotl
pushed a commit
to ocelotl/opentelemetry-python-contrib
that referenced
this pull request
May 13, 2021
All instrumentations packages have almost exactly same setup.py files. This commit adds a python script that generates it from a source template. This dramatically reduces the time and effort required to update all instrumentation setup.py files, and also reduces chances of making manual mistakes.
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.
Description
All instrumentations packages have almost exactly same setup.py files. This commit adds a python script that generates it from a source template. This dramatically reduces the time and effort required to update all instrumentation setup.py files, and also reduces chances of making manual mistakes.
I'm working on another feature where I needed to update setup.py files for all insrumentations. I'll use this once it is merged.
Another alternative is to take out common code as yet another package and add it as a
setup_requiresdependency so it is installed in target envs before setup.py runs but this adds another runtime dependency for users and doesn't give them any benefits. It's also not heavily used in the eco-system so non standard tools (other than pip) may not work well with it.Type of change
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.