Squash all changesUpdate pyproject.toml, GH workflows, uv.lock

Author: Ickerday

.github/workflows/pre-release.yml

@@ -13,9 +13,9 @@ jobs:
       name: splunk-test-pypi
     steps:
       - name: Checkout source
-        uses: actions/checkout@71cf2267d89c5cb81562390fa70a37fa40b1305e
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
       - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install dependencies

.github/workflows/release.yml

@@ -15,9 +15,9 @@ jobs:
       name: splunk-pypi
     steps:
       - name: Checkout source
-        uses: actions/checkout@71cf2267d89c5cb81562390fa70a37fa40b1305e
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
       - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install dependencies

.github/workflows/test.yml

@@ -22,16 +22,16 @@ jobs:
             splunk-version: latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@71cf2267d89c5cb81562390fa70a37fa40b1305e
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
       - name: Launch Splunk Docker instance
         run: SPLUNK_VERSION=${{ matrix.splunk-version }} docker compose up -d
       - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
         with:
           python-version: ${{ matrix.python-version }}
       - name: (Python 3.7) Install dependencies
         if: ${{ matrix.python-version == '3.7' }}
-        run: python -m pip install python-dotenv pytest
+        run: python -m pip install deprecated python-dotenv pytest 
       - name: (Python >= 3.9) Install dependencies
         if: ${{ matrix.python-version != '3.7' }}
         run: python -m pip install . --group test

pyproject.toml

@@ -29,7 +29,10 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Application Frameworks",
 ]
 
-dependencies = ["python-dotenv>=0.21.1"]
+dependencies = [
+    "deprecated>=1.3.1",
+    "python-dotenv>=0.21.1",
+]
 optional-dependencies = { compat = ["six>=1.17.0"] }
 
 [dependency-groups]

splunklib/client.py

@@ -11,19 +11,6 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-#
-# The purpose of this module is to provide a friendlier domain interface to
-# various Splunk endpoints. The approach here is to leverage the binding
-# layer to capture endpoint context and provide objects and methods that
-# offer simplified access their corresponding endpoints. The design avoids
-# caching resource state. From the perspective of this module, the 'policy'
-# for caching resource state belongs in the application or a higher level
-# framework, and its the purpose of this module to provide simplified
-# access to that resource state.
-#
-# A side note, the objects below that provide helper methods for updating eg:
-# Entity state, are written so that they may be used in a fluent style.
-#
 
 """The **splunklib.client** module provides a Pythonic interface to the
 `Splunk REST API <http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI/RESTcontents>`_,
@@ -56,10 +43,21 @@
 
     print(my_app['author'])  # Or: print(my_app.author)
     my_app.package()  # Creates a compressed package of this application
+
+The purpose of this module is to provide a friendlier domain interface to
+various Splunk endpoints. The approach here is to leverage the binding
+layer to capture endpoint context and provide objects and methods that
+offer simplified access their corresponding endpoints. The design avoids
+caching resource state. From the perspective of this module, the 'policy'
+for caching resource state belongs in the application or a higher level
+framework, and its the purpose of this module to provide simplified
+access to that resource state.
+
+A side note, the objects below that provide helper methods for updating eg:
+Entity state, are written so that they may be used in a fluent style.
 """
 
 import contextlib
-import datetime
 import json
 import logging
 import re
@@ -68,8 +66,9 @@
 from time import sleep
 from urllib import parse
 
+from deprecated import deprecated
+
 from . import data
-from .data import record
 from .binding import (
     AuthenticationError,
     Context,
@@ -80,17 +79,18 @@
     _NoAuthenticationToken,
     namespace,
 )
+from .data import record
 
 logger = logging.getLogger(__name__)
 
 __all__ = [
-    "connect",
+    "AuthenticationError",
+    "IncomparableException",
     "NotSupportedError",
     "OperationError",
-    "IncomparableException",
     "Service",
+    "connect",
     "namespace",
-    "AuthenticationError",
 ]
 
 PATH_APPS = "apps/local/"
@@ -2007,6 +2007,10 @@ def clear_password(self):
         return self.content.get("clear_password")
 
     @property
+    @deprecated(
+        version="2.2.0",
+        reason="To improve security, this field now returns an empty string and will be removed from Splunk in a future release.",
+    )
     def encrypted_password(self):
         return self.content.get("encr_password")