Moved from "utilities" to "utils" for ease of use.

sarusso · Mar 14, 2024 · 0b7b616 · 0b7b616
1 parent f8fdd1b
commit 0b7b616
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 52 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -32,7 +32,7 @@ Modules
      :toctree:
 
      time
-     utilities
+     utils
      logger
      exceptions
 

diff --git a/docs/propertime.utilities.rst b/docs/propertime.utilities.rst
diff --git a/docs/propertime.utils.rst b/docs/propertime.utils.rst
@@ -1,7 +1,7 @@
-propertimeutilitiess
-================
+propertime.utilities
+====================
 
-.. automodule:: propertimeutilitiess
+.. automodule:: propertime.utilities
 
 
 
@@ -18,6 +18,7 @@
       dt
       dt_from_s
       dt_from_str
+      get_offset_from_dt
       get_tz_offset
       is_dt_ambiguous_without_offset
       is_dt_inconsistent

diff --git a/docs/source/propertime.rst b/docs/source/propertime.rst
@@ -13,7 +13,7 @@ propertime.time module
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: propertime.utilities
+.. automodule:: propertime.utils
    :members:
    :inherited-members:
    :undoc-members:

diff --git a/propertime/tests/test_time.py b/propertime/tests/test_time.py
@@ -4,7 +4,7 @@
 import unittest
 import pytz
 from datetime import datetime
-from ..utilities import dt, correct_dt_dst, str_from_dt, dt_from_str, s_from_dt, dt_from_s, as_tz, timezonize, now_s
+from ..utils import dt, correct_dt_dst, str_from_dt, dt_from_str, s_from_dt, dt_from_s, as_tz, timezonize, now_s
 from ..time import Time, TimeSpan
 from dateutil.tz.tz import tzoffset
 try:

diff --git a/propertime/tests/test_utilities.py → propertime/tests/test_utils.py b/propertime/tests/test_utilities.py → propertime/tests/test_utils.py
@@ -4,7 +4,7 @@
 import unittest
 import datetime
 import pytz
-from ..utilities import dt, correct_dt_dst, str_from_dt, dt_from_str, s_from_dt, dt_from_s, as_tz, timezonize, is_dt_ambiguous_without_offset
+from ..utils import dt, correct_dt_dst, str_from_dt, dt_from_str, s_from_dt, dt_from_s, as_tz, timezonize, is_dt_ambiguous_without_offset
 from ..time import Time
 from dateutil.tz.tz import tzoffset
 try:

diff --git a/propertime/time.py b/propertime/time.py
@@ -7,7 +7,7 @@
 import copy
 from datetime import datetime, timedelta
 from dateutil.tz.tz import tzoffset
-from .utilities import dt, timezonize, dt_from_s, s_from_dt, dt_from_str, now_s, str_from_dt, \
+from .utils import dt, timezonize, dt_from_s, s_from_dt, dt_from_str, now_s, str_from_dt, \
                        get_tz_offset, is_numerical, is_dt_inconsistent, is_dt_ambiguous_without_offset, \
                        correct_dt_dst, get_offset_from_dt
 from .exceptions import ConsistencyError
@@ -413,7 +413,7 @@ def from_dt(cls, dt, tz='auto', offset='auto', guessing=False):
                 if not guessing:
                     raise ValueError('Sorry, datetime {} is ambiguous on time zone {} without an offset'.format(dt_naive, dt.tzinfo))
                 else:
-                    # TODO: move to a _get_utc_offset() support function. Used also in Time __str__ and dt() in utilities
+                    # TODO: move to a _get_utc_offset() support function. Used also in Time __str__ and dt() in utils
                     iso_time_part = str_from_dt(dt).split('T')[1]
                     if '+' in iso_time_part:
                         offset_assumed = '+'+iso_time_part.split('+')[1]

diff --git a/propertime/utilities.py → propertime/utils.py b/propertime/utilities.py → propertime/utils.py
-Original file line number
+Diff line change
@@ Expand Up / @@ -32,7 +32,7 @@ Modules @@
          :toctree:
          time
-         utilities
+         utils
          logger
          exceptions
@@ Expand Down @@