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

Prune redundant :rtype: from SSL module #1315

Merged
merged 1 commit into from
Jun 28, 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
8 changes: 4 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,19 @@ Documentation

When introducing new functionality, please remember to write documentation.

- New functions and methods should have a docstring describing what they do, what parameters they takes, what types those parameters are, and what they return.
- New functions and methods should have a docstring describing what they do, what parameters they takes, and what they return. They should also come with `type hints`_.

.. code-block:: python

def dump_publickey(type, pkey):
def dump_publickey(type: int, pkey: PKey) -> bytes:
"""
Dump a public key to a buffer.

:param type: The file type (one of :data:`FILETYPE_PEM` or
:data:`FILETYPE_ASN1`).
:param PKey pkey: The PKey to dump.
:param pkey: The PKey to dump.

:return: The buffer with the dumped key in it.
:rtype: bytes
"""


Expand Down Expand Up @@ -110,6 +109,7 @@ Feel free to cross-check this information with Keybase_.
.. _Keybase: https://keybase.io/hynek
.. _pyca/pyopenssl: https://github.com/pyca/pyopenssl
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _`type hints`: https://docs.python.org/3/library/typing.html
.. _cryptography code review process: https://cryptography.io/en/latest/development/reviewing-patches/
.. _freenode: https://freenode.net
.. _mailing list: https://mail.python.org/mailman/listinfo/cryptography-dev
Expand Down
12 changes: 0 additions & 12 deletions src/OpenSSL/SSL.py
Original file line number Diff line number Diff line change
Expand Up @@ -2221,7 +2221,6 @@ def renegotiate(self) -> bool:
Renegotiate the session.

:return: True if the renegotiation can be started, False otherwise
:rtype: bool
"""
if not self.renegotiate_pending():
_openssl_assert(_lib.SSL_renegotiate(self._ssl) == 1)
Expand All @@ -2245,7 +2244,6 @@ def renegotiate_pending(self) -> bool:
a renegotiation is finished.

:return: Whether there's a renegotiation in progress
:rtype: bool
"""
return _lib.SSL_renegotiate_pending(self._ssl) == 1

Expand All @@ -2254,7 +2252,6 @@ def total_renegotiations(self) -> int:
Find out the total number of renegotiations.

:return: The number of renegotiations.
:rtype: int
"""
return _lib.SSL_total_renegotiations(self._ssl)

Expand Down Expand Up @@ -2483,7 +2480,6 @@ def get_state_string(self) -> bytes:
Retrieve a verbose string detailing the state of the Connection.

:return: A string representing the state
:rtype: bytes
"""
return _ffi.string(_lib.SSL_state_string_long(self._ssl))

Expand Down Expand Up @@ -2724,7 +2720,6 @@ def _get_finished_message(self, function) -> Optional[bytes]:

:return: :data:`None` if the desired message has not yet been
received, otherwise the contents of the message.
:rtype: :class:`bytes` or :class:`NoneType`
"""
# The OpenSSL documentation says nothing about what might happen if the
# count argument given is zero. Specifically, it doesn't say whether
Expand Down Expand Up @@ -2754,7 +2749,6 @@ def get_finished(self) -> Optional[bytes]:

:return: The contents of the message or :obj:`None` if the TLS
handshake has not yet completed.
:rtype: :class:`bytes` or :class:`NoneType`

.. versionadded:: 0.15
"""
Expand All @@ -2766,7 +2760,6 @@ def get_peer_finished(self) -> Optional[bytes]:

:return: The contents of the message or :obj:`None` if the TLS
handshake has not yet completed.
:rtype: :class:`bytes` or :class:`NoneType`

.. versionadded:: 0.15
"""
Expand All @@ -2778,7 +2771,6 @@ def get_cipher_name(self) -> Optional[str]:

:returns: The name of the currently used cipher or :obj:`None`
if no connection has been established.
:rtype: :class:`str` or :class:`NoneType`

.. versionadded:: 0.15
"""
Expand All @@ -2795,7 +2787,6 @@ def get_cipher_bits(self) -> Optional[int]:

:returns: The number of secret bits of the currently used cipher
or :obj:`None` if no connection has been established.
:rtype: :class:`int` or :class:`NoneType`

.. versionadded:: 0.15
"""
Expand All @@ -2811,7 +2802,6 @@ def get_cipher_version(self) -> Optional[str]:

:returns: The protocol name of the currently used cipher
or :obj:`None` if no connection has been established.
:rtype: :class:`str` or :class:`NoneType`

.. versionadded:: 0.15
"""
Expand All @@ -2829,7 +2819,6 @@ def get_protocol_version_name(self) -> str:
:returns: The TLS version of the current connection, for example
the value for TLS 1.2 would be ``TLSv1.2``or ``Unknown``
for connections that were not successfully established.
:rtype: :class:`str`
"""
version = _ffi.string(_lib.SSL_get_version(self._ssl))
return version.decode("utf-8")
Expand All @@ -2840,7 +2829,6 @@ def get_protocol_version(self) -> int:

:returns: The TLS version of the current connection. For example,
it will return ``0x769`` for connections made over TLS version 1.
:rtype: :class:`int`
"""
version = _lib.SSL_version(self._ssl)
return version
Expand Down