nice-duration 0.7.0__tar.gz

nice_duration-0.7.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tom Koelman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nice_duration-0.7.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: nice_duration
+Version: 0.7.0
+Summary: Nice formatting of timedelta instances
+Author: Tom Koelman
+License: MIT License
+        
+        Copyright (c) 2025 Tom Koelman
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/tomkoelman/nice_duration
+Project-URL: Issues, https://github.com/tomkoelman/nice_duration/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# nice_duration
+
+This is a Python module that introduces a way of formatting a
+`timedelta` instance like so: `3h12m`. It can also format an `int`
+representing a number of seconds in the same way.
+
+The `separator` parameter, which defaults to the empty string,
+determines what the individual components are concatenated with.
+Setting `separator` to a single space changes the above example to
+`3h 12m`.
+
+Components with value 0 are left out. That can be changed by setting
+ - `keep_leading_zeroes`
+ - `keep_trailing_zeroes`
+ - `keep_infix_zeroes`
+
+For example, by setting `keep_trailing_zeroes` to `True`, the example `duration_string` is
+changed to `3h12m0s`.
+
+For convenience, setting `keep_zeroes` to `True` will set all three
+`keep_*_zeroes` to `True`.
+
+** Examples
+```python
+>>> from datetime import timedelta
+>>> from nice_duration import duration_string
+>>> delta = timedelta(hours=3, minutes=20)
+>>> duration_string(delta)
+'3h20m'
+```
+
+```python
+>>> duration_string(200) # When an int is given, it is interpreted as a number of seconds
+'3h20m'
+```
+
+Setting `separator`:
+
+```python
+>>> duration_string(delta, separator=" ")
+'3h 20m'
+```
+
+Setting `keep_zeroes`:
+
+```python
+>>> duration_string(delta, keep_zeroes=True)
+'0w0d3h20m0s'
+```
+
+Setting `keep_trailing_zeroes`:
+```python
+>>> duration_string(delta, keep_trailing_zeroes=True)
+'3h20m0s'
+```
+
+Setting `keep_leading_zeroes`:
+```python
+>>> duration_string(delta, keep_leading_zeroes=True)
+'0w0d3h20m'
+```
+
+Setting `keep_infix_zeroes`:
+```python
+>>> duration_string(timedelta(hours=3, seconds=11), keep_infix_zeroes=True)
+'3h0m11s'
+```
+
+Return value when `timedelta` is 0:
+```python
+>>> duration_string(timedelta())
+'0s'
+```

nice_duration-0.7.0/README.md

@@ -0,0 +1,73 @@
+# nice_duration
+
+This is a Python module that introduces a way of formatting a
+`timedelta` instance like so: `3h12m`. It can also format an `int`
+representing a number of seconds in the same way.
+
+The `separator` parameter, which defaults to the empty string,
+determines what the individual components are concatenated with.
+Setting `separator` to a single space changes the above example to
+`3h 12m`.
+
+Components with value 0 are left out. That can be changed by setting
+ - `keep_leading_zeroes`
+ - `keep_trailing_zeroes`
+ - `keep_infix_zeroes`
+
+For example, by setting `keep_trailing_zeroes` to `True`, the example `duration_string` is
+changed to `3h12m0s`.
+
+For convenience, setting `keep_zeroes` to `True` will set all three
+`keep_*_zeroes` to `True`.
+
+** Examples
+```python
+>>> from datetime import timedelta
+>>> from nice_duration import duration_string
+>>> delta = timedelta(hours=3, minutes=20)
+>>> duration_string(delta)
+'3h20m'
+```
+
+```python
+>>> duration_string(200) # When an int is given, it is interpreted as a number of seconds
+'3h20m'
+```
+
+Setting `separator`:
+
+```python
+>>> duration_string(delta, separator=" ")
+'3h 20m'
+```
+
+Setting `keep_zeroes`:
+
+```python
+>>> duration_string(delta, keep_zeroes=True)
+'0w0d3h20m0s'
+```
+
+Setting `keep_trailing_zeroes`:
+```python
+>>> duration_string(delta, keep_trailing_zeroes=True)
+'3h20m0s'
+```
+
+Setting `keep_leading_zeroes`:
+```python
+>>> duration_string(delta, keep_leading_zeroes=True)
+'0w0d3h20m'
+```
+
+Setting `keep_infix_zeroes`:
+```python
+>>> duration_string(timedelta(hours=3, seconds=11), keep_infix_zeroes=True)
+'3h0m11s'
+```
+
+Return value when `timedelta` is 0:
+```python
+>>> duration_string(timedelta())
+'0s'
+```

nice_duration-0.7.0/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "nice_duration"
+version = "0.7.0"
+authors = [
+  { name="Tom Koelman" },
+]
+description = "Nice formatting of timedelta instances"
+readme = "README.md"
+requires-python = ">=3.13"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+license = {file = "LICENSE"}
+dependencies = []
+
+
+[project.urls]
+Homepage = "https://github.com/tomkoelman/nice_duration"
+Issues = "https://github.com/tomkoelman/nice_duration/issues"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.5",
+    "twine>=6.1.0",
+]
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]

nice_duration-0.7.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

nice_duration-0.7.0/src/nice_duration.egg-info/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: nice_duration
+Version: 0.7.0
+Summary: Nice formatting of timedelta instances
+Author: Tom Koelman
+License: MIT License
+        
+        Copyright (c) 2025 Tom Koelman
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/tomkoelman/nice_duration
+Project-URL: Issues, https://github.com/tomkoelman/nice_duration/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# nice_duration
+
+This is a Python module that introduces a way of formatting a
+`timedelta` instance like so: `3h12m`. It can also format an `int`
+representing a number of seconds in the same way.
+
+The `separator` parameter, which defaults to the empty string,
+determines what the individual components are concatenated with.
+Setting `separator` to a single space changes the above example to
+`3h 12m`.
+
+Components with value 0 are left out. That can be changed by setting
+ - `keep_leading_zeroes`
+ - `keep_trailing_zeroes`
+ - `keep_infix_zeroes`
+
+For example, by setting `keep_trailing_zeroes` to `True`, the example `duration_string` is
+changed to `3h12m0s`.
+
+For convenience, setting `keep_zeroes` to `True` will set all three
+`keep_*_zeroes` to `True`.
+
+** Examples
+```python
+>>> from datetime import timedelta
+>>> from nice_duration import duration_string
+>>> delta = timedelta(hours=3, minutes=20)
+>>> duration_string(delta)
+'3h20m'
+```
+
+```python
+>>> duration_string(200) # When an int is given, it is interpreted as a number of seconds
+'3h20m'
+```
+
+Setting `separator`:
+
+```python
+>>> duration_string(delta, separator=" ")
+'3h 20m'
+```
+
+Setting `keep_zeroes`:
+
+```python
+>>> duration_string(delta, keep_zeroes=True)
+'0w0d3h20m0s'
+```
+
+Setting `keep_trailing_zeroes`:
+```python
+>>> duration_string(delta, keep_trailing_zeroes=True)
+'3h20m0s'
+```
+
+Setting `keep_leading_zeroes`:
+```python
+>>> duration_string(delta, keep_leading_zeroes=True)
+'0w0d3h20m'
+```
+
+Setting `keep_infix_zeroes`:
+```python
+>>> duration_string(timedelta(hours=3, seconds=11), keep_infix_zeroes=True)
+'3h0m11s'
+```
+
+Return value when `timedelta` is 0:
+```python
+>>> duration_string(timedelta())
+'0s'
+```

nice_duration-0.7.0/src/nice_duration.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+src/__init__.py
+src/nice_duration.py
+src/nice_duration.egg-info/PKG-INFO
+src/nice_duration.egg-info/SOURCES.txt
+src/nice_duration.egg-info/dependency_links.txt
+src/nice_duration.egg-info/top_level.txt

nice_duration-0.7.0/src/nice_duration.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

nice_duration-0.7.0/src/nice_duration.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+__init__
+nice_duration

nice_duration-0.7.0/src/nice_duration.py

@@ -0,0 +1,108 @@
+from datetime import timedelta
+
+amount_of_seconds = {
+    "week": 604800,
+    "day": 86400,
+    "hour": 3600,
+    "minute": 60,
+    "second": 1,
+}
+unit_names = {"week": "w", "day": "d", "hour": "h", "minute": "m", "second": "s"}
+
+
+def duration_string(
+    duration: timedelta | int,
+    separator="",
+    keep_leading_zeroes=False,
+    keep_trailing_zeroes=False,
+    keep_infix_zeroes=False,
+    keep_zeroes=False,
+) -> str:
+    """Convert a timedelta object to a string.
+
+    Examples:
+    duration_string(timedelta(hours=3, minutes=20)) = "3h20m"
+    duration_string(timedelta(hours=3, minutes=20), separator=" ") = "3h 20m"
+    duration_string(timedelta(hours=3, minutes=20), keep_zeroes=True) = "0w0d3h20m0s"
+    """
+
+    if keep_zeroes:
+        keep_leading_zeroes = True
+        keep_infix_zeroes = True
+        keep_trailing_zeroes = True
+
+    if type(duration) is int:
+        remainder = duration
+    else:
+        remainder = int(duration.total_seconds())
+
+    values = {}
+
+    for field in amount_of_seconds.keys():
+        value, remainder = divmod(remainder, amount_of_seconds[field])
+        values[field] = value
+
+    if not keep_leading_zeroes:
+        for field in values.copy():
+            if values[field]:
+                break
+            else:
+                del values[field]
+
+    if not keep_trailing_zeroes:
+        for field in reversed(values.copy()):
+            if values[field]:
+                break
+            else:
+                del values[field]
+
+    if not keep_infix_zeroes and len(values) > 2:
+        # We transform the values dictionary to a list of pairs
+        values_list = [[k, v] for k, v in values.items()]
+
+        # We split off potential leading zeroes
+        leading_zeroes = []
+        for e in values_list:
+            if e[1]:
+                break
+            else:
+                leading_zeroes.append(e)
+
+        # We split off potential trailing zeroes
+        trailing_zeroes = []
+        for e in reversed(values_list):
+            if e[1]:
+                break
+            else:
+                trailing_zeroes.insert(0, e)
+
+        # Check whether there are enough elements left between leading
+        # zeroes and trailing zeroes. If there are less than 3
+        # elements beteen leading and trailing zeroes, we know for
+        # sure there are no in between zeroes.
+        if len(values_list) - len(leading_zeroes) - len(trailing_zeroes) > 2:
+            # Remove leading and trailing zeroes from values_list
+            values_list = values_list[
+                len(leading_zeroes) : len(values_list) - len(trailing_zeroes)
+            ]
+
+            # In this remaining list we can remove all zero values
+            values_list = [e for e in values_list if e[1]]
+
+            # Now zeroes are removed, we re-attach leading and trailing zeroes
+            new_list = leading_zeroes
+            new_list.extend(values_list)
+            new_list.extend(trailing_zeroes)
+
+            # We convert the list of pairs back to a dictionary
+            values = {e[0]: e[1] for e in new_list}
+
+    if not values:
+        values["second"] = 0
+
+    string = ""
+    for field in values:
+        string += separator + str(values[field]) + unit_names[field]
+
+    string = string[len(separator) :]
+    return string