Skip to content

Commit 586b819

Browse files
committed
refactor(utilities): rename the timestamp module to datetime (#2134)
Per the owner's ruling on #2136, pcapkit.utilities.timestamp becomes pcapkit.utilities.datetime, reusing the stdlib name as utilities.logging and utilities.warnings do. The old path was added by #2111 and is in no release, so it is deleted with no re-export. - move the module and its docs page, and update the toctree - update the MH, PCAP frame and PCAP-NG importers and the tests - test that the new module exposes fromtimestamp and totimestamp, imports the stdlib datetime, and that the old path no longer imports
1 parent d5c0e7c commit 586b819

12 files changed

Lines changed: 65 additions & 25 deletions

File tree

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
Timestamp Conversion
22
====================
33

4-
.. module:: pcapkit.utilities.timestamp
4+
.. module:: pcapkit.utilities.datetime
55

6-
:mod:`pcapkit.utilities.timestamp` converts a UNIX timestamp to an aware
6+
:mod:`pcapkit.utilities.datetime` converts a UNIX timestamp to an aware
77
:class:`~datetime.datetime` without the C library's range (:issue:`2099`), and
88
a :class:`~datetime.datetime` back to a UNIX timestamp without GraalPy's lost
99
second before 1970 (:issue:`2134`). It is shared by the PCAP and PCAP-NG readers
1010
and writers and the MH timestamp options, which is why it lives here rather than
1111
beside any one of them.
1212

13-
.. autofunction:: pcapkit.utilities.timestamp.fromtimestamp
13+
.. autofunction:: pcapkit.utilities.datetime.fromtimestamp
1414

15-
.. autofunction:: pcapkit.utilities.timestamp.totimestamp
15+
.. autofunction:: pcapkit.utilities.datetime.totimestamp

‎docs/source/pcapkit/utilities/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ conversion, and wrappers around third-party libraries. It imports nothing from
1818
logging
1919
config
2020
chardet
21-
timestamp
21+
datetime
2222

2323
Version Compatibility
2424
=====================

‎pcapkit/protocols/internet/mh.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,8 +496,8 @@
496496
UpdateNotificationMessage as Schema_UpdateNotificationMessage
497497
from pcapkit.protocols.schema.internet.mh import VendorSpecificOption as Schema_VendorSpecificOption
498498
from pcapkit.protocols.schema.schema import Schema
499+
from pcapkit.utilities.datetime import fromtimestamp, totimestamp
499500
from pcapkit.utilities.exceptions import EnumValueError, ProtocolError, UnsupportedCall
500-
from pcapkit.utilities.timestamp import fromtimestamp, totimestamp
501501
from pcapkit.utilities.warnings import ProtocolWarning, RegistryWarning, warn
502502

503503
if TYPE_CHECKING:

‎pcapkit/protocols/misc/pcap/frame.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@
4848
from pcapkit.protocols.schema.misc.pcap.frame import Frame as Schema_Frame
4949
from pcapkit.protocols.schema.misc.pcap.header import RESOLUTION
5050
from pcapkit.utilities.compat import localcontext
51+
from pcapkit.utilities.datetime import fromtimestamp, totimestamp
5152
from pcapkit.utilities.exceptions import StreamEOFError, UnsupportedCall, stacklevel
52-
from pcapkit.utilities.timestamp import fromtimestamp, totimestamp
5353
from pcapkit.utilities.warnings import ProtocolWarning, RegistryWarning, warn
5454

5555
if TYPE_CHECKING:

‎pcapkit/protocols/misc/pcapng.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,9 @@
210210
from pcapkit.protocols.schema.misc.pcapng import zigbee_key_held
211211
from pcapkit.protocols.schema.schema import Schema
212212
from pcapkit.utilities.compat import StrEnum, localcontext
213+
from pcapkit.utilities.datetime import fromtimestamp, totimestamp
213214
from pcapkit.utilities.exceptions import (BaseError, EnumValueError, FormatError, ProtocolError,
214215
StreamEOFError, UnsupportedCall, stacklevel)
215-
from pcapkit.utilities.timestamp import fromtimestamp, totimestamp
216216
from pcapkit.utilities.warnings import (AttributeWarning, DeprecatedFormatWarning, ProtocolWarning,
217217
RegistryWarning, warn)
218218

‎pcapkit/protocols/schema/internet/mh.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@
6161
UInt64Field)
6262
from pcapkit.corekit.fields.strings import BitField, BytesField, PaddingField, StringField
6363
from pcapkit.protocols.schema.schema import EnumSchema, Schema, schema_final
64+
from pcapkit.utilities.datetime import fromtimestamp
6465
from pcapkit.utilities.logging import SPHINX_TYPE_CHECKING
65-
from pcapkit.utilities.timestamp import fromtimestamp
6666

6767
__all__ = [
6868
'MH',
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
"""Timestamp Conversion
33
======================
44
5-
.. module:: pcapkit.utilities.timestamp
5+
.. module:: pcapkit.utilities.datetime
66
7-
:mod:`pcapkit.utilities.timestamp` converts a UNIX timestamp to an aware
7+
:mod:`pcapkit.utilities.datetime` converts a UNIX timestamp to an aware
88
:class:`~datetime.datetime` without the C library's range (:issue:`2099`), and
99
a :class:`~datetime.datetime` back to a UNIX timestamp without GraalPy's lost
1010
second before 1970 (:issue:`2134`).

‎tests/protocols/misc/pcap/test_header_frame_unit.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ class Other(Raw):
296296
bad_time._fnum = 6
297297
bad_time._file = io.BytesIO(b'')
298298
# Faked through frame.py's own binding of
299-
# :func:`pcapkit.utilities.timestamp.fromtimestamp`, which it calls
299+
# :func:`pcapkit.utilities.datetime.fromtimestamp`, which it calls
300300
# instead of :meth:`datetime.datetime.fromtimestamp` since #2099.
301301
with mock.patch('pcapkit.protocols.misc.pcap.frame.fromtimestamp', side_effect=ValueError), \
302302
mock.patch.object(Frame, '_decode_next_layer',

‎tests/protocols/misc/test_fromtimestamp_windows_range_2099_unit.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ def test_stdlib_fromtimestamp_fails_outside_the_crt_range(self) -> None:
110110

111111

112112
class TestFromTimestamp(unittest.TestCase):
113-
""":func:`pcapkit.utilities.timestamp.fromtimestamp` against the stdlib inside the CRT range."""
113+
""":func:`pcapkit.utilities.datetime.fromtimestamp` against the stdlib inside the CRT range."""
114114

115115
def test_matches_the_stdlib_where_both_can_answer(self) -> None:
116-
from pcapkit.utilities.timestamp import fromtimestamp
116+
from pcapkit.utilities.datetime import fromtimestamp
117117

118118
zones = (UTC, datetime.timezone(datetime.timedelta(hours=-5)),
119119
datetime.timezone(datetime.timedelta(seconds=86399)))
@@ -131,7 +131,7 @@ def test_matches_the_stdlib_where_both_can_answer(self) -> None:
131131
self.assertIs(type(actual), _REAL_DATETIME)
132132

133133
def test_errors_are_cpythons(self) -> None:
134-
from pcapkit.utilities.timestamp import fromtimestamp
134+
from pcapkit.utilities.datetime import fromtimestamp
135135

136136
cases = (
137137
(float('nan'), ValueError), (float('inf'), OverflowError), (2.0**63, OverflowError),

‎tests/protocols/misc/test_pcapng_unit.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ def now(cls, tz):
559559
section=types.SimpleNamespace(byteorder='little'))
560560
pcapng._type = BlockType.Enhanced_Packet_Block
561561
# Faked through pcapng.py's own binding of
562-
# :func:`pcapkit.utilities.timestamp.fromtimestamp`, which it calls
562+
# :func:`pcapkit.utilities.datetime.fromtimestamp`, which it calls
563563
# instead of :meth:`datetime.datetime.fromtimestamp` since #2099.
564564
with mock.patch('pcapkit.protocols.misc.pcapng.fromtimestamp', side_effect=ValueError), \
565565
mock.patch('pcapkit.protocols.misc.pcapng.warn') as warn:

0 commit comments

Comments
 (0)