stdl 0.5.2__tar.gz → 0.5.4__tar.gz

{stdl-0.5.2/stdl.egg-info → stdl-0.5.4}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: stdl
-Version: 0.5.2
+Version: 0.5.4
 Summary: Extended Python Standard Library
 Author-email: Žiga Ivanšek <ziga.ivansek@gmail.com>
 Project-URL: Repository, https://github.com/zigai/stdl
+Project-URL: Documentation, https://stdl.readthedocs.io
 Keywords: python utilites,filesystem,string manipulation,logging configuration,list utils,standard library,ANSI colors,terminal output
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License

{stdl-0.5.2 → stdl-0.5.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "stdl"
-version = "0.5.2"
+version = "0.5.4"
 description = "Extended Python Standard Library"
 authors = [{ name = "Žiga Ivanšek", email = "ziga.ivansek@gmail.com" }]
 license = { file = "LICENSE.txt" }
@@ -52,6 +52,7 @@ dev = [
 
 [project.urls]
 Repository = "https://github.com/zigai/stdl"
+Documentation = "https://stdl.readthedocs.io"
 
 [tool.black]
 line-length = 100

stdl-0.5.4/stdl/__init__.py

@@ -0,0 +1 @@
+from stdl import decorators, dt, fs, log, lst, net, st

{stdl-0.5.2 → stdl-0.5.4}/stdl/dt.py

@@ -45,7 +45,7 @@ class Timer:
         Returns:
             TimerStop: The stop data
         """
-        t = time.time()
+        t = time.perf_counter()
         elapsed_total = t - self.start
         since_last = t - self.stops[-1].at if self.stops else 0
         if not self.ms:
@@ -78,7 +78,7 @@ class Timer:
 
     def reset(self) -> None:
         """Reset the timer."""
-        self.start = time.time()
+        self.start = time.perf_counter()
         self.stops: list[TimerStop] = [
             TimerStop(
                 total=timedelta(seconds=0),
@@ -114,17 +114,18 @@ def datetime_fmt(
     Returns:
         str: Formated date and time.
 
-    Examples:
-    --------
-    >>> fmt_datetime()
-    '2022-11-22 22:40:04' # current date and time
-    >>> fmt_datetime(0)
-    "1970-01-01 00:00:00"
-    >>> fmt_datetime(0, fmt="dmY", dsep="/")
-    "01/01/1970 00:00:00"
+    Example:
+        ```python
+        >>> fmt_datetime()
+        '2022-11-22 22:40:04' # current date and time
+        >>> fmt_datetime(0)
+        "1970-01-01 00:00:00"
+        >>> fmt_datetime(0, fmt="dmY", dsep="/")
+        "01/01/1970 00:00:00"
+        ```
     """
     if d is None:
-        d = datetime.fromtimestamp(time.time(), **{"tz": timezone.utc} if utc else {})
+        d = datetime.fromtimestamp(time.perf_counter(), **{"tz": timezone.utc} if utc else {})
 
     elif isinstance(d, str):
         d = parse_datetime_str(d)
@@ -161,7 +162,7 @@ def time_fmt(
         str: Formated time.
     """
     if t is None:
-        tm = datetime.fromtimestamp(time.time(), **{"tz": timezone.utc} if utc else {})
+        tm = datetime.fromtimestamp(time.perf_counter(), **{"tz": timezone.utc} if utc else {})
     elif isinstance(t, datetime):
         tm = t.time()
     elif isinstance(t, (int, float)):
@@ -194,19 +195,20 @@ def date_fmt(
     Returns:
         str: Formated date.
 
-    Examples
-    --------
-    >>> fmt_date(date(2022,11,22))
-    '2022-11-22'
-    >>> fmt_date(date(2022,11,22), sep="/")
-    '2022/11/22'
-    >>> fmt_date(date(2022,11,22), sep="/", fmt="dmY")
-    '22/11/2022'
-    >>> fmt_date()
-    '2022-11-22'
+    Example:
+        ```python
+        >>> fmt_date(date(2022,11,22))
+        '2022-11-22'
+        >>> fmt_date(date(2022,11,22), sep="/")
+        '2022/11/22'
+        >>> fmt_date(date(2022,11,22), sep="/", fmt="dmY")
+        '22/11/2022'
+        >>> fmt_date()
+        '2022-11-22'
+        ```
     """
     if d is None:
-        d = date.fromtimestamp(time.time())
+        d = date.fromtimestamp(time.perf_counter())
     elif isinstance(d, (float, int)):
         d = date.fromtimestamp(d)
     elif isinstance(d, datetime):
@@ -222,12 +224,13 @@ def date_range(start: date, end: date) -> T.Generator[date, None, None]:
     """
     Returns a generator for dates between ``start`` and ``end``
 
-    Examples
-    --------
-    >>> for i in date_range(date(2022,11,19), date(2022,11,22)): print(i)
-    2022-11-19
-    2022-11-20
-    2022-11-21
+    Example:
+        ```python
+        >>> for i in date_range(date(2022,11,19), date(2022,11,22)): print(i)
+        2022-11-19
+        2022-11-20
+        2022-11-21
+        ```
     """
     for n in range(int((end - start).days)):
         yield start + timedelta(n)

{stdl-0.5.2 → stdl-0.5.4}/stdl/fs.py

@@ -102,7 +102,7 @@ class File(PathLike):
         Args:
             path (os.PathLike): File path.
             encoding (str, optional): The file's encoding.
-            abs (bool, keyword-only): Whether to use the absolute path.
+            abs (bool): Whether to use the absolute path.
         """
         self.encoding = encoding
         self.path: str = os.fspath(path)
@@ -698,7 +698,9 @@ def is_wsl() -> bool:
 
 
 def mkdir(path: str | Path, mode: int = 511, exist_ok: bool = True) -> None:
-    """Creates a directory.
+    """
+    Creates a directory.
+
     Args:
         path (str | Path): The path of the directory to create.
         exist_ok (bool, optional): Whether to raise an exception if the directory already exists. Defaults to True.
@@ -707,7 +709,9 @@ def mkdir(path: str | Path, mode: int = 511, exist_ok: bool = True) -> None:
 
 
 def mkdirs(dest: str | Path, names: list[str]) -> None:
-    """Creates directories inside a destination directory.
+    """
+    Creates directories inside a destination directory.
+
     Args:
         dest (str | Path): The destination directory.
         names (list[str]): A list of directory names to be created in the destination directory.
@@ -863,7 +867,30 @@ def ensure_paths_exist(*args: str | PathLike | Iterable[str | PathLike]) -> None
 
     def check_path(path: str | PathLike):
         if not os.path.exists(os.fspath(path)):
-            raise FileNotFoundError(f"Path does not exist: {path}")
+            raise FileNotFoundError(f"Path does not exist: '{path}'")
+
+    for path in args:
+        if isinstance(path, (str, bytes, PathLike)):
+            check_path(path)
+        elif isinstance(path, Iterable):
+            for i in path:
+                check_path(i)
+
+
+def ensure_paths_dont_exist(*args: str | PathLike | Iterable[str | PathLike]) -> None:
+    """
+    Ensures that the specified paths don't exist.
+
+    Args:
+        *args : one or more strings representing the paths to check. Can also include an Iterable of paths.
+
+    Raises:
+        FileNotFoundError : if one of the provided paths exists.
+    """
+
+    def check_path(path: str | PathLike):
+        if os.path.exists(os.fspath(path)):
+            raise FileExistsError(f"Path already exists: '{path}'")
 
     for path in args:
         if isinstance(path, (str, bytes, PathLike)):
@@ -994,22 +1021,16 @@ def exec_cmd(
     )
 
 
-def read_stdin(timeout: float = 0.0) -> list[str]:
+def read_piped() -> str:
     """
-    Reads lines from stdin.
-
-    Args:
-        timeout (float, optional): The time to wait for input. Defaults to 0.
-
-    Returns:
-        list[str]: The lines read from stdin.
+    Reads piped input from stdin.
     """
-    if select([sys.stdin], [], [], timeout)[0]:
-        return sys.stdin.read().strip().splitlines()
-    return []
+    if sys.stdin.isatty():
+        return ""
+    return sys.stdin.read().strip()
 
 
-def startfile(path: str | PathLike) -> None:
+def start_file(path: str | PathLike) -> None:
     """
     Open the file with your OS's default application.
 
@@ -1063,8 +1084,8 @@ __all__ = [
     "dirname",
     "joinpath",
     "splitpath",
-    "read_stdin",
-    "startfile",
+    "start_file",
+    "read_piped",
     "isdir",
     "isfile",
     "islink",

{stdl-0.5.2 → stdl-0.5.4}/stdl/log.py

@@ -22,13 +22,13 @@ class LoguruFormatter:
 
     def format(self, record: dict) -> str:
         """
-        Example usage:
-        ```python
-        >>> import sys
-        >>> from loguru import logger
-        >>> logger.remove()
-        >>> logger.add(sys.stdout, level="DEBUG", format=loguru_formater)
-        ```
+        Example:
+            ```python
+            >>> import sys
+            >>> from loguru import logger
+            >>> logger.remove()
+            >>> logger.add(sys.stdout, level="DEBUG", format=loguru_formater)
+            ```
         """
         extras = ""
         if len(record["extra"]):

{stdl-0.5.2 → stdl-0.5.4}/stdl/lst.py

@@ -92,7 +92,7 @@ def occurrences(l: list[T.Any], val: T.Any) -> int:
     Returns:
         int: Number of occurrences
     """
-    return len([i for i in l if i == val and type(i) == type(val)])
+    return len([i for i in l if i == val and type(i) is type(val)])
 
 
 __all__ = [

{stdl-0.5.2 → stdl-0.5.4}/stdl/st.py

@@ -203,8 +203,10 @@ def terminal_link(
     Returns a hyperlink that can be used in terminals.
 
     NOTE:
-        Hyperlinks are not supported in all terminals. For more information visit
-        <https://github.com/Alhadis/OSC8-Adoption/> and
+        Hyperlinks are not supported in all terminals.
+        For more information visit
+        <https://github.com/Alhadis/OSC8-Adoption/>
+        and
         <https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>
 
     Args:
@@ -234,7 +236,7 @@ def remove(s: str, chars: str | set, replace_with: str = "") -> str:
 
     Args:
         s (str): Input string.
-        chrs (str | set): Characters to remove
+        chars (str | set): Characters to remove
         replace_with (str, optional): If provided, replace the characters with this value.
 
     """
@@ -255,7 +257,7 @@ def keep(s: str, chars: str | set, replace_with: str = "") -> str:
 
     Args:
         s (str): Input string
-        chrs (str | set): Characters to keep
+        chars (str | set): Characters to keep
         replace_with (str, optional): If provided, replace other characters with this value.
 
     """
@@ -381,6 +383,14 @@ def ansi_rjust(s: str, width: int, fillchar: str = " ") -> str:
     return s.rjust(new_width, fillchar)
 
 
+def ansi_strip(r: str) -> str:
+    """
+    Remove ANSI escape codes from a string.
+    """
+    ansi_escape = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
+    return ansi_escape.sub("", r)
+
+
 if __name__ == "__main__":
     FG.print_all()
     BG.print_all()

{stdl-0.5.2 → stdl-0.5.4/stdl.egg-info}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: stdl
-Version: 0.5.2
+Version: 0.5.4
 Summary: Extended Python Standard Library
 Author-email: Žiga Ivanšek <ziga.ivansek@gmail.com>
 Project-URL: Repository, https://github.com/zigai/stdl
+Project-URL: Documentation, https://stdl.readthedocs.io
 Keywords: python utilites,filesystem,string manipulation,logging configuration,list utils,standard library,ANSI colors,terminal output
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License

stdl-0.5.2/stdl/__init__.py

@@ -1 +0,0 @@
-from stdl import dt, fs, log, lst, net, st