hackerrank 2026.7.30__tar.gz → 2026.8.22__tar.gz

{hackerrank-2026.7.30 → hackerrank-2026.8.22}/.github/dependabot.yml

@@ -12,3 +12,8 @@ updates:
     schedule:
       interval: daily
     open-pull-requests-limit: 10
+
+  - package-ecosystem: pre-commit
+    directory: /
+    schedule:
+      interval: daily

hackerrank-2026.8.22/.github/workflows/autofix.yml

@@ -0,0 +1,37 @@
+---
+name: autofix.ci
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  autofix:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v9.0.0
+
+      - name: Run fixers
+        uses: j178/prek-action@v3.0.0
+        with:
+          prek-version: 0.4.11
+          extra-args: >-
+            --all-files --hook-stage pre-commit --no-fail-fast --verbose
+        env:
+          UV_NO_CACHE: '1'
+          UV_PYTHON: 3.13
+
+      - uses: autofix-ci/action@v1.3.4
+        if: always()

{hackerrank-2026.7.30 → hackerrank-2026.8.22}/.github/workflows/lint.yml

@@ -35,17 +35,15 @@ jobs:
           cache-dependency-glob: '**/pyproject.toml'
 
       - name: Lint
-        # Use bash to ensure the step fails if any command fails.
-        # PowerShell does not fail on intermediate command failures by default.
-        shell: bash
-        run: uv run --extra=dev prek run --all-files --hook-stage ${{ matrix.hook-stage }}
-          --verbose
+        uses: j178/prek-action@v3.0.0
+        with:
+          prek-version: 0.4.11
+          extra-args: >-
+            --all-files --hook-stage ${{ matrix.hook-stage }} --verbose
         env:
+          UV_NO_CACHE: '1'
           UV_PYTHON: ${{ matrix.python-version }}
 
-      - uses: pre-commit-ci/lite-action@v1.1.0
-        if: always()
-
   completion-lint:
     needs: build
     runs-on: ubuntu-latest

{hackerrank-2026.7.30 → hackerrank-2026.8.22}/.gitignore

@@ -107,3 +107,6 @@ ENV/
 src/*/_setuptools_scm_version.txt
 
 uv.lock
+
+# Vale styles downloaded by ``vale sync``
+styles/

{hackerrank-2026.7.30 → hackerrank-2026.8.22}/.pre-commit-config.yaml

@@ -6,47 +6,6 @@ fail_fast: true
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 
-ci:
-  # We use system Python, with required dependencies specified in pyproject.toml.
-  # We therefore cannot use those dependencies in pre-commit CI.
-  skip:
-    - actionlint
-    - sphinx-lint
-    - strict-kwargs-fix
-    - check-manifest
-    - deptry
-    - doc8
-    - pydocstringformatter
-    - docs
-    - interrogate
-    - interrogate-docs
-    - linkcheck
-    - mypy
-    - mypy-docs
-    - pylint
-    - pyproject-fmt-fix
-    - pyright
-    - pyright-docs
-    - pyright-verifytypes
-    - ty
-    - ty-docs
-    - pyroma
-    - ruff-check-fix
-    - ruff-check-fix-docs
-    - ruff-format-fix
-    - ruff-format-fix-docs
-    - shellcheck
-    - shellcheck-docs
-    - shfmt
-    - shfmt-docs
-    - spelling
-    - vulture
-    - vulture-docs
-    - yamlfix
-    - zizmor
-    - pyrefly
-    - pyrefly-docs
-
 default_install_hook_types: [pre-commit, pre-push]
 
 repos:
@@ -309,6 +268,46 @@ repos:
         stages: [pre-commit]
         require_serial: true
 
+      - id: no-defaults
+        name: no-defaults
+        entry: uv run --extra=dev no-defaults
+        language: python
+        types_or: [python]
+        additional_dependencies:
+          - *uv_version
+        stages: [pre-commit]
+        require_serial: true
+
+      # Vale enforces prose style rules, such as banning em dashes, in
+      # reStructuredText and Markdown files.
+      # The rules come from the ``ai-tells`` package pinned in ``.vale.ini``,
+      # which ``vale sync`` downloads into the (gitignored) ``styles``
+      # directory.
+      # Vale needs ``rst2html`` from Docutils on the ``PATH`` to parse
+      # reStructuredText.
+      # ``vale sync`` also runs when ``.vale.ini`` changes, so a package
+      # bump takes effect without waiting for the next reStructuredText
+      # change.
+      - id: vale-sync
+        name: vale sync
+        entry: uv run --extra=dev vale sync
+        language: python
+        pass_filenames: false
+        files: (\.(rst|md)$|^\.vale\.ini$)
+        additional_dependencies:
+          - *uv_version
+        stages: [pre-commit]
+
+      - id: vale
+        name: vale
+        entry: uv run --extra=dev vale
+        language: python
+        types_or: [rst, markdown]
+        require_serial: true
+        additional_dependencies:
+          - *uv_version
+        stages: [pre-commit]
+
       - id: doc8
         name: doc8
         entry: uv run --extra=dev -m doc8

hackerrank-2026.8.22/.vale.ini

@@ -0,0 +1,14 @@
+StylesPath = styles
+MinAlertLevel = error
+
+Packages = https://github.com/tbhb/vale-ai-tells/releases/download/v1.29.0/ai-tells.zip
+
+[*.{rst,md}]
+BasedOnStyles = ai-tells
+
+# These rules misclassify established technical, example, or release-note prose
+# in this repository. All other ai-tells rules remain enforced.
+ai-tells.FigurativeLands = NO
+ai-tells.FormalTransitions = NO
+ai-tells.OverusedVocabulary = NO
+ai-tells.VerbTricolon = NO

hackerrank-2026.8.22/CHANGELOG.rst

@@ -0,0 +1,71 @@
+Changelog
+=========
+
+.. towncrier release notes start
+
+2026.08.22
+----------
+
+- Accept documented object-form interviewers and candidate_details, preserve
+  interview schedule / live fields, and return invite and update response
+  bodies from sync and async clients.
+
+- Add ``client.candidates.search`` (sync and async) for the global
+  candidate-search endpoint, with typed attempt and candidate results.
+
+- Expose documented list filters and body fields for interviews,
+  questions, templates, and candidate invites on sync and async
+  clients.
+
+- Reject bare ``str`` values for list-like API fields (``interviewers``,
+  ``languages``, ``tags``, and related parameters) so they are no longer
+  split into character arrays in request bodies.
+
+- Refresh ``openapi.json`` from the live HackerRank schema and add a
+  semantic drift check that ignores dynamic example timestamps.
+
+- Add ``client.interview_templates.explicit_sharing_roles`` with
+  ``update_access`` and ``remove_access`` for sharing an interview template with
+  users, teams or the whole company.
+
+  Remove the ``team_share`` argument from interview-template ``create`` and
+  ``update``. HackerRank ignores the parameter and has removed it from the API
+  documentation; use ``explicit_sharing_roles`` instead.
+
+2026.08.16
+----------
+
+No significant changes.
+
+2026.07.30
+----------
+
+- Align interview-template create and update requests with the current API,
+  return updated templates, and parse live string template IDs and integer
+  question IDs.
+
+2026.07.19
+----------
+
+- SCIM v2 requests are now sent to ``https://services.hackerrank.com/scim/v2`` instead of the v3 API host, so ``client.scim`` works out of the box. A new ``scim_base_url`` argument on ``HackerRank`` and ``AsyncHackerRank`` allows overriding it.
+
+- Bring the async ``AsyncHackerRank`` client to full parity with the synchronous ``HackerRank`` client, adding all missing operations and aligning method shapes (``ats.codepair``/``ats.codescreen``, ``teams.memberships`` and ``scim.users``/``scim.groups`` sub-namespaces).
+
+2026.07.08
+----------
+
+No significant changes.
+
+2026.05.12.2
+------------
+
+
+2026.05.12.1
+------------
+
+
+2026.05.12
+----------
+
+
+* Initial release.

{hackerrank-2026.7.30 → hackerrank-2026.8.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hackerrank
-Version: 2026.7.30
+Version: 2026.8.22
 Summary: Interact with the HackerRank for Work API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License-Expression: MIT
@@ -25,45 +25,47 @@ Requires-Dist: beartype==0.22.9; extra == "dev"
 Requires-Dist: check-manifest==0.51; extra == "dev"
 Requires-Dist: deptry==0.25.1; extra == "dev"
 Requires-Dist: doc8==2.0.0; extra == "dev"
-Requires-Dist: doccmd==2026.7.19; extra == "dev"
+Requires-Dist: doccmd==2026.8.16; extra == "dev"
 Requires-Dist: furo==2025.12.19; extra == "dev"
 Requires-Dist: interrogate==1.7.0; extra == "dev"
-Requires-Dist: mypy[faster-cache]==2.3.0; extra == "dev"
+Requires-Dist: mypy[faster-cache]==2.3.1; extra == "dev"
 Requires-Dist: mypy-strict-kwargs==2026.7.19.1; extra == "dev"
-Requires-Dist: openapi-mock==2026.3.2; extra == "dev"
-Requires-Dist: prek==0.4.11; extra == "dev"
+Requires-Dist: no-defaults==2.1.0; extra == "dev"
+Requires-Dist: openapi-mock==2026.8.16; extra == "dev"
+Requires-Dist: prek==0.4.14; extra == "dev"
 Requires-Dist: pydocstringformatter==1.0.0; extra == "dev"
 Requires-Dist: pydocstyle==6.3; extra == "dev"
-Requires-Dist: pygments==2.20.0; extra == "dev"
-Requires-Dist: pylint[spelling]==4.0.6; extra == "dev"
+Requires-Dist: pygments==2.21.0; extra == "dev"
+Requires-Dist: pylint[spelling]==4.0.7; extra == "dev"
 Requires-Dist: pylint-per-file-ignores==3.2.1; extra == "dev"
-Requires-Dist: pyproject-fmt==2.26.0; extra == "dev"
-Requires-Dist: pyrefly==1.1.1; extra == "dev"
+Requires-Dist: pyproject-fmt==2.28.0; extra == "dev"
+Requires-Dist: pyrefly==1.2.0; extra == "dev"
 Requires-Dist: pyright==1.1.411; extra == "dev"
 Requires-Dist: pyroma==5.0.1; extra == "dev"
 Requires-Dist: pytest==9.1.1; extra == "dev"
 Requires-Dist: pytest-asyncio==1.4.0; extra == "dev"
-Requires-Dist: pytest-beartype-tests==2026.4.26; extra == "dev"
+Requires-Dist: pytest-beartype-tests==2026.8.16; extra == "dev"
 Requires-Dist: pytest-cov==7.1.0; extra == "dev"
 Requires-Dist: pyyaml==6.0.3; extra == "dev"
 Requires-Dist: respx==0.23.1; extra == "dev"
-Requires-Dist: ruff==0.16.0; extra == "dev"
+Requires-Dist: ruff==0.16.3; extra == "dev"
 Requires-Dist: shellcheck-py==0.11.0.1; extra == "dev"
 Requires-Dist: shfmt-py==4.0.0; extra == "dev"
 Requires-Dist: sphinx==9.1.0; extra == "dev"
 Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
 Requires-Dist: sphinx-lint==1.0.2; extra == "dev"
 Requires-Dist: sphinx-pyproject==0.3.0; extra == "dev"
-Requires-Dist: sphinx-substitution-extensions==2026.6.17; extra == "dev"
+Requires-Dist: sphinx-substitution-extensions==2026.8.13.1; extra == "dev"
 Requires-Dist: sphinxcontrib-spelling==8.0.2; extra == "dev"
 Requires-Dist: sphinxcontrib-towncrier==0.5.0a0; extra == "dev"
-Requires-Dist: strict-kwargs==2026.7.24; extra == "dev"
+Requires-Dist: strict-kwargs==2026.8.16; extra == "dev"
 Requires-Dist: sybil==10.1.0; extra == "dev"
 Requires-Dist: towncrier==25.8.0; extra == "dev"
-Requires-Dist: ty==0.0.65; extra == "dev"
+Requires-Dist: ty==0.0.72; extra == "dev"
+Requires-Dist: vale==3.13.0.0; extra == "dev"
 Requires-Dist: vulture==2.16; extra == "dev"
 Requires-Dist: yamlfix==1.19.1; extra == "dev"
-Requires-Dist: zizmor==1.28.0; extra == "dev"
+Requires-Dist: zizmor==1.29.0; extra == "dev"
 Provides-Extra: release
 Requires-Dist: check-wheel-contents==0.6.3; extra == "release"
 Requires-Dist: towncrier==25.8.0; extra == "release"

hackerrank-2026.8.22/conftest.py

@@ -0,0 +1,209 @@
+"""Test configuration for hackerrank-api-python."""
+
+from __future__ import annotations
+
+import json
+from typing import TYPE_CHECKING, Any
+
+import pytest
+import respx
+from openapi_mock import add_openapi_to_respx
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+_BASE_URL = "https://www.hackerrank.com"
+_HTTP_METHODS = frozenset(
+    {"get", "post", "put", "delete", "patch", "head", "options", "trace"},
+)
+
+
+def _as_str_keyed_dict(*, value: object) -> dict[str, Any] | None:
+    """Return ``value`` as a ``str``-keyed dict, or ``None``.
+
+    Uses a JSON round-trip so static checkers see concrete ``Any``
+    values rather than unknown dict items from ``isinstance`` narrowing.
+    """
+    if not isinstance(value, dict):
+        return None
+    decoded: Any = json.loads(s=json.dumps(obj=value))
+    typed: dict[str, Any] = decoded
+    return typed
+
+
+def _as_object_list(*, value: object) -> list[object] | None:
+    """Return ``value`` as a list of objects, or ``None``."""
+    if not isinstance(value, list):
+        return None
+    decoded: Any = json.loads(s=json.dumps(obj=value))
+    typed: list[object] = decoded
+    return typed
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    """Register command-line options used by this test suite.
+
+    Args:
+        parser: The pytest argument parser.
+    """
+    parser.addoption(
+        "--run-network",
+        action="store_true",
+        default=False,
+        help="Run tests marked with @pytest.mark.network.",
+    )
+
+
+def pytest_configure(config: pytest.Config) -> None:
+    """Register custom markers.
+
+    Args:
+        config: The pytest config object.
+    """
+    config.addinivalue_line(
+        name="markers",
+        line=(
+            "network: tests that fetch live resources "
+            "(skipped without --run-network)"
+        ),
+    )
+
+
+def pytest_collection_modifyitems(
+    config: pytest.Config,
+    items: list[pytest.Item],
+) -> None:
+    """Skip network tests unless ``--run-network`` is given.
+
+    Args:
+        config: The pytest config object.
+        items: Collected test items.
+    """
+    if config.getoption(name="--run-network"):
+        return
+    skip_network = pytest.mark.skip(reason="need --run-network option to run")
+    for item in items:
+        if "network" in item.keywords:
+            item.add_marker(marker=skip_network)
+
+
+def _fix_schema_required(*, schema: dict[str, Any]) -> dict[str, Any]:
+    """Normalize Swagger-style ``required`` flags for OpenAPI 3
+    schemas.
+    """
+    result: dict[str, Any] = dict(schema)
+    props = _as_str_keyed_dict(value=result.get("properties"))
+    if props is not None:
+        required_names: list[str] = []
+        existing_required = _as_object_list(value=result.get("required"))
+        if existing_required is not None:
+            required_names.extend(
+                name for name in existing_required if isinstance(name, str)
+            )
+        fixed_props: dict[str, Any] = {}
+        for prop_name, prop_schema_raw in props.items():
+            prop_schema = _as_str_keyed_dict(value=prop_schema_raw)
+            if prop_schema is None:
+                continue
+            fixed_prop = _fix_schema_required(schema=prop_schema)
+            if (
+                fixed_prop.pop("required", None) is True
+                and prop_name not in required_names
+            ):
+                required_names.append(prop_name)
+            fixed_props[prop_name] = fixed_prop
+        result["properties"] = fixed_props
+        if required_names:
+            result["required"] = required_names
+        elif "required" in result and not isinstance(result["required"], list):
+            result.pop("required", None)
+    items = _as_str_keyed_dict(value=result.get("items"))
+    if items is not None:
+        result["items"] = _fix_schema_required(schema=items)
+    return result
+
+
+def _migrate_body_parameter(*, operation: dict[str, Any]) -> dict[str, Any]:
+    """Convert Swagger 2 ``in: body`` parameters to OpenAPI 3
+    requestBody.
+    """
+    result: dict[str, Any] = dict(operation)
+    params = _as_object_list(value=result.get("parameters"))
+    if params is None:
+        return result
+    kept: list[object] = []
+    body_param: dict[str, Any] | None = None
+    for param_raw in params:
+        param = _as_str_keyed_dict(value=param_raw)
+        if param is not None and param.get("in") == "body":
+            body_param = param
+        else:
+            kept.append(param_raw)
+    result["parameters"] = kept
+    if body_param is not None and "requestBody" not in result:
+        schema_raw = body_param.get("schema", {})
+        schema: object = schema_raw
+        schema_dict = _as_str_keyed_dict(value=schema_raw)
+        if schema_dict is not None:
+            schema = _fix_schema_required(schema=schema_dict)
+        result["requestBody"] = {
+            "required": bool(body_param.get("required", False)),
+            "content": {"application/json": {"schema": schema}},
+        }
+    return result
+
+
+def _prepare_openapi_spec(*, spec: dict[str, object]) -> dict[str, object]:
+    """Normalize the HackerRank OpenAPI document for mock route
+    registration.
+    """
+    prepared: dict[str, object] = dict(spec)
+    raw_paths = _as_str_keyed_dict(value=prepared.get("paths", {}))
+    if raw_paths is None:
+        return prepared
+
+    cleaned_paths: dict[str, dict[str, object]] = {}
+    for raw_key, raw_value_obj in raw_paths.items():
+        raw_value = _as_str_keyed_dict(value=raw_value_obj)
+        if raw_value is None:
+            continue
+        cleaned = raw_key.split(sep="?", maxsplit=1)[0]
+        merged: dict[str, object] = dict(cleaned_paths.get(cleaned, {}))
+        for op_key, op_val_obj in raw_value.items():
+            op_val = _as_str_keyed_dict(value=op_val_obj)
+            if op_key in _HTTP_METHODS and op_val is not None:
+                merged[op_key] = _migrate_body_parameter(operation=op_val)
+            else:
+                merged[op_key] = op_val_obj
+        cleaned_paths[cleaned] = merged
+    prepared["paths"] = cleaned_paths
+    return prepared
+
+
+@pytest.fixture(name="mock_hackerrank_api")
+def fixture_mock_hackerrank_api(
+    request: pytest.FixtureRequest,
+) -> Generator[respx.MockRouter]:
+    """Provide a respx mock router backed by the OpenAPI spec.
+
+    Args:
+        request: The pytest request, used to locate the
+            ``openapi.json`` file in the project root.
+
+    Yields:
+        The configured respx mock router.
+    """
+    openapi_spec_path = request.config.rootpath / "openapi.json"
+    spec_text = openapi_spec_path.read_text(encoding="utf-8")
+    openapi_spec: dict[str, object] = json.loads(s=spec_text)
+    openapi_spec = _prepare_openapi_spec(spec=openapi_spec)
+    with respx.mock(
+        base_url=_BASE_URL,
+        assert_all_called=False,
+    ) as mock_router:
+        add_openapi_to_respx(
+            mock_obj=mock_router,
+            spec=openapi_spec,
+            base_url=_BASE_URL,
+        )
+        yield mock_router

hackerrank-2026.8.22/newsfragments/change/163.rst

@@ -0,0 +1 @@
+SCIM user and group PATCH methods now parse the documented message acknowledgement instead of treating the response as a full resource.

hackerrank-2026.8.22/newsfragments/change/164.rst

@@ -0,0 +1 @@
+SCIM group PATCH methods now parse the documented message acknowledgement instead of treating the response as a full group.

hackerrank-2026.8.22/newsfragments/change/167.rst

@@ -0,0 +1 @@
+SCIM pagination preserves an explicit ``startIndex`` of ``0`` instead of rewriting it to ``1``.

hackerrank-2026.8.22/newsfragments/change/195.rst

@@ -0,0 +1 @@
+``generate_codestubs`` now requires a request body, matching the API contract.

hackerrank-2026.8.22/newsfragments/change/248.rst

@@ -0,0 +1 @@
+Custom transports are only replaced by the default when ``transport`` is ``None``, so falsy callables are preserved.

hackerrank-2026.8.22/newsfragments/change/249.rst

@@ -0,0 +1 @@
+Unexpected HTTP 3xx redirect responses now raise ``RedirectError`` instead of being treated as successful API responses.

hackerrank-2026.8.22/newsfragments/change/250.rst

@@ -0,0 +1 @@
+Trailing slashes on custom ``base_url`` and ``scim_base_url`` values are stripped so request paths are not double-slashed.