sseclient-py 1.7.2__tar.gz → 2.0.0__tar.gz

sseclient_py-2.0.0/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14", "3.15"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - run: uv run --frozen pytest -q
+
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          python-version: "3.15"
+          enable-cache: true
+      - run: uv run --frozen pre-commit run --all-files
+      - run: uv run --frozen mypy --strict --python-version 3.11 tests/typing_smoke.py
+      - run: uv build
+      - run: uv run --frozen twine check dist/*

sseclient_py-2.0.0/.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          python-version: "3.15"
+      - name: Check release version
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: uv run --frozen python -c 'import os; from sseclient.version import version; assert os.environ["RELEASE_TAG"] == f"sseclient-py-{version}", "Release tag does not match package version"'
+      - run: uv run --frozen pytest -q
+      - run: uv build
+      - run: uv run --frozen twine check dist/*
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: dist
+          path: dist/*
+          if-no-files-found: error
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+        with:
+          attestations: true

sseclient_py-2.0.0/.gitignore

@@ -0,0 +1,66 @@
+# macOS
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+.venv/
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

sseclient_py-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.5
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format

sseclient_py-2.0.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.5
+Name: sseclient-py
+Version: 2.0.0
+Summary: Server-Sent Events client for Python
+Project-URL: Repository, https://github.com/mpetazzoni/sseclient
+Project-URL: Issues, https://github.com/mpetazzoni/sseclient/issues
+Project-URL: PyPI, https://pypi.org/project/sseclient-py/
+Author-email: Maxime Petazzoni <maxime.petazzoni@bulix.org>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: eventsource,server-sent-events,sse
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+
+Server-Sent Events client for Python
+====================================
+
+``sseclient-py`` turns a streaming HTTP response into Server-Sent Events (SSE).
+It works with ``requests``, ``urllib3`` and ``httpx``, and has no dependencies.
+Python 3.11 or newer is required.
+
+Installation
+------------
+
+.. code:: console
+
+    $ pip install sseclient-py
+
+Usage
+-----
+
+.. code:: python
+
+    import requests
+    import sseclient
+
+    url = "https://example.com/events"
+    with requests.get(
+        url,
+        headers={"Accept": "text/event-stream"},
+        stream=True,
+        timeout=(3.05, 60),
+    ) as response:
+        response.raise_for_status()
+        for event in sseclient.SSEClient(response).events():
+            print(event.id, event.event, event.data)
+
+The timeout is a connect/read timeout, not a limit on the whole stream. Adjust
+the read timeout to allow for your server's keep-alive interval.
+
+Other HTTP clients
+------------------
+
+Pass the client's byte stream to ``SSEClient``:
+
+.. code:: python
+
+    import httpx
+    import urllib3
+
+    # urllib3
+    http = urllib3.PoolManager()
+    response = http.request("GET", url, preload_content=False)
+    client = sseclient.SSEClient(response.stream())
+
+    # httpx
+    with httpx.stream("GET", url) as response:
+        client = sseclient.SSEClient(response.iter_bytes())
+        for event in client.events():
+            print(event.data)
+
+Reconnecting
+------------
+
+Manage connections and retries in your application. Reconnect when ``events()``
+ends or the HTTP client raises a connection or read-timeout error. Use a delay
+or backoff between attempts.
+
+Resuming depends on the server. When ``event.id is not None``, remember that ID,
+including an empty string (which clears it). Send a non-empty remembered ID in
+the next request's ``Last-Event-ID`` header. ID-only updates are not exposed by
+this parser; duplicate-free delivery is not guaranteed.
+
+The yielded events have ``id``, ``event``, ``data`` and ``retry`` attributes.
+Comments and events without data are ignored.
+
+Resources
+---------
+
+- `SSE specification <https://html.spec.whatwg.org/multipage/server-sent-events.html>`_
+- `PyPI <https://pypi.org/project/sseclient-py/>`_
+- `Source and issues <https://github.com/mpetazzoni/sseclient>`_

sseclient_py-2.0.0/README.rst

@@ -0,0 +1,78 @@
+Server-Sent Events client for Python
+====================================
+
+``sseclient-py`` turns a streaming HTTP response into Server-Sent Events (SSE).
+It works with ``requests``, ``urllib3`` and ``httpx``, and has no dependencies.
+Python 3.11 or newer is required.
+
+Installation
+------------
+
+.. code:: console
+
+    $ pip install sseclient-py
+
+Usage
+-----
+
+.. code:: python
+
+    import requests
+    import sseclient
+
+    url = "https://example.com/events"
+    with requests.get(
+        url,
+        headers={"Accept": "text/event-stream"},
+        stream=True,
+        timeout=(3.05, 60),
+    ) as response:
+        response.raise_for_status()
+        for event in sseclient.SSEClient(response).events():
+            print(event.id, event.event, event.data)
+
+The timeout is a connect/read timeout, not a limit on the whole stream. Adjust
+the read timeout to allow for your server's keep-alive interval.
+
+Other HTTP clients
+------------------
+
+Pass the client's byte stream to ``SSEClient``:
+
+.. code:: python
+
+    import httpx
+    import urllib3
+
+    # urllib3
+    http = urllib3.PoolManager()
+    response = http.request("GET", url, preload_content=False)
+    client = sseclient.SSEClient(response.stream())
+
+    # httpx
+    with httpx.stream("GET", url) as response:
+        client = sseclient.SSEClient(response.iter_bytes())
+        for event in client.events():
+            print(event.data)
+
+Reconnecting
+------------
+
+Manage connections and retries in your application. Reconnect when ``events()``
+ends or the HTTP client raises a connection or read-timeout error. Use a delay
+or backoff between attempts.
+
+Resuming depends on the server. When ``event.id is not None``, remember that ID,
+including an empty string (which clears it). Send a non-empty remembered ID in
+the next request's ``Last-Event-ID`` header. ID-only updates are not exposed by
+this parser; duplicate-free delivery is not guaranteed.
+
+The yielded events have ``id``, ``event``, ``data`` and ``retry`` attributes.
+Comments and events without data are ignored.
+
+Resources
+---------
+
+- `SSE specification <https://html.spec.whatwg.org/multipage/server-sent-events.html>`_
+- `PyPI <https://pypi.org/project/sseclient-py/>`_
+- `Source and issues <https://github.com/mpetazzoni/sseclient>`_

sseclient_py-2.0.0/RELEASING.md

@@ -0,0 +1,21 @@
+# Releasing
+
+Releases are built and published by `.github/workflows/publish.yml` when a GitHub release is published. The workflow checks the tag against the package version, runs the tests and package checks, then uploads the wheel and source distribution with PyPI provenance attestations.
+
+## One-time PyPI setup
+
+No API token is stored in GitHub. In [PyPI project management](https://pypi.org/manage/projects/), open `sseclient-py`, then **Publishing**, and add a GitHub publisher with these exact values:
+
+- Owner: `mpetazzoni`
+- Repository: `sseclient`
+- Workflow name: `publish.yml`
+- Environment name: `pypi`
+
+Optionally create the `pypi` environment in the GitHub repository settings and require maintainer approval before publishing. If configured on PyPI, the environment name must match.
+
+## Making a release
+
+1. Update `version` in `sseclient/version.py` and merge the release changes to `main`.
+2. Create a GitHub release from `main` with tag `sseclient-py-<version>`, for example `sseclient-py-2.0.0`.
+3. Publish the GitHub release. The workflow publishes the same version to PyPI and attaches attestations automatically.
+4. Check the workflow result and the new PyPI release's **Provenance** section.

sseclient_py-2.0.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sseclient-py"
+dynamic = ["version"]
+description = "Server-Sent Events client for Python"
+requires-python = ">=3.11"
+readme = "README.rst"
+authors = [
+  { name = "Maxime Petazzoni", email = "maxime.petazzoni@bulix.org" },
+]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = ["sse", "server-sent-events", "eventsource"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
+  "Topic :: Internet :: WWW/HTTP",
+]
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/mpetazzoni/sseclient"
+Issues = "https://github.com/mpetazzoni/sseclient/issues"
+PyPI = "https://pypi.org/project/sseclient-py/"
+
+[tool.hatch.version]
+path = "sseclient/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["sseclient"]
+
+[dependency-groups]
+dev = [
+    "mypy",
+    "pre-commit",
+    "pytest",
+    "ruff",
+    "twine",
+]
+
+[tool.ruff]
+target-version = "py311"
+
+[tool.uv]
+required-version = ">=0.13.5,<0.14"

{sseclient-py-1.7.2 → sseclient_py-2.0.0}/sseclient/__init__.py

@@ -4,26 +4,23 @@ Server Side Events (SSE) client for Python.
 Provides a generator of SSE received through an existing HTTP response.
 """
 
-# Copyright (C) 2016-2017 SignalFx, Inc. All rights reserved.
-
 import logging
 
-__author__ = 'Maxime Petazzoni <maxime.petazzoni@bulix.org>'
-__email__ = 'maxime.petazzoni@bulix.org'
-__copyright__ = 'Copyright (C) 2016-2017 SignalFx, Inc. All rights reserved.'
-__all__ = ['SSEClient']
+__author__ = "Maxime Petazzoni <maxime.petazzoni@bulix.org>"
+__email__ = "maxime.petazzoni@bulix.org"
+__all__ = ["SSEClient"]
 
-_FIELD_SEPARATOR = ':'
+_FIELD_SEPARATOR = ":"
 
 
-class SSEClient(object):
+class SSEClient:
     """Implementation of a SSE client.
 
     See http://www.w3.org/TR/2009/WD-eventsource-20091029/ for the
     specification.
     """
 
-    def __init__(self, event_source, char_enc='utf-8'):
+    def __init__(self, event_source, char_enc="utf-8"):
         """Initialize the SSE client over an existing, ready to consume
         event source.
 
@@ -32,8 +29,7 @@ class SSEClient(object):
         io.BinaryIOBase, like an httplib or urllib3 HTTPResponse object.
         """
         self._logger = logging.getLogger(self.__class__.__module__)
-        self._logger.debug('Initialized SSE client from event source %s',
-                           event_source)
+        self._logger.debug("Initialized SSE client from event source %s", event_source)
         self._event_source = event_source
         self._char_enc = char_enc
 
@@ -44,23 +40,38 @@ class SSEClient(object):
         event into multiple HTTP chunks in the response. It is thus necessary
         to correctly stitch together consecutive response chunks and find the
         SSE delimiter (empty new line) to yield full, correct event chunks."""
-        data = b''
+        data = b""
+        pending_cr = False
         for chunk in self._event_source:
             for line in chunk.splitlines(True):
+                # A CRLF split between chunks is still a single line ending.
+                if pending_cr:
+                    pending_cr = False
+                    if line == b"\n":
+                        continue
+                if line.endswith(b"\r\n"):
+                    line = line[:-2] + b"\n"
+                elif line.endswith(b"\r"):
+                    line = line[:-1] + b"\n"
+                    pending_cr = True
                 data += line
-                if data.endswith((b'\r\r', b'\n\n', b'\r\n\r\n')):
+                if data.endswith(b"\n\n"):
                     yield data
-                    data = b''
+                    data = b""
         if data:
             yield data
 
     def events(self):
+        first_line = True
         for chunk in self._read():
             event = Event()
             # Split before decoding so splitlines() only uses \r and \n
             for line in chunk.splitlines():
                 # Decode the line.
                 line = line.decode(self._char_enc)
+                if first_line:
+                    line = line.removeprefix("\ufeff")
+                    first_line = False
 
                 # Lines starting with a separator are comments and are to be
                 # ignored.
@@ -72,27 +83,28 @@ class SSEClient(object):
 
                 # Ignore unknown fields.
                 if field not in event.__dict__:
-                    self._logger.debug('Saw invalid field %s while parsing '
-                                       'Server Side Event', field)
+                    self._logger.debug(
+                        "Saw invalid field %s while parsing Server Side Event", field
+                    )
                     continue
 
                 if len(data) > 1:
                     # From the spec:
                     # "If value starts with a single U+0020 SPACE character,
                     # remove it from value."
-                    if data[1].startswith(' '):
+                    if data[1].startswith(" "):
                         value = data[1][1:]
                     else:
                         value = data[1]
                 else:
                     # If no value is present after the separator,
                     # assume an empty value.
-                    value = ''
+                    value = ""
 
                 # The data field may come over multiple lines and their values
                 # are concatenated with each other.
-                if field == 'data':
-                    event.__dict__[field] += value + '\n'
+                if field == "data":
+                    event.__dict__[field] += value + "\n"
                 else:
                     event.__dict__[field] = value
 
@@ -101,14 +113,14 @@ class SSEClient(object):
                 continue
 
             # If the data field ends with a newline, remove it.
-            if event.data.endswith('\n'):
+            if event.data.endswith("\n"):
                 event.data = event.data[0:-1]
 
             # Empty event names default to 'message'
-            event.event = event.event or 'message'
+            event.event = event.event or "message"
 
             # Dispatch the event
-            self._logger.debug('Dispatching %s...', event)
+            self._logger.debug("Dispatching %s...", event)
             yield event
 
     def close(self):
@@ -116,24 +128,23 @@ class SSEClient(object):
         self._event_source.close()
 
 
-class Event(object):
+class Event:
     """Representation of an event from the event stream."""
 
-    def __init__(self, id=None, event='message', data='', retry=None):
+    def __init__(self, id=None, event="message", data="", retry=None):
         self.id = id
         self.event = event
         self.data = data
         self.retry = retry
 
     def __str__(self):
-        s = '{0} event'.format(self.event)
+        s = f"{self.event} event"
         if self.id:
-            s += ' #{0}'.format(self.id)
+            s += f" #{self.id}"
         if self.data:
-            s += ', {0} byte{1}'.format(len(self.data),
-                                        's' if len(self.data) else '')
+            s += ", {} byte{}".format(len(self.data), "s" if len(self.data) else "")
         else:
-            s += ', no data'
+            s += ", no data"
         if self.retry:
-            s += ', retry in {0}ms'.format(self.retry)
+            s += f", retry in {self.retry}ms"
         return s

sseclient_py-2.0.0/sseclient/__init__.pyi

@@ -0,0 +1,26 @@
+"""
+Server Side Events (SSE) client for Python.
+
+Provides a generator of SSE received through an existing HTTP response.
+"""
+
+from collections.abc import Generator, Iterable
+from typing import Any
+
+__all__ = ["SSEClient"]
+
+class SSEClient:
+    """SSE client interface."""
+
+    def __init__(self, event_source: Iterable[bytes], char_enc: str = "utf-8"): ...
+    # Keep all parameters explicit for Python 3.11 type checkers.
+    def events(self) -> Generator[Event, None, None]: ...  # noqa: UP043
+    def close(self) -> None: ...
+
+class Event:
+    """Representation of an event from the event stream."""
+
+    id: str | None
+    event: str
+    data: str
+    retry: Any | None

sseclient_py-2.0.0/sseclient/version.py

@@ -0,0 +1,2 @@
+name = "sseclient-py"
+version = "2.0.0"