summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatěj Cepl <mcepl@cepl.eu>2023-02-02 15:32:46 +0100
committerMatěj Cepl <mcepl@cepl.eu>2023-02-02 17:11:27 +0100
commit67eefd5a811a52048a93b111cd0407b5b17be8d8 (patch)
tree505fc8a93f7c6fdb804e36002730f51a71bb7f58
parent827ce39e9f722dc42cb966e5cbbee603c48f2249 (diff)
downloadm2crypto-67eefd5a811a52048a93b111cd0407b5b17be8d8.tar.gz
Add some documentation strings for ASN1.ASN1_Time methods.
-rw-r--r--src/M2Crypto/ASN1.py28
1 files changed, 25 insertions, 3 deletions
diff --git a/src/M2Crypto/ASN1.py b/src/M2Crypto/ASN1.py
index 3bd85de..b29326a 100644
--- a/src/M2Crypto/ASN1.py
+++ b/src/M2Crypto/ASN1.py
@@ -182,7 +182,7 @@ class ASN1_TIME(object):
self.asn1_time = asn1_time
self._pyfree = _pyfree
else:
- self.asn1_time = m2.asn1_time_new()
+ self.asn1_time = m2.asn1_time_new() # type: bytes (ASN1_TIME*)
self._pyfree = 1
def __del__(self):
@@ -205,20 +205,36 @@ class ASN1_TIME(object):
def set_string(self, string):
# type: (bytes) -> int
- """Set time from UTC string."""
+ """
+ Set time from UTC string.
+
+ :return: 1 if the time value is successfully set and 0
+ otherwise
+ """
assert m2.asn1_time_type_check(self.asn1_time), \
"'asn1_time' type error'"
return m2.asn1_time_set_string(self.asn1_time, string)
def set_time(self, time):
# type: (int) -> ASN1_TIME
- """Set time from seconds since epoch (int)."""
+ """
+ Set time from seconds since epoch (int).
+
+ :return: pointer to a time structure or NULL if an error
+ occurred
+ """
assert m2.asn1_time_type_check(self.asn1_time), \
"'asn1_time' type error'"
return m2.asn1_time_set(self.asn1_time, time)
def get_datetime(self):
# type: () -> datetime.datetime
+ """
+ Get time as datetime.datetime object
+
+ :return: always return datetime object
+ :raises: ValueError if anything wrong happens
+ """
date = str(self)
timezone = None
@@ -242,6 +258,12 @@ class ASN1_TIME(object):
def set_datetime(self, date):
# type: (datetime.datetime) -> ASN1_TIME
+ """
+ Set time from datetime.datetime object.
+
+ :return: pointer to a time structure or NULL if an error
+ occurred
+ """
local = LocalTimezone()
if date.tzinfo is None:
date = date.replace(tzinfo=local)