search

opensearch-project / opensearch-py

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

Added a utf-8 header to all .py files. #557

Closed dblock closed 1 year ago

dblock commented 1 year ago

Description

Consistently add a utf-8 header to all .py files.

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 1 year ago

Codecov Report

Merging #557 (0850624) into main (5c7fe9d) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #557   +/-   ##
=======================================
  Coverage   71.10%   71.10%           
=======================================
  Files          85       85           
  Lines        7774     7774           
=======================================
  Hits         5528     5528           
  Misses       2246     2246
Files Coverage Δ
opensearchpy/__init__.py 100.00% <ø> (ø)
opensearchpy/_async/_extra_imports.py 71.42% <ø> (ø)
opensearchpy/_async/client/_patch.py 46.15% <ø> (ø)
opensearchpy/_async/client/cat.py 65.78% <ø> (ø)
opensearchpy/_async/client/cluster.py 51.76% <ø> (ø)
opensearchpy/_async/client/dangling_indices.py 53.33% <ø> (ø)
opensearchpy/_async/client/features.py 75.00% <ø> (ø)
opensearchpy/_async/client/indices.py 46.22% <ø> (ø)
opensearchpy/_async/client/ingest.py 50.00% <ø> (ø)
opensearchpy/_async/client/nodes.py 63.15% <ø> (ø)
... and 73 more
jayaddison commented 12 months ago

@dblock an extremely pedantic note while reviewing changes from v2.3.2 to v2.4.2 - it looks like a couple of these encoding declarations dropped out when bcfef113c43f74c41dec9c43ba54d6e00cc17c90 was committed (run_tests.py here and generate-api.py here).

Hopefully not a problem in itself, but perhaps an indication of some utility/process that should have left those lines intact.

dblock commented 12 months ago

@dblock an extremely pedantic note while reviewing changes from v2.3.2 to v2.4.2 - it looks like a couple of these encoding declarations dropped out when bcfef11 was committed (run_tests.py here and generate-api.py here).

Hopefully not a problem in itself, but perhaps an indication of some utility/process that should have left those lines intact.

Yep, this is a problem :(

dblock commented 12 months ago

@jayaddison I opened https://github.com/opensearch-project/opensearch-py/issues/613. Maybe you want to tackle it? Ideally there's a pylint rule/linter that ensures these are present everywhere, or maybe we'll need to write one.

jayaddison commented 12 months ago

Possibly, yep - I'll follow along in that thread (and have asked a question about the reason for the coding declarations).