Skip to content

Commit

Permalink
Remove text signatures such that chatnoir-eu#44 can introduce stub files
Browse files Browse the repository at this point in the history
  • Loading branch information
@jonded94
jonded94 committed Aug 8, 2024
1 parent 61eccd3 commit 1168aa9
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 117 deletions.
54 changes: 0 additions & 54 deletions fastwarc/fastwarc/stream_io.pyx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,6 @@ cdef class IOStream:

def read(self, size_t size):
"""
read(self, size)
Read ``size`` bytes from stream.
:param size: bytes to read
Expand All @@ -76,8 +74,6 @@ cdef class IOStream:

def write(self, bytes data):
"""
write(self, data)
Write bytes to stream.
:param data: data to write
Expand All @@ -90,8 +86,6 @@ cdef class IOStream:

cpdef void seek(self, size_t offset) except *:
"""
seek(self, offset)
Seek to specified offset.
:param offset: seek offset
Expand All @@ -101,8 +95,6 @@ cdef class IOStream:

cpdef size_t tell(self) except -1:
"""
tell(self)
Return current stream offset.
:return: stream offset
Expand All @@ -112,16 +104,12 @@ cdef class IOStream:

cpdef void flush(self) except *:
"""
flush(self)
Flush stream buffer.
"""
pass

cpdef void close(self) except *:
"""
close(self)
Close the stream.
"""
pass
Expand All @@ -131,8 +119,6 @@ cdef class IOStream:
@cython.auto_pickle(False)
cdef class BytesIOStream(IOStream):
"""
__init__(self, initial_data=None)
IOStream that uses an in-memory buffer.
:param initial_data: fill internal buffer with this initial data
Expand Down Expand Up @@ -182,8 +168,6 @@ cdef class BytesIOStream(IOStream):

cpdef string getvalue(self):
"""
getvalue(self)
Get buffer value.
:return: buffer value
Expand All @@ -196,8 +180,6 @@ cdef class BytesIOStream(IOStream):
@cython.auto_pickle(False)
cdef class FileStream(IOStream):
"""
__init__(self, filename=None, mode='rb')
Fast alternative to Python file objects for local files.
:param filename: input filename
Expand Down Expand Up @@ -268,8 +250,6 @@ cdef class FileStream(IOStream):
@cython.auto_pickle(False)
cdef class PythonIOStreamAdapter(IOStream):
"""
__init__(self, py_stream)
IOStream adapter for file-like Python objects.
:param py_stream: input Python stream object
Expand Down Expand Up @@ -311,8 +291,6 @@ cdef class PythonIOStreamAdapter(IOStream):

cpdef IOStream wrap_stream(raw_stream):
"""
wrap_stream(raw_stream)
Wrap ``raw_stream`` into a :class:`PythonIOStreamAdapter` if it is a Python object or
return ``raw_stream`` unmodified if it is a :class:`IOStream` already.
Expand All @@ -334,8 +312,6 @@ cdef class CompressingStream(IOStream):

cpdef size_t begin_member(self):
"""
begin_member(self)
Begin compression member / frame (if not already started).
:return: bytes written
Expand All @@ -345,8 +321,6 @@ cdef class CompressingStream(IOStream):

cpdef size_t end_member(self):
"""
end_member(self)
End compression member / frame (if one has been started).
:return: bytes written
Expand All @@ -359,8 +333,6 @@ cdef class CompressingStream(IOStream):
@cython.auto_pickle(False)
cdef class GZipStream(CompressingStream):
"""
__init__(self, raw_stream, compression_level=9, zlib=False)
GZip :class:`IOStream` implementation.
:param raw_stream: raw data stream
Expand Down Expand Up @@ -418,8 +390,6 @@ cdef class GZipStream(CompressingStream):

cpdef void prepopulate(self, bint deflate, const string& initial_data):
"""
prepopulate(self, initial_data)
Fill internal working buffer with initial data.
Use if some initial data of the stream have already been consumed (e.g., for stream content negotiation).
Has to be called before the first :meth:`read()`.
Expand Down Expand Up @@ -602,8 +572,6 @@ cdef class GZipStream(CompressingStream):
@cython.auto_pickle(False)
cdef class LZ4Stream(CompressingStream):
"""
__init__(self, raw_stream, compression_level=12, favor_dec_speed=True)
LZ4 :class:`IOStream` implementation.
:param raw_stream: raw data stream
Expand Down Expand Up @@ -636,8 +604,6 @@ cdef class LZ4Stream(CompressingStream):

cpdef void prepopulate(self, const string& initial_data):
"""
prepopulate(self, initial_data)
Fill internal working buffer with initial data.
Use if some initial data of the stream have already been consumed (e.g., for stream content negotiation).
Has to be called before the first :meth:`read()`.
Expand Down Expand Up @@ -771,8 +737,6 @@ cdef class LZ4Stream(CompressingStream):
@cython.auto_pickle(False)
cdef class BrotliStream(CompressingStream):
"""
__init__(self, raw_stream, quality=11, lgwin=22, lgblock=0)
Brotli :class:`IOStream` implementation.
Implementation relies on Google's ``brotli`` Python package, will be ported to native
Expand Down Expand Up @@ -861,8 +825,6 @@ cdef class BrotliStream(CompressingStream):
@cython.auto_pickle(False)
cdef class BufferedReader:
"""
__init__(self, stream, buf_size=65536, negotiate_stream=True)
Buffered reader operating on an :class:`IOStream` instance.
:param stream: stream to operate on
Expand Down Expand Up @@ -995,8 +957,6 @@ cdef class BufferedReader:

cpdef bytes read(self, size_t size=strnpos):
"""
read(self, size=-1)
Read up to ``size`` bytes from the input stream.
:param size: number of bytes to read (default means read remaining stream)
Expand All @@ -1021,8 +981,6 @@ cdef class BufferedReader:

cpdef string readline(self, bint crlf=True, size_t max_line_len=8192) except *:
"""
readline(self, crlf=True, max_line_len=8192)
Read a single line from the input stream.
:param crlf: whether lines are separated by CRLF or LF
Expand Down Expand Up @@ -1082,8 +1040,6 @@ cdef class BufferedReader:

cpdef size_t tell(self) except -1:
"""
tell(self)
Offset on the input stream.
:return: offset
Expand All @@ -1104,8 +1060,6 @@ cdef class BufferedReader:

cpdef size_t consume(self, size_t size=strnpos) except -1:
"""
consume(self, size=-1)
Consume up to ``size`` bytes from the input stream without allocating a buffer for it.
:param size: number of bytes to read (default means read remaining stream)
Expand All @@ -1130,8 +1084,6 @@ cdef class BufferedReader:

cpdef void close(self) except *:
"""
close(self)
Close stream.
"""
if self.stream is not None:
Expand All @@ -1140,26 +1092,20 @@ cdef class BufferedReader:

def _buf_reader_py_test_detect_stream_type(BufferedReader buf):
"""
_buf_reader_py_test_detect_stream_type(buf):
Test interface for :meth:`BufferedReader.detect_stream_type`
"""
buf.detect_stream_type()


def _buf_reader_py_test_set_limit(BufferedReader buf, size_t limit):
"""
_buf_reader_py_test_detect_set_limit(buf, limit):
Test interface for :meth:`BufferedReader.set_limit`
"""
buf.set_limit(limit)


def _buf_reader_py_test_reset_limit(BufferedReader buf):
"""
_buf_reader_py_test_reset_limit(buf, limit):
Test interface for :meth:`BufferedReader.reset_limit`
"""
buf.reset_limit()
Loading

0 comments on commit 1168aa9

Please sign in to comment.