Merge branch 'develop' into master

* develop:
  Update CHANGELOG.md
  Fix pylance complaint (#917)
  Add more references to README.rst (#915)
  Pin github-release-commenter (#914)
  Fix doctest (#913)
  Bump softprops/action-gh-release in the github-actions group (#912)
  Bump minimum supported version to Python 3.10 (#911)
  Bump the github-actions group with 2 updates (#910)

Author: ddelange

.github/workflows/python-package.yml

@@ -17,17 +17,17 @@ jobs:
       matrix:
         include:
           # sync with linting steps below
-          - {python-version: '3.9', os: ubuntu-24.04}
+          - {python-version: '3.10', os: ubuntu-24.04}
           - {python-version: '3.14', os: ubuntu-24.04}
 
-          - {python-version: '3.9', os: windows-2025}
+          - {python-version: '3.10', os: windows-2025}
           - {python-version: '3.14', os: windows-2025}
 
-          - {python-version: '3.9', os: macos-15}
+          - {python-version: '3.10', os: macos-15}
           - {python-version: '3.14', os: macos-15}
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # fetch git tags for setuptools_scm (smart_open.__version__)
 
@@ -48,11 +48,11 @@ jobs:
         run: uv pip install -e .[test]
 
       - name: Run flake8 linter (source)
-        if: matrix.python-version == '3.9' # sync with matrix above
+        if: matrix.python-version == '3.10' # sync with matrix above
         run: flake8 --show-source smart_open
 
       - name: "Check whether help.txt update was forgotten"
-        if: matrix.python-version == '3.9' && github.event_name == 'pull_request' # sync with matrix above
+        if: matrix.python-version == '3.10' && github.event_name == 'pull_request' # sync with matrix above
         run: |
           python update_helptext.py
           test ! "$(git diff)" && echo "no changes" || ( git diff && echo 'looks like "python update_helptext.py" was forgotten' && exit 1 )

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       pull-requests: write # apexskier/github-release-commenter
 
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
       with:
         fetch-depth: 0 # fetch git tags for setuptools_scm (smart_open.__version__)
 
@@ -32,16 +32,15 @@ jobs:
         python -m build
 
     - name: Upload package distributions as release assets
-      uses: softprops/action-gh-release@v2.4.1
+      uses: softprops/action-gh-release@v2.5.0
       with:
         files: dist/*
 
     # https://github.com/pypa/gh-action-pypi-publish#trusted-publishing
     - name: Publish package distributions to PyPI
       uses: pypa/gh-action-pypi-publish@v1.13.0
 
-    - uses: apexskier/github-release-commenter@v1.3.6
+    - uses: apexskier/github-release-commenter@v1.4.1
       with:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         comment-template: |
           Released {release_link}

CHANGELOG.md

@@ -1,3 +1,13 @@
+# 7.5.1, 2026-02-23
+
+- Bump the github-actions group with 2 updates (PR [#910](https://github.com/piskvorky/smart_open/pull/910), [@dependabot[bot]](https://github.com/apps/dependabot))
+- Bump minimum supported version to Python 3.10 (PR [#911](https://github.com/piskvorky/smart_open/pull/911), [@DeflateAwning](https://github.com/DeflateAwning))
+- Bump softprops/action-gh-release from 2.4.2 to 2.5.0 in the github-actions group (PR [#912](https://github.com/piskvorky/smart_open/pull/912), [@dependabot[bot]](https://github.com/apps/dependabot))
+- Fix doctest (PR [#913](https://github.com/piskvorky/smart_open/pull/913), [@ddelange](https://github.com/ddelange))
+- Pin github-release-commenter (PR [#914](https://github.com/piskvorky/smart_open/pull/914), [@ddelange](https://github.com/ddelange))
+- Add more references to README.rst (PR [#915](https://github.com/piskvorky/smart_open/pull/915), [@ddelange](https://github.com/ddelange))
+- Fix pylance complaint (PR [#917](https://github.com/piskvorky/smart_open/pull/917), [@ddelange](https://github.com/ddelange))
+
 # 7.5.0, 2025-11-08
 
 - [s3] Support very large buckets in iter_bucket, add client_kwars (PR [#908](https://github.com/piskvorky/smart_open/pull/908), [@ddelange](https://github.com/ddelange))

README.rst

@@ -3,16 +3,20 @@ smart_open — utils for streaming large files in Python
 ======================================================
 
 
-|License|_ |CI|_ |Coveralls|_ |Downloads|_
+|License|_ |CI|_ |Coveralls|_ |Version|_ |Python|_ |Downloads|_
 
 .. |License| image:: https://img.shields.io/pypi/l/smart_open.svg
 .. |CI| image:: https://github.com/piskvorky/smart_open/actions/workflows/python-package.yml/badge.svg?branch=develop&event=push
 .. |Coveralls| image:: https://coveralls.io/repos/github/RaRe-Technologies/smart_open/badge.svg?branch=develop
+.. |Version| image:: https://img.shields.io/pypi/v/smart-open.svg?logo=pypi&logoColor=white
+.. |Python| image:: https://img.shields.io/pypi/pyversions/smart-open.svg?logo=python&logoColor=white
 .. |Downloads| image:: https://pepy.tech/badge/smart-open/month
 .. _License: https://github.com/piskvorky/smart_open/blob/master/LICENSE
 .. _CI: https://github.com/piskvorky/smart_open/actions/workflows/python-package.yml
 .. _Coveralls: https://coveralls.io/github/RaRe-Technologies/smart_open?branch=HEAD
-.. _Downloads: https://pypi.org/project/smart-open/
+.. _Version: https://pypi.org/project/smart-open/
+.. _Python: https://pypi.org/project/smart-open/
+.. _Downloads: https://pypistats.org/packages/smart-open
 
 
 What?
@@ -22,8 +26,6 @@ What?
 
 ``smart_open`` is a drop-in replacement for Python's built-in ``open()``: it can do anything ``open`` can (100% compatible, falls back to native ``open`` wherever possible), plus lots of nifty extra stuff on top.
 
-**Python 2.7 is no longer supported. If you need Python 2.7, please use** `smart_open 1.10.1 <https://github.com/piskvorky/smart_open/releases/tag/1.10.0>`_, **the last version to support Python 2.**
-
 Why?
 ====
 
@@ -79,56 +81,49 @@ How?
   b'User'
 
   >>> # stream from HTTP
-  >>> for line in open('http://example.com/index.html'):
+  >>> for line in open('http://example.com'):
   ...     print(repr(line[:15]))
   ...     break
   '<!doctype html>'
 
 .. _doctools_after_examples:
 
-Other examples of URIs that ``smart_open`` accepts::
+For more examples of URIs that ``smart_open`` accepts, see `help.txt <https://github.com/piskvorky/smart_open/blob/master/help.txt>`__ or ``help('smart_open')``.
+Some examples::
 
     s3://bucket/key
     s3://access_key_id:secret_access_key@bucket/key
-    s3://access_key_id:secret_access_key@server:port@bucket/key
     gs://bucket/blob
     azure://bucket/blob
-    hdfs:///path/file
     hdfs://path/file
-    webhdfs://host:port/path/file
-    ./local/path/file
-    ~/local/path/file
-    local/path/file
     ./local/path/file.gz
-    file:///home/user/file
     file:///home/user/file.bz2
-    [ssh|scp|sftp]://username@host//path/file
-    [ssh|scp|sftp]://username@host/path/file
     [ssh|scp|sftp]://username:password@host/path/file
 
 
 Documentation
 =============
 
-The API reference can be viewed at `help.txt <https://github.com/piskvorky/smart_open/blob/master/help.txt>`__
+The API reference can be viewed at `help.txt <https://github.com/piskvorky/smart_open/blob/master/help.txt>`__ or using ``help('smart_open')``.
 
 Installation
 ------------
 
 ``smart_open`` supports a wide range of storage solutions. For all options, see the API reference.
 Each individual solution has its own dependencies.
-By default, ``smart_open`` does not install any dependencies, in order to keep the installation size small.
-You can install one or more of these dependencies explicitly using optional dependencies:
+By default, ``smart_open`` does not install any dependencies in order to keep the installation size small.
+You can install one or more of these dependencies explicitly using optional dependencies defined in
+`pyproject.toml <https://github.com/piskvorky/smart_open/blob/master/pyproject.toml>`__ :
 
-    pip install smart_open[s3,gcs,azure,http,webhdfs,ssh,zst]
+.. code-block:: sh
 
-Or, if you don't mind installing a large number of third party libraries, you can install all dependencies using::
+    pip install 'smart_open[s3,gcs,azure,http,webhdfs,ssh,zst]'
 
-    pip install smart_open[all]
+Or, if you don't mind installing a large number of third party libraries, you can install all dependencies using:
 
-Be warned that this option increases the installation size significantly, e.g. over 100MB.
+.. code-block:: sh
 
-If you're upgrading from ``smart_open`` versions 2.x and below, please check out the `Migration Guide <MIGRATING_FROM_OLDER_VERSIONS.rst>`_.
+    pip install 'smart_open[all]'
 
 Built-in help
 -------------
@@ -144,9 +139,11 @@ or view `help.txt <https://github.com/piskvorky/smart_open/blob/master/help.txt>
 More examples
 -------------
 
-For the sake of simplicity, the examples below assume you have all the dependencies installed, i.e. you have done::
+For the sake of simplicity, the examples below assume you have all the dependencies installed, i.e. you have done:
+
+.. code-block:: sh
 
-    pip install smart_open[all]
+    pip install 'smart_open[all]'
 
 .. code-block:: python
 
@@ -237,11 +234,14 @@ The supported values for this parameter are:
 
 - ``infer_from_extension`` (default behavior)
 - ``disable``
-- ``.gz``
 - ``.bz2``
+- ``.gz``
+- ``.xz``
 - ``.zst``
 
-By default, ``smart_open`` determines the compression algorithm to use based on the file extension.
+By default, ``smart_open`` automatically (de)compresses the file if the filename ends with one of these extensions.
+`See also <https://github.com/piskvorky/smart_open/blob/master/smart_open/compression.py>`__
+``smart_open.compression.get_supported_compression_types`` and ``mart_open.compression.register_compressor``.
 
 .. code-block:: python
 
@@ -292,13 +292,15 @@ This is just an example: ``lzma`` is in the standard library and is registered b
 Transport-specific Options
 --------------------------
 
-``smart_open`` supports a wide range of transport options out of the box, including:
+``smart_open`` supports a wide range of transport options out of the box.
+For the full list of supported URI schemes, see `help.txt <https://github.com/piskvorky/smart_open/blob/master/help.txt>`__ or ``help('smart_open')``.
+Some examples::
 
-- S3
+- AWS S3 (and any S3-Compatible)
 - HTTP, HTTPS (read-only)
 - SSH, SCP and SFTP
-- WebHDFS
-- GCS
+- HDFS / WebHDFS
+- Google Cloud Storage
 - Azure Blob Storage
 
 Each option involves setting up its own set of parameters.
@@ -312,7 +314,7 @@ Here are some examples of using this parameter:
   >>> fin = open('s3://commoncrawl/robots.txt', transport_params=dict(client=boto3.client('s3')))
   >>> fin = open('s3://commoncrawl/robots.txt', transport_params=dict(buffer_size=1024))
 
-For the full list of keyword arguments supported by each transport option, see the documentation:
+For the full list of keyword arguments supported by each transport option, see `help.txt <https://github.com/piskvorky/smart_open/blob/master/help.txt>`__ or ``help('smart_open')``.
 
 .. code-block:: python
 

help.txt

@@ -337,7 +337,7 @@ FUNCTIONS
         b'User'
 
         >>> # stream from HTTP
-        >>> for line in open('http://example.com/index.html'):
+        >>> for line in open('http://example.com'):
         ...     print(repr(line[:15]))
         ...     break
 

pyproject.toml

@@ -11,7 +11,7 @@ description = "Utils for streaming large files (S3, HDFS, GCS, SFTP, Azure Blob
 readme = "README.rst"
 urls = {Repository = "https://github.com/piskvorky/smart_open"}
 authors = [{name = "Radim Rehurek", email = "me@radimrehurek.com"}]
-requires-python = ">=3.9,<4.0" # sync with classifiers below
+requires-python = ">=3.10,<4.0" # sync with classifiers below
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Environment :: Console",
@@ -20,7 +20,6 @@ classifiers = [
   "Operating System :: OS Independent",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",

smart_open/doctools.py

@@ -16,11 +16,21 @@
 import io
 import os.path
 import re
+import sys
 
 from . import compression
 from . import transport
 
-PLACEHOLDER = '    smart_open/doctools.py magic goes here'
+#
+# Python 3.13+ automatically trims docstrings (like inspect.cleandoc),
+# so we need to adjust the placeholder and indentation accordingly.
+#
+if sys.version_info >= (3, 13):
+    PLACEHOLDER = 'smart_open/doctools.py magic goes here'
+    LPAD = ''
+else:
+    PLACEHOLDER = '    smart_open/doctools.py magic goes here'
+    LPAD = '    '
 
 
 def extract_kwargs(docstring):
@@ -143,7 +153,7 @@ def to_docstring(kwargs, lpad=''):
     return buf.getvalue()
 
 
-def extract_examples_from_readme_rst(indent='    '):
+def extract_examples_from_readme_rst(indent=None):
     """Extract examples from this project's README.rst file.
 
     Parameters
@@ -160,6 +170,8 @@ def extract_examples_from_readme_rst(indent='    '):
     -----
     Quite fragile, depends on named labels inside the README.rst file.
     """
+    if indent is None:
+        indent = LPAD
     curr_dir = os.path.dirname(os.path.abspath(__file__))
     readme_path = os.path.join(curr_dir, '..', 'README.rst')
     try:
@@ -180,7 +192,7 @@ def tweak_open_docstring(f):
     root_path = os.path.dirname(os.path.dirname(__file__))
 
     with contextlib.redirect_stdout(buf):
-        print('    smart_open supports the following transport mechanisms:')
+        print(f'{LPAD}smart_open supports the following transport mechanisms:')
         print()
         for scheme, submodule in sorted(transport._REGISTRY.items()):
             if scheme == transport.NO_SCHEME or submodule in seen:
@@ -194,27 +206,27 @@ def tweak_open_docstring(f):
 
             relpath = os.path.relpath(submodule.__file__, start=root_path)
             heading = '%s (%s)' % ("/".join(schemes), relpath)
-            print('    %s' % heading)
-            print('    %s' % ('~' * len(heading)))
-            print('    %s' % submodule.__doc__.split('\n')[0])
+            print(f'{LPAD}{heading}')
+            print(f'{LPAD}{"~" * len(heading)}')
+            print(f'{LPAD}{submodule.__doc__.split(chr(10))[0]}')
             print()
 
             kwargs = extract_kwargs(submodule.open.__doc__)
             if kwargs:
-                print(to_docstring(kwargs, lpad=u'    '))
+                print(to_docstring(kwargs, lpad=LPAD))
 
-        print('    Examples')
-        print('    --------')
+        print(f'{LPAD}Examples')
+        print(f'{LPAD}--------')
         print()
-        print(extract_examples_from_readme_rst())
+        print(extract_examples_from_readme_rst(indent=LPAD))
 
-        print('    This function also supports transparent compression and decompression ')
-        print('    using the following codecs:')
+        print(f'{LPAD}This function also supports transparent compression and decompression ')
+        print(f'{LPAD}using the following codecs:')
         print()
         for extension in compression.get_supported_extensions():
-            print('    * %s' % extension)
+            print(f'{LPAD}* {extension}')
         print()
-        print('    The function depends on the file extension to determine the appropriate codec.')
+        print(f'{LPAD}The function depends on the file extension to determine the appropriate codec.')
 
     #
     # The docstring can be None if -OO was passed to the interpreter.
@@ -246,15 +258,15 @@ def tweak_parse_uri_docstring(f):
             schemes.append(scheme)
 
     with contextlib.redirect_stdout(buf):
-        print('    Supported URI schemes are:')
+        print(f'{LPAD}Supported URI schemes are:')
         print()
         for scheme in schemes:
-            print('    * %s' % scheme)
+            print(f'{LPAD}* {scheme}')
         print()
-        print('    Valid URI examples::')
+        print(f'{LPAD}Valid URI examples::')
         print()
         for example in examples:
-            print('    * %s' % example)
+            print(f'{LPAD}* {example}')
 
     if f.__doc__:
         f.__doc__ = f.__doc__.replace(PLACEHOLDER, buf.getvalue())

smart_open/utils.py

@@ -214,6 +214,10 @@ def __init__(self, outer, inner):
         super().__init__(outer)
         self.__inner = inner
 
+    def __enter__(self):
+        """This explicit proxy method is only required for pylance ref #916."""
+        return self.__wrapped__.__enter__()
+
     def __exit__(self, *args, **kwargs):
         """Exit inner after exiting outer."""
         try: