Added benchmarks and docs.

Signed-off-by: dblock <[email protected]>
opensearch-project · Oct 26, 2023 · 039d1cc · 039d1cc
1 parent 701d3d1
commit 039d1cc
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `remote store` client APIs ([#552](https://github.com/opensearch-project/opensearch-py/pull/552))
 - Added `nox -rs generate` ([#554](https://github.com/opensearch-project/opensearch-py/pull/554))
 - Added a utf-8 header to all .py files ([#557](https://github.com/opensearch-project/opensearch-py/pull/557))
-- Added `samples` to `nox -rs format` ([#556](https://github.com/opensearch-project/opensearch-py/pull/556))
+- Added `samples`, `benchmarks` and `docs` to `nox -rs format` ([#556](https://github.com/opensearch-project/opensearch-py/pull/556))
 ### Changed
 - Generate `tasks` client from API specs ([#508](https://github.com/opensearch-project/opensearch-py/pull/508))
 - Generate `ingest` client from API specs ([#513](https://github.com/opensearch-project/opensearch-py/pull/513))

diff --git a/benchmarks/bench_async.py b/benchmarks/bench_async.py
@@ -6,6 +6,9 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
 
 import asyncio
 import uuid
@@ -25,7 +28,7 @@ async def index_records(client, item_count):
             client.index(
                 index=index_name,
                 body={
-                    "title": f"Moneyball",
+                    "title": "Moneyball",
                     "director": "Bennett Miller",
                     "year": "2011",
                 },

diff --git a/benchmarks/bench_info_sync.py b/benchmarks/bench_info_sync.py
@@ -6,6 +6,10 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
 
 import logging
 import sys
@@ -36,7 +40,7 @@ def get_info(client, request_count):
     tt = 0
     for n in range(request_count):
         start = time.time() * 1000
-        rc = client.info()
+        client.info()
         total_time = time.time() * 1000 - start
         tt += total_time
     return tt

diff --git a/benchmarks/bench_sync.py b/benchmarks/bench_sync.py
@@ -6,8 +6,13 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
 
 import json
+import logging
+import sys
 import time
 import uuid
 
@@ -21,9 +26,6 @@
 index_name = "test-index-sync"
 item_count = 1000
 
-import logging
-import sys
-
 root = logging.getLogger()
 # root.setLevel(logging.DEBUG)
 # logging.getLogger("urllib3.connectionpool").setLevel(logging.DEBUG)

diff --git a/benchmarks/bench_sync_async.py b/benchmarks/bench_sync_async.py
@@ -6,6 +6,10 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
 
 import bench_async
 import bench_sync

diff --git a/benchmarks/thread_with_return_value.py b/benchmarks/thread_with_return_value.py
@@ -1,11 +1,13 @@
-#!/usr/bin/env python
-
 # -*- coding: utf-8 -*-
 # SPDX-License-Identifier: Apache-2.0
 #
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
 
 from threading import Thread
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,3 +1,12 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
 # Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full

diff --git a/noxfile.py b/noxfile.py
@@ -35,6 +35,8 @@
     "test_opensearchpy/",
     "utils/",
     "samples/",
+    "benchmarks/",
+    "docs/",
 )