opensearch-project / opensearch-py

Python Client for OpenSearch
https://opensearch.org/docs/latest/clients/python/
Apache License 2.0
338 stars 170 forks source link

Remove unnecessary utf-8 header in license_headers.py (follow-up to #615) #617

Closed jayaddison closed 10 months ago

jayaddison commented 10 months ago

Description

This is a small followup to @samuelorji's cleanup in #615. It applies the same cleanup (removal of a redundant/default coding declaration of utf-8 in source files) to the license_headers.py check script itself.

This pull request also removes that line from the list of LINES_TO_KEEP - lines of source code that aren't checked by the license check script - since it shouldn't appear anymore.

Issues Resolved

613

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

codecov[bot] commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (6f26eb3) 71.98% compared to head (6b876d3) 71.98%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #617 +/- ## ======================================= Coverage 71.98% 71.98% ======================================= Files 89 89 Lines 7935 7935 ======================================= Hits 5712 5712 Misses 2223 2223 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

saimedhi commented 10 months ago

@jayaddison, I think changelog entry is not needed.

dblock commented 10 months ago

I opened two more issues related to API generator, #619 and #618, if you have any interest @jayaddison :)

jayaddison commented 10 months ago

Thanks @saimedhi - I had pushed a commit with a changelog entry a few moments before seeing that you added a label to skip it. It was merged - I hope that's OK?

@dblock those issues do look interesting, thanks; I cannot offer any sense of when I might work on them yet, though.

Something that I notice about the utils/generate_api.py script is that it could be difficult to easily confirm what version (git commit ID) of the OpenSearch.openapi.json spec file was used to produce the output. Has including a version/commit identifier, or referencing the spec file using a git submodule been considered?

dblock commented 10 months ago

I would largely prefer a submodule for the exact reason you describe. Feel free to open a feature request or just do it (TM).