Clean up neo4j.time public exports

Make undocumented internal constants, helper functions, and other items in
`neo4j.time` private:

* `DATE_ISO_PATTERN`
* `TIME_ISO_PATTERN`
* `DURATION_ISO_PATTERN`
* `NANO_SECONDS`
* `AVERAGE_SECONDS_IN_MONTH`
* `AVERAGE_SECONDS_IN_DAY`
* `FORMAT_F_REPLACE`
* `IS_LEAP_YEAR`
* `DAYS_IN_YEAR`
* `DAYS_IN_MONTH`
* `round_half_to_even`
* `symmetric_divmod`
* `DateTimeType`
* `DateType`
* `TimeType`
* all other indirectly exposed items from imports (e.g. `re` as `neo4j.time.re`)

Author: robsdedude

CHANGELOG.md

@@ -72,7 +72,7 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
   - Remove `ExperimentalWarning` and turn the few left instances of it into `PreviewWarning`.
   - Deprecate importing `PreviewWarning` from `neo4j`.  
     Import it from `neo4j.warnings` instead.
-- Make undocumented internal constants private:
+- Make undocumented internal constants, helper functions, and other items private:
   - `neo4j.api`
     - `DRIVER_BOLT`
     - `DRIVER_NEO4J`
@@ -86,6 +86,27 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
     - `ERROR_REWRITE_MAP`
     - `client_errors`
     - `transient_errors`
+  - `neo4j.time`
+    - `DATE_ISO_PATTERN`
+    - `TIME_ISO_PATTERN`
+    - `DURATION_ISO_PATTERN`
+    - `NANO_SECONDS`
+    - `AVERAGE_SECONDS_IN_MONTH`
+    - `AVERAGE_SECONDS_IN_DAY`
+    - `FORMAT_F_REPLACE`
+    - `IS_LEAP_YEAR`
+    - `DAYS_IN_YEAR`
+    - `DAYS_IN_MONTH`
+    - `round_half_to_even`
+    - `symmetric_divmod`
+    - `DateTimeType`
+    - `DateType`
+    - `TimeType`
+    - all other indirectly exposed items from imports (e.g. `re` as `neo4j.time.re`)
+- Deprecate ClockTime and its accessors
+  - For each `neo4j.time.Date`, `neo4j.time.DateTime`, `neo4j.time.Time`
+    - `from_clock_time` and `to_clock_time` methods
+  - `neo4j.time.ClockTime` itself
 - Raise `ConfigurationError` instead of ignoring the routing context (URI query parameters) when creating a direct
   driver ("bolt[+s[sc]]://" scheme).
 - Change behavior of closed drivers:

docs/source/conf.py

@@ -124,12 +124,13 @@
 autodoc_typehints = "description"
 
 autodoc_type_aliases = {
-    # The code-base uses `import typing_extensions as te`.
+    # The code-base uses `import typing_extensions as te` / `as _te`.
     # Re-write these to use `typing` instead, as Sphinx always resolves against
     # the latest version of the `typing` module.
     # This is a work-around to make Sphinx resolve type hints correctly, even
     # though we're using `from __future__ import annotations`.
     "te": typing,
+    "_te": typing,
     # Type alias that's only defined and imported if `typing.TYPE_CHECKING`
     # is `True`.
     "_TAuth": "typing.Tuple[typing.Any, typing.Any] | Auth | None",

src/neo4j/_codec/hydration/v1/temporal.py

@@ -25,12 +25,12 @@
     pd,
 )
 from ....time import (
+    _NANO_SECONDS,
     Date,
     DateTime,
     Duration,
     MAX_YEAR,
     MIN_YEAR,
-    NANO_SECONDS,
     Time,
 )
 from ...packstream import Structure
@@ -170,8 +170,8 @@ def seconds_and_nanoseconds(dt):
         if isinstance(dt, datetime):
             dt = DateTime.from_native(dt)
         zone_epoch = DateTime(1970, 1, 1, tzinfo=dt.tzinfo)
-        dt_clock_time = dt.to_clock_time()
-        zone_epoch_clock_time = zone_epoch.to_clock_time()
+        dt_clock_time = dt._to_clock_time()
+        zone_epoch_clock_time = zone_epoch._to_clock_time()
         t = dt_clock_time - zone_epoch_clock_time
         return t.seconds, t.nanoseconds
 
@@ -226,7 +226,8 @@ def dehydrate_np_datetime(value):
             )
         seconds = value.astype(np.dtype("datetime64[s]")).astype(int)
         nanoseconds = (
-            value.astype(np.dtype("datetime64[ns]")).astype(int) % NANO_SECONDS
+            value.astype(np.dtype("datetime64[ns]")).astype(int)
+            % _NANO_SECONDS
         )
         return Structure(b"d", seconds, nanoseconds)
 

src/neo4j/_codec/hydration/v2/temporal.py

@@ -21,9 +21,9 @@
 
 from ...._optional_deps import pd
 from ....time import (
+    _NANO_SECONDS,
     Date,
     DateTime,
-    NANO_SECONDS,
     Time,
 )
 from ...packstream import Structure
@@ -74,8 +74,8 @@ def seconds_and_nanoseconds(dt):
             dt = DateTime.from_native(dt)
         dt = dt.astimezone(pytz.UTC)
         utc_epoch = DateTime(1970, 1, 1, tzinfo=pytz.UTC)
-        dt_clock_time = dt.to_clock_time()
-        utc_epoch_clock_time = utc_epoch.to_clock_time()
+        dt_clock_time = dt._to_clock_time()
+        utc_epoch_clock_time = utc_epoch._to_clock_time()
         t = dt_clock_time - utc_epoch_clock_time
         return t.seconds, t.nanoseconds
 
@@ -119,7 +119,7 @@ def dehydrate_pandas_datetime(value):
         :type value: pandas.Timestamp
         :returns:
         """
-        seconds, nanoseconds = divmod(value.value, NANO_SECONDS)
+        seconds, nanoseconds = divmod(value.value, _NANO_SECONDS)
 
         tz = value.tzinfo
         if tz is None: