Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for python 3.13 #847

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,14 @@ jobs:
- {python-version: '3.10', os: ubuntu-20.04}
- {python-version: '3.11', os: ubuntu-20.04}
- {python-version: '3.12', os: ubuntu-20.04}
- {python-version: '3.13', os: ubuntu-20.04}

- {python-version: '3.8', os: windows-2019}
- {python-version: '3.9', os: windows-2019}
- {python-version: '3.10', os: windows-2019}
- {python-version: '3.11', os: windows-2019}
- {python-version: '3.12', os: windows-2019}
- {python-version: '3.13', os: windows-2019}
steps:
- uses: actions/checkout@v2

Expand Down Expand Up @@ -67,6 +69,7 @@ jobs:
- {python-version: '3.10', os: ubuntu-20.04}
- {python-version: '3.11', os: ubuntu-20.04}
- {python-version: '3.12', os: ubuntu-20.04}
- {python-version: '3.13', os: ubuntu-20.04}

#
# Some of the doctests don't pass on Windows because of Windows-specific
Expand All @@ -76,6 +79,9 @@ jobs:
# - {python-version: '3.8', os: windows-2019}
# - {python-version: '3.9', os: windows-2019}
# - {python-version: '3.10', os: windows-2019}
# - {python-version: '3.11', os: windows-2019}
# - {python-version: '3.12', os: windows-2019}
# - {python-version: '3.13', os: windows-2019}

steps:
- uses: actions/checkout@v2
Expand Down Expand Up @@ -104,13 +110,17 @@ jobs:
- {python-version: '3.10', os: ubuntu-20.04}
- {python-version: '3.11', os: ubuntu-20.04}
- {python-version: '3.12', os: ubuntu-20.04}
- {python-version: '3.13', os: ubuntu-20.04}

# Not sure why we exclude these, perhaps for historical reasons?
#
# - {python-version: '3.7', os: windows-2019}
# - {python-version: '3.8', os: windows-2019}
# - {python-version: '3.9', os: windows-2019}
# - {python-version: '3.10', os: windows-2019}
# - {python-version: '3.11', os: windows-2019}
# - {python-version: '3.12', os: windows-2019}
# - {python-version: '3.13', os: windows-2019}

steps:
- uses: actions/checkout@v2
Expand Down Expand Up @@ -153,11 +163,15 @@ jobs:
- {python-version: '3.10', os: ubuntu-20.04}
- {python-version: '3.11', os: ubuntu-20.04}
- {python-version: '3.12', os: ubuntu-20.04}
- {python-version: '3.13', os: ubuntu-20.04}

# - {python-version: '3.7', os: windows-2019}
# - {python-version: '3.8', os: windows-2019}
# - {python-version: '3.9', os: windows-2019}
# - {python-version: '3.10', os: windows-2019}
# - {python-version: '3.11', os: windows-2019}
# - {python-version: '3.12', os: windows-2019}
# - {python-version: '3.13', os: windows-2019}

steps:
- uses: actions/checkout@v2
Expand Down
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ The supported values for this parameter are:
- ``disable``
- ``.gz``
- ``.bz2``
- ``.zst``

By default, ``smart_open`` determines the compression algorithm to use based on the file extension.

Expand Down
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ def read(fname):
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Programming Language :: Python :: 3.12',
'Programming Language :: Python :: 3.13',
'Topic :: System :: Distributed Computing',
'Topic :: Database :: Front-Ends',
],
Expand Down
52 changes: 32 additions & 20 deletions smart_open/azure.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,9 @@ class Reader(io.BufferedIOBase):
Implements the io.BufferedIOBase interface of the standard library.

:raises azure.core.exceptions.ResourceNotFoundError: Raised when the blob to read from does not exist.

"""
_blob = None # so `closed` property works in case __init__ fails and __del__ is called

def __init__(
self,
container,
Expand All @@ -207,9 +208,10 @@ def __init__(
max_concurrency=DEFAULT_MAX_CONCURRENCY,
):
self._container_name = container
self._blob_name = blob

self._blob = _get_blob_client(client, container, blob)
# type: azure.storage.blob.BlobClient
self._blob = _get_blob_client(client, container, blob)

if self._blob is None:
raise azure.core.exceptions.ResourceNotFoundError(
Expand All @@ -236,8 +238,13 @@ def __init__(
def close(self):
"""Flush and close this stream."""
logger.debug("close: called")
self._blob = None
self._raw_reader = None
if not self.closed:
self._blob = None
self._raw_reader = None

@property
def closed(self):
return self._blob is None

def readable(self):
"""Return True if the stream can be read from."""
Expand Down Expand Up @@ -369,20 +376,26 @@ def __exit__(self, exc_type, exc_val, exc_tb):
self.close()

def __str__(self):
return "(%s, %r, %r)" % (self.__class__.__name__,
self._container_name,
self._blob.blob_name)
return "(%s, %r, %r)" % (
self.__class__.__name__,
self._container_name,
self._blob_name
)

def __repr__(self):
return "%s(container=%r, blob=%r)" % (
self.__class__.__name__, self._container_name, self._blob.blob_name,
self.__class__.__name__,
self._container_name,
self._blob_name,
)


class Writer(io.BufferedIOBase):
"""Writes bytes to Azure Blob Storage.

Implements the io.BufferedIOBase interface of the standard library."""
Implements the io.BufferedIOBase interface of the standard library.
"""
_blob = None # so `closed` property works in case __init__ fails and __del__ is called

def __init__(
self,
Expand All @@ -392,21 +405,19 @@ def __init__(
blob_kwargs=None,
min_part_size=_DEFAULT_MIN_PART_SIZE,
):
self._is_closed = False
self._container_name = container

self._blob = _get_blob_client(client, container, blob)
self._blob_name = blob
self._blob_kwargs = blob_kwargs or {}
# type: azure.storage.blob.BlobClient

self._min_part_size = min_part_size

self._total_size = 0
self._total_parts = 0
self._bytes_uploaded = 0
self._current_part = io.BytesIO()
self._block_list = []

# type: azure.storage.blob.BlobClient
self._blob = _get_blob_client(client, container, blob)

#
# This member is part of the io.BufferedIOBase interface.
#
Expand All @@ -424,25 +435,26 @@ def terminate(self):
logger.debug('%s: terminating multipart upload', self)
if not self.closed:
self._block_list = []
self._is_closed = True
self._blob = None
logger.debug('%s: terminated multipart upload', self)

#
# Override some methods from io.IOBase.
#
def close(self):
logger.debug("close: called")
if not self.closed:
logger.debug('%s: completing multipart upload', self)
if self._current_part.tell() > 0:
self._upload_part()
self._blob.commit_block_list(self._block_list, **self._blob_kwargs)
self._block_list = []
self._is_closed = True
self._blob = None
logger.debug('%s: completed multipart upload', self)

@property
def closed(self):
return self._is_closed
return self._blob is None

def writable(self):
"""Return True if the stream supports writing."""
Expand Down Expand Up @@ -528,13 +540,13 @@ def __str__(self):
return "(%s, %r, %r)" % (
self.__class__.__name__,
self._container_name,
self._blob.blob_name
self._blob_name
)

def __repr__(self):
return "%s(container=%r, blob=%r, min_part_size=%r)" % (
self.__class__.__name__,
self._container_name,
self._blob.blob_name,
self._blob_name,
self._min_part_size
)
25 changes: 20 additions & 5 deletions smart_open/hdfs.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ class CliRawInputBase(io.RawIOBase):

Implements the io.RawIOBase interface of the standard library.
"""
_sub = None # so `closed` property works in case __init__ fails and __del__ is called

def __init__(self, uri):
self._uri = uri
Expand All @@ -84,8 +85,13 @@ def __init__(self, uri):
def close(self):
"""Flush and close this stream."""
logger.debug("close: called")
self._sub.terminate()
self._sub = None
if not self.closed:
self._sub.terminate()
self._sub = None

@property
def closed(self):
return self._sub is None

def readable(self):
"""Return True if the stream can be read from."""
Expand Down Expand Up @@ -125,6 +131,8 @@ class CliRawOutputBase(io.RawIOBase):

Implements the io.RawIOBase interface of the standard library.
"""
_sub = None # so `closed` property works in case __init__ fails and __del__ is called

def __init__(self, uri):
self._uri = uri
self._sub = subprocess.Popen(["hdfs", "dfs", '-put', '-f', '-', self._uri],
Expand All @@ -136,9 +144,16 @@ def __init__(self, uri):
self.raw = None

def close(self):
self.flush()
self._sub.stdin.close()
self._sub.wait()
logger.debug("close: called")
if not self.closed:
self.flush()
self._sub.stdin.close()
self._sub.wait()
self._sub = None

@property
def closed(self):
return self._sub is None

def flush(self):
self._sub.stdin.flush()
Expand Down
11 changes: 9 additions & 2 deletions smart_open/http.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ def open(uri, mode, kerberos=False, user=None, password=None, cert=None,


class BufferedInputBase(io.BufferedIOBase):
response = None # so `closed` property works in case __init__ fails and __del__ is called

def __init__(self, url, mode='r', buffer_size=DEFAULT_BUFFER_SIZE,
kerberos=False, user=None, password=None, cert=None,
headers=None, session=None, timeout=None):
Expand Down Expand Up @@ -149,8 +151,13 @@ def __init__(self, url, mode='r', buffer_size=DEFAULT_BUFFER_SIZE,
def close(self):
"""Flush and close this stream."""
logger.debug("close: called")
self.response = None
self._read_iter = None
if not self.closed:
self.response = None
self._read_iter = None

@property
def closed(self):
return self.response is None

def readable(self):
"""Return True if the stream can be read from."""
Expand Down
12 changes: 10 additions & 2 deletions smart_open/s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -703,6 +703,7 @@ def __init__(

def close(self):
"""Flush and close this stream."""
logger.debug("close: called")
pass

def readable(self):
Expand Down Expand Up @@ -869,6 +870,7 @@ class MultipartWriter(io.BufferedIOBase):
"""Writes bytes to S3 using the multi part API.

Implements the io.BufferedIOBase interface of the standard library."""
_upload_id = None # so `closed` property works in case __init__ fails and __del__ is called

def __init__(
self,
Expand Down Expand Up @@ -925,6 +927,10 @@ def flush(self):
# Override some methods from io.IOBase.
#
def close(self):
logger.debug("close: called")
if self.closed:
return

if self._buf.tell():
self._upload_next_part()

Expand Down Expand Up @@ -1027,7 +1033,7 @@ def write(self, b: Buffer) -> int:

def terminate(self):
"""Cancel the underlying multipart upload."""
if self._upload_id is None:
if self.closed:
return
logger.debug('%s: terminating multipart upload', self)
self._client.abort_multipart_upload(
Expand Down Expand Up @@ -1112,6 +1118,7 @@ class SinglepartWriter(io.BufferedIOBase):

This class buffers all of its input in memory until its `close` method is called. Only then will
the data be written to S3 and the buffer is released."""
_buf = None # so `closed` property works in case __init__ fails and __del__ is called

def __init__(
self,
Expand Down Expand Up @@ -1147,7 +1154,8 @@ def flush(self):
# Override some methods from io.IOBase.
#
def close(self):
if self._buf is None:
logger.debug("close: called")
if self.closed:
return

self._buf.seek(0)
Expand Down
10 changes: 10 additions & 0 deletions smart_open/tests/test_azure.py
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,16 @@ def test_read_blob_client(self):

assert data == content

def test_nonexisting_container(self):
with self.assertRaises(azure.core.exceptions.ResourceNotFoundError):
with smart_open.azure.open(
'thiscontainerdoesntexist',
'mykey',
'rb',
CLIENT
) as fin:
fin.read()


class WriterTest(unittest.TestCase):
"""Test writing into Azure Blob files."""
Expand Down
2 changes: 1 addition & 1 deletion smart_open/tests/test_http.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class HttpTest(unittest.TestCase):

@responses.activate
def test_read_all(self):
responses.add(responses.GET, URL, body=BYTES, stream=True)
responses.add(responses.GET, URL, body=BYTES)
reader = smart_open.http.SeekableBufferedInputBase(URL)
read_bytes = reader.read()
self.assertEqual(BYTES, read_bytes)
Expand Down
Loading
Loading