http2py 0.1.30__tar.gz → 0.1.33__tar.gz

http2py-0.1.33/.gitattributes

@@ -0,0 +1 @@
+*.ipynb linguist-documentation

http2py-0.1.33/.github/workflows/ci.yml

@@ -0,0 +1,236 @@
+name: Continuous Integration (uv)
+# NOTE: publishing uses `uv publish`, which reads UV_PUBLISH_TOKEN -- mapped here
+# from secrets.PYPI_PASSWORD. This repo has no repository-level secrets; it
+# inherits the organization-level PYPI_PASSWORD / SSH_PRIVATE_KEY (visibility:
+# all), which is the same pair other migrated packages in this org publish with.
+#
+# The GitHub Pages job below is gated on [tool.wads.ci.docs].enabled, which is
+# false here: docs/ and docsrc/ were removed from this repo, and the legacy CI's
+# `epythet make . github` call against the now-absent docs is what broke Publish.
+on: [push, pull_request]
+
+# Note: Environment variables (PROJECT_NAME and vars from [tool.wads.ci.env])
+# are set by the read-ci-config action in the setup job and made available
+# to all subsequent jobs via GITHUB_ENV
+
+jobs:
+  # First job: Read configuration from pyproject.toml
+  setup:
+    name: Read Configuration
+    runs-on: ubuntu-latest
+    outputs:
+      project-name: ${{ steps.config.outputs.project-name }}
+      python-versions: ${{ steps.config.outputs.python-versions }}
+      pytest-args: ${{ steps.config.outputs.pytest-args }}
+      coverage-enabled: ${{ steps.config.outputs.coverage-enabled }}
+      exclude-paths: ${{ steps.config.outputs.exclude-paths }}
+      test-on-windows: ${{ steps.config.outputs.test-on-windows }}
+      build-sdist: ${{ steps.config.outputs.build-sdist }}
+      build-wheel: ${{ steps.config.outputs.build-wheel }}
+      metrics-enabled: ${{ steps.config.outputs.metrics-enabled }}
+      metrics-config-path: ${{ steps.config.outputs.metrics-config-path }}
+      metrics-storage-branch: ${{ steps.config.outputs.metrics-storage-branch }}
+      metrics-python-version: ${{ steps.config.outputs.metrics-python-version }}
+      metrics-force-run: ${{ steps.config.outputs.metrics-force-run }}
+      ruff-enabled: ${{ steps.config.outputs.ruff-enabled }}
+      black-enabled: ${{ steps.config.outputs.black-enabled }}
+      mypy-enabled: ${{ steps.config.outputs.mypy-enabled }}
+      docs-enabled: ${{ steps.config.outputs.docs-enabled }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Read CI Config
+        id: config
+        uses: i2mint/wads/actions/read-ci-config@master
+        with:
+          pyproject-path: .
+
+  # Second job: Validation using the config
+  validation:
+    name: Validation
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ${{ fromJson(needs.setup.outputs.python-versions) }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: i2mint/wads/actions/setup-python-uv@master
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install System Dependencies
+        uses: i2mint/wads/actions/install-system-deps@master
+        with:
+          pyproject-path: .
+
+      - name: Install Dependencies
+        uses: i2mint/wads/actions/install-deps-uv@master
+
+      - name: Format Source Code
+        if: needs.setup.outputs.ruff-enabled != 'false'
+        run: uvx ruff format .
+
+      - name: Format Source Code (black)
+        if: needs.setup.outputs.black-enabled == 'true'
+        run: uvx black .
+
+      - name: Lint Validation
+        if: needs.setup.outputs.ruff-enabled != 'false'
+        run: uvx ruff check --output-format=github ${{ needs.setup.outputs.project-name }}
+
+      - name: Type Check (mypy)
+        if: needs.setup.outputs.mypy-enabled == 'true'
+        run: uvx mypy ${{ needs.setup.outputs.project-name }}
+
+      - name: Run Tests
+        uses: i2mint/wads/actions/run-tests-uv@master
+        with:
+          root-dir: ${{ needs.setup.outputs.project-name }}
+          pytest-args: ${{ needs.setup.outputs.pytest-args }}
+          exclude-paths: ${{ needs.setup.outputs.exclude-paths }}
+          coverage: ${{ needs.setup.outputs.coverage-enabled }}
+
+      - name: Track Code Metrics
+        if: needs.setup.outputs.metrics-enabled == 'true'
+        uses: i2mint/umpyre/actions/track-metrics@master
+        continue-on-error: true
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          config-path: ${{ needs.setup.outputs.metrics-config-path }}
+          storage-branch: ${{ needs.setup.outputs.metrics-storage-branch }}
+          python-version: ${{ needs.setup.outputs.metrics-python-version }}
+          force-run: ${{ needs.setup.outputs.metrics-force-run }}
+
+  # Optional Windows testing (if enabled in config)
+  windows-validation:
+    name: Windows Tests
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && needs.setup.outputs.test-on-windows == 'true'"
+    needs: setup
+    runs-on: windows-latest
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: i2mint/wads/actions/setup-python-uv@master
+        with:
+          python-version: ${{ fromJson(needs.setup.outputs.python-versions)[0] }}
+
+      - name: Install System Dependencies
+        uses: i2mint/wads/actions/install-system-deps@master
+        with:
+          pyproject-path: .
+
+      - name: Install Dependencies
+        uses: i2mint/wads/actions/install-deps-uv@master
+
+      - name: Run Tests
+        uses: i2mint/wads/actions/run-tests-uv@master
+        with:
+          root-dir: ${{ needs.setup.outputs.project-name }}
+          pytest-args: ${{ needs.setup.outputs.pytest-args }}
+          exclude-paths: ${{ needs.setup.outputs.exclude-paths }}
+
+  # Publishing job
+  publish:
+    name: Publish
+    permissions:
+      contents: write
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main')"
+    needs: [setup, validation]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Set up Python
+        uses: i2mint/wads/actions/setup-python-uv@master
+        with:
+          python-version: ${{ fromJson(needs.setup.outputs.python-versions)[0] }}
+          create-venv: "false"
+
+      - name: Format Source Code
+        if: needs.setup.outputs.ruff-enabled != 'false'
+        run: uvx ruff format .
+
+      - name: Format Source Code (black)
+        if: needs.setup.outputs.black-enabled == 'true'
+        run: uvx black .
+
+      - name: Update Version Number
+        id: version
+        uses: i2mint/isee/actions/bump-version-number@master
+
+      - name: Build Distribution
+        uses: i2mint/wads/actions/build-dist-uv@master
+        with:
+          sdist: ${{ needs.setup.outputs.build-sdist }}
+          wheel: ${{ needs.setup.outputs.build-wheel }}
+
+      - name: Publish to PyPI
+        uses: i2mint/wads/actions/pypi-publish-uv@master
+        with:
+          pypi-token: ${{ secrets.PYPI_PASSWORD }}
+
+      - name: Force SSH for git remote
+        run: git remote set-url origin git@github.com:${{ github.repository }}.git
+
+      - name: Commit Changes
+        uses: i2mint/wads/actions/git-commit@master
+        with:
+          commit-message: "**CI** Formatted code + Updated version to ${{ env.VERSION }} [skip ci]"
+          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+          push: true
+
+      - name: Tag Repository
+        uses: i2mint/wads/actions/git-tag@master
+        with:
+          tag: ${{ env.VERSION }}
+          message: "Release version ${{ env.VERSION }}"
+          push: true
+
+  # Optional GitHub Pages (skipped when [tool.wads.ci.docs].enabled = false)
+  github-pages:
+    name: Publish GitHub Pages
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && needs.setup.outputs.docs-enabled != 'false'"
+    needs: [setup, publish]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: i2mint/epythet/actions/publish-github-pages@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          ignore: "tests/,scrap/,examples/"

http2py-0.1.33/.gitignore

@@ -0,0 +1,112 @@
+docs/*
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+.DS_Store
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# PyCharm
+.idea
+
+# VS Code
+.vscode

{http2py-0.1.30 → http2py-0.1.33}/PKG-INFO

@@ -1,20 +1,43 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.5
 Name: http2py
-Version: 0.1.30
+Version: 0.1.33
 Summary: Tools to create python binders to http web services.
-Home-page: https://github.com/i2mint/http2py
-License: Apache
-Keywords: webservice,http,requests,API
-Platform: any
-Description-Content-Type: text/markdown
+Project-URL: Homepage, https://github.com/i2mint/http2py
+Project-URL: Repository, https://github.com/i2mint/http2py
+Author: Otosense
+License-Expression: Apache-2.0
 License-File: LICENSE
+Keywords: API,http,requests,webservice
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: argh
+Requires-Dist: dill
+Requires-Dist: glom
+Requires-Dist: i2
+Requires-Dist: importlib-resources
+Requires-Dist: ju
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+**Note: A new, lighterweight, more modern replacement: [ho](https://github.com/i2mint/ho)**
+
+# (Http) Requests for humans
 
 [Documentation here](https://i2mint.github.io/http2py/)
 
 `the_one_where_we_have_an_http_service_that_we_want_call_through_normal_looking_python_functions`
 
-# (Http) Requests for humans
-
 Tools to create python binders to http web services.
 Here, we develop python data access to web content through http request such as web services or web pages.
 

{http2py-0.1.30 → http2py-0.1.33}/README.md

@@ -1,9 +1,11 @@
+**Note: A new, lighterweight, more modern replacement: [ho](https://github.com/i2mint/ho)**
+
+# (Http) Requests for humans
+
 [Documentation here](https://i2mint.github.io/http2py/)
 
 `the_one_where_we_have_an_http_service_that_we_want_call_through_normal_looking_python_functions`
 
-# (Http) Requests for humans
-
 Tools to create python binders to http web services.
 Here, we develop python data access to web content through http request such as web services or web pages.
 

http2py-0.1.33/conftest.py

@@ -0,0 +1,21 @@
+"""Pytest configuration for the http2py repository.
+
+``http2py.api_pkg_maker`` imports ``setuptools.sandbox``, which modern
+setuptools no longer ships, so merely *importing* the module raises
+``ImportError``. Under ``--doctest-modules`` that is not a single failing test:
+it aborts collection for the whole session. The module is deliberately left in
+place (whether to rewrite it or remove it is still open on issue #14), so it is
+excluded from collection instead.
+
+CI excludes the same two paths via ``[tool.wads.ci.testing].exclude_paths`` in
+pyproject.toml, which the wads ``run-tests-uv`` action turns into ``--ignore``
+flags. Repeating them here is what makes a bare ``pytest`` (no flags, e.g. a
+local run or an editor's test runner) behave the same way as CI.
+``tests/test_ci_collection_contract.py`` asserts the two lists stay in
+agreement, so they cannot drift apart silently.
+"""
+
+collect_ignore = [
+    "http2py/api_pkg_maker.py",
+    "http2py/tests",
+]

{http2py-0.1.30 → http2py-0.1.33}/http2py/api_pkg_maker.py

@@ -1,3 +1,14 @@
+"""Generate an installable python package from an OpenAPI specification.
+
+Given a spec (or the URL of one), :func:`mk_api_pkg` writes a small source
+distribution whose functions are bound to the service's routes.
+
+Note: this module imports ``setuptools.sandbox``, which modern setuptools no
+longer provides, so importing it raises ``ImportError``. It is kept in place
+pending a decision (rewrite or remove) and is excluded from test collection;
+see the repo-root ``conftest.py``.
+"""
+
 import argh
 import os
 import shutil

{http2py-0.1.30 → http2py-0.1.33}/http2py/authentication.py

@@ -1,7 +1,14 @@
+"""Resolve credentials and build the auth callables that requests will use.
+
+:func:`mk_auth` turns an auth specification -- inline values, environment
+variables, or a JSON credentials file -- into something the request layer can
+attach to outgoing calls.
+"""
+
 import json
 import os
 from pathlib import Path
-from typing import Iterable
+from collections.abc import Iterable
 
 DFLT_CONFIG_FILENAME = os.path.join(Path.home(), ".http2py", "credentials.json")
 

{http2py-0.1.30 → http2py-0.1.33}/http2py/cli_maker.py

@@ -1,3 +1,9 @@
+"""Turn an http-bound python object into a command line interface.
+
+Signatures are first made argparse-friendly (:func:`mk_argparse_friendly`),
+then dispatched with ``argh`` by :func:`mk_cli` / :func:`dispatch_cli`.
+"""
+
 import argh
 from functools import wraps
 from glom import glom
@@ -6,7 +12,7 @@ import json
 import os
 from pathlib import Path
 import requests
-from typing import Callable, Iterable
+from collections.abc import Callable, Iterable
 import yaml
 
 from i2.io_trans import JSONAnnotAndDfltIoTrans

{http2py-0.1.30 → http2py-0.1.33}/http2py/client.py

@@ -1,3 +1,9 @@
+"""The main entry point: a python object facading an http service.
+
+:class:`HttpClient` takes an OpenAPI specification (a dict, or the URL of one)
+and exposes each declared route as a normal python method.
+"""
+
 from glom import glom
 from requests import request, get, Session
 from i2.errors import AuthorizationError

{http2py-0.1.30 → http2py-0.1.33}/http2py/constants.py

@@ -1,3 +1,5 @@
+"""Content-type strings shared across the request and response machinery."""
+
 JSON_CONTENT_TYPE = "application/json"
 BINARY_CONTENT_TYPE = "application/octet-stream"
 FORM_CONTENT_TYPE = "multipart/form-data"

{http2py-0.1.30 → http2py-0.1.33}/http2py/decorators.py

@@ -1,3 +1,10 @@
+"""Response handling: map http status codes to exceptions, decode the payload.
+
+``handle_json_resp`` / ``handle_binary_resp`` / ``handle_raw_resp`` wrap an
+output transformation so it only ever sees a successful response of the
+expected content type.
+"""
+
 from functools import partial
 from i2.errors import (
     AuthorizationError,

{http2py-0.1.30 → http2py-0.1.33}/http2py/default_configs.py

@@ -1,3 +1,5 @@
+"""Default output transformations used when a method spec does not supply one."""
+
 from http2py.decorators import (
     handle_raw_resp,
     handle_json_resp,

{http2py-0.1.30 → http2py-0.1.33}/http2py/example_cli.py

@@ -1,5 +1,7 @@
+"""A tiny worked example of the CLI-making tools, used by the docs and by hand."""
+
 import argh
-from typing import Iterable
+from collections.abc import Iterable
 
 from http2py.cli_maker import mk_argparse_friendly
 from i2.io_trans import AnnotAndDfltIoTrans

{http2py-0.1.30 → http2py-0.1.33}/http2py/global_state.py

@@ -1,3 +1,5 @@
+"""Process-wide state (notably the shared ``requests`` session) for the clients."""
+
 from requests import request, Session
 
 _global_state = {}

{http2py-0.1.30 → http2py-0.1.33}/http2py/py2request.py

@@ -66,7 +66,7 @@ with I2mintModuleNotFoundErrorNiceMessage():
     from i2.signatures import set_signature_of_func, KO
 
 DFLT_PORT = 5000
-DFLT_BASE_URL = "http://localhost:{port}".format(port=DFLT_PORT)
+DFLT_BASE_URL = f"http://localhost:{DFLT_PORT}"
 DFLT_REQUEST_METHOD = "post"
 DFLT_REQUEST_KWARGS = imdict({"method": DFLT_REQUEST_METHOD, "url": ""})
 
@@ -227,7 +227,7 @@ def mk_request_function(
         if "url_template" in method_spec:
             url_template = method_spec["url_template"]
             # Check if the url template already has parameters, add them otherwise
-            if query_arg_names and not re.search("^.*\?((.*=.*)(&?))+$", url_template):
+            if query_arg_names and not re.search(r"^.*\?((.*=.*)(&?))+$", url_template):
                 url_arg_parts = [f"{x}={{{x}}}" for x in query_arg_names if x in kwargs]
                 url_args = "&".join(url_arg_parts)
                 if url_args:
@@ -305,9 +305,9 @@ def mk_request_function(
     if docstring:
         request_func.__doc__ = docstring
 
-    assert callable(
-        output_trans
-    ), f"output_trans {output_trans} is not callable, try again"
+    assert callable(output_trans), (
+        f"output_trans {output_trans} is not callable, try again"
+    )
     return request_func
 
 
@@ -316,7 +316,7 @@ DFLT_METHOD_FUNC_FROM_METHOD_SPEC = mk_request_function
 str_formatter = string.Formatter()
 
 
-class Py2Request(object):
+class Py2Request:
     """Make a class that has methods that offer a python interface to web requests"""
 
     def __init__(
@@ -452,9 +452,9 @@ def _mk_method_func_and_wrap(method_spec, method_func_from_method_spec):
 
 
 def _mk_signature_from_names(arg_names, pk_names):
-    assert set(pk_names) <= set(
-        arg_names
-    ), "The query_arg_names must be a subset of the names in the url_template"
+    assert set(pk_names) <= set(arg_names), (
+        "The query_arg_names must be a subset of the names in the url_template"
+    )
     ko_names = _difference_conserving_order(arg_names, pk_names)
     if ko_names:
         ko_names_str = "*, " + ", ".join(ko_names)
@@ -653,8 +653,9 @@ def mk_method_spec_from_openapi_method_spec(
 
 ##### Open api stuff TODO: To move ###########################################
 from inspect import Parameter, Signature
-from typing import Union, Callable, Iterable
-from typing import Mapping as MappingType
+from typing import Union
+from collections.abc import Callable, Iterable
+from collections.abc import Mapping as MappingType
 
 PK = Parameter.POSITIONAL_OR_KEYWORD
 
@@ -755,7 +756,8 @@ def mk_request_func_from_openapi_spec(
 mk_request_function.from_openapi_spec = mk_request_func_from_openapi_spec
 
 
-from typing import Optional, Iterable, Dict, Tuple, Callable
+from typing import Optional, Dict, Tuple
+from collections.abc import Iterable, Callable
 from ju.oas import Routes
 from http2py.py2request import mk_request_func_from_openapi_spec
 
@@ -773,12 +775,12 @@ def default_path_to_func_name(method: str, uri: str) -> str:
 
 def openapi_to_py(
     openapi_spec: dict,
-    paths: Optional[Iterable[Tuple[str, str]]] = None,
+    paths: Iterable[tuple[str, str]] | None = None,
     *,
     path_to_func_name: Callable[[str, str], str] = default_path_to_func_name,
-    servers: Optional[list] = None,
+    servers: list | None = None,
     default_server_url: str = "http://localhost:8000",
-) -> Dict[str, Callable]:
+) -> dict[str, Callable]:
     """
     Given an OpenAPI spec dict, returns a dict mapping function names to request functions.
     The `servers` argument overrides or provides a default for the OpenAPI servers field.

{http2py-0.1.30 → http2py-0.1.33}/http2py/testing_utils.py

@@ -1,3 +1,9 @@
+"""Helpers for testing code that talks to an http service.
+
+:class:`MockHttpClient` answers without touching the network, and
+:func:`mk_unit_tests` generates test stubs from a client's bound methods.
+"""
+
 from http2py.client import HttpClient
 
 TEST_NUMBER = 100

http2py-0.1.33/http2py/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for http2py that require a live py2http service to be running."""