infdate 0.2.4__py3-none-any.whl → 0.2.5__py3-none-any.whl

infdate/__init__.py

@@ -164,6 +164,16 @@ class GenericDate:
         """Return the date, pretty printed"""
         raise NotImplementedError
 
+    def tonative(
+        self: _GD,
+        /,
+        *,
+        exact: bool = False,
+        fmt: str = ISO_DATE_FORMAT,
+    ) -> str | float | None:
+        """Return the native equivalent of the date"""
+        raise NotImplementedError
+
 
 class InfinityDate(GenericDate):
     """Infinity Date object"""
@@ -193,7 +203,6 @@ class InfinityDate(GenericDate):
             f"{self.__class__.__name__} instances do not support .replace()"
         )
 
-    @final
     def pretty(
         self,
         /,
@@ -212,6 +221,19 @@ class InfinityDate(GenericDate):
         #
         return pretty_result or self.isoformat()
 
+    def tonative(
+        self,
+        /,
+        *,
+        exact: bool = False,
+        fmt: str = ISO_DATE_FORMAT,
+    ) -> str | float | None:
+        """Return the native equivalent of the date"""
+        if not exact:
+            return None
+        #
+        return self.toordinal()
+
 
 # pylint: disable=too-many-instance-attributes
 class RealDate(GenericDate):
@@ -255,7 +277,6 @@ class RealDate(GenericDate):
             )
         )
 
-    @final
     def pretty(
         self,
         /,
@@ -268,6 +289,16 @@ class RealDate(GenericDate):
         """Return the date, pretty printed"""
         return self.strftime(fmt)
 
+    def tonative(
+        self,
+        /,
+        *,
+        exact: bool = False,
+        fmt: str = ISO_DATE_FORMAT,
+    ) -> str | float | None:
+        """Return the native equivalent of the date"""
+        return self.strftime(fmt)
+
 
 # -----------------------------------------------------------------------------
 # Private module functions

{infdate-0.2.4.dist-info → infdate-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: infdate
-Version: 0.2.4
+Version: 0.2.5
 Summary: Date object wrapper supporting infinity
 Project-URL: Homepage, https://gitlab.com/blackstream-x/infdate
 Project-URL: CI, https://gitlab.com/blackstream-x/infdate/-/pipelines
@@ -49,10 +49,10 @@ contain the two possible **InfinityDate** instance variations.
 The module -level constants **REAL_MIN** and **REAL_MAX** are the eqivalents
 of **datetime.date.min** and **datetime.date.max** as **RealDate** instances.
 
-For any valid **RealDate** instance, the following is **True**:
+For any **RealDate** instance, the following is **True**:
 
 ``` python
-infdate.MIN < infdate.REAL_MIN <= real_date_instance <= infdate.REAL_MAX < infdate.MAX
+infdate.INFINITE_PAST < infdate.REAL_MIN <= real_date_instance <= infdate.REAL_MAX < infdate.INFINITE_FUTURE
 ```
 
 ### Module-level constants
@@ -61,8 +61,8 @@ infdate.MIN < infdate.REAL_MIN <= real_date_instance <= infdate.REAL_MAX < infda
 *   **INFINITE_FUTURE** = **InfinityDate(**_past_bound_=`False`**)** → infinity after any date
 *   **MIN** = **INFINITE_PAST**
 *   **MAX** = **INFINITE_FUTURE**
-*   **REAL_MIN** = **RealDate(**_`1`, `1`, `1`_**)** → the same date as **datetime.date.min**
-*   **REAL_MAX** = **RealDate(**_`9999`, `12`, `31`_**)** → the same date as **datetime.date.max**
+*   **REAL_MIN** = **RealDate(**`1`, `1`, `1`**)** → the same date as **datetime.date.min**
+*   **REAL_MAX** = **RealDate(**`9999`, `12`, `31`**)** → the same date as **datetime.date.max**
 *   **MIN_ORDINAL** = `1` → the same value as **datetime.date.min.toordinal()**
 *   **MAX_ORDINAL** = `3652059` → the same value as **datetime.date.max.toordinal()**
 *   **RESOLUTION** = `1` → represents the lowest possible date difference: _one day_
@@ -109,8 +109,17 @@ Some notable difference from the **datetime.date** class, mainly due to the desi
     from an **InfinityDate** or **RealDate**, only **float** or **int**
     (support for adding and subtracting datetime.timedelta instances might be added in the future, [see the feature request]).
 
-*   infdate module classes have a **.pretty()** method that can be used to format **RealDate** instances with a format string like **.strftime()** (provided with the _fmt_ argument that defaults to the ISO format `%Y-%m-%d`),
-    or to apply a custom format to **InfinityDate** classes using the _inf_common_prefix_, _inf_past_suffix_ and _inf_future_suffix_ arguments.
+
+### Additional methods
+
+*   **.pretty()** can be used to format **RealDate** instances with a format string like **.strftime()** (provided with the _fmt_ argument that defaults to the ISO format `%Y-%m-%d`),
+    or to apply a custom format to **InfinityDate** classes using the _inf_common_prefix_, _inf_past_suffix_, and _inf_future_suffix_ arguments.
+
+*   **.tonative()** is the inverse function of   the **fromnative()** constructor, returning a value tha can be used e.g. as a value for an API.
+
+    For **InfinityDate** instances, it returns the **.toordinal()** result if the _exact_ argument is set `True`, or `None` if it is left at the default (`False`).
+ 
+    For **RealDate** instances, this method works the same way as **.pretty()**, using the _fmt_ argument with the same default as above.
 
 
 ## Example usage

infdate-0.2.5.dist-info/RECORD

@@ -0,0 +1,6 @@
+infdate/__init__.py,sha256=DlsZLMj4BLRl1VAZR7EYO2hwLsSNU9_3GLtvvioUsj4,14274
+infdate/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+infdate-0.2.5.dist-info/METADATA,sha256=0UHBEJVBt3ohOH7LiPN2AcwaMhPeQIWETpaSWhi_w6M,7016
+infdate-0.2.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+infdate-0.2.5.dist-info/licenses/LICENSE,sha256=867pxriiObx28vCU1JsRtu3H9kUKyl54e0-xl1IIv3Y,913
+infdate-0.2.5.dist-info/RECORD,,

infdate-0.2.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-infdate/__init__.py,sha256=IIJ8ZoTGNoBeFTt86_ysMCUVBj36r8vcqpReJa6EiUM,13523
-infdate/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-infdate-0.2.4.dist-info/METADATA,sha256=O22fG8KKeSgLV2hDAN8pkM2JmKh4i-_yCX_glIlTGp8,6569
-infdate-0.2.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-infdate-0.2.4.dist-info/licenses/LICENSE,sha256=867pxriiObx28vCU1JsRtu3H9kUKyl54e0-xl1IIv3Y,913
-infdate-0.2.4.dist-info/RECORD,,