danielutils 0.9.62__tar.gz → 0.9.64__tar.gz

{danielutils-0.9.62 → danielutils-0.9.64}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: danielutils
-Version: 0.9.62
+Version: 0.9.64
 Summary: A python utils library for things I find useful
 Home-page: https://github.com/danielnachumdev/danielutils
 Author: danielnachumdev
@@ -36,6 +36,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.8.17
 Description-Content-Type: text/markdown
+Requires-Dist: tqdm
 
 
 [![Python package](https://github.com/danielnachumdev/danielutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/python-package.yml)
@@ -43,7 +44,7 @@ Description-Content-Type: text/markdown
 [![Python 3.10.11](https://img.shields.io/badge/python-3.10.11-blue.svg)](https://www.python.org/downloads/release/python-31011/)
 [![gitleaks](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml)
 [![CodeQL](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql)
-# danielutils v=0.9.62
+# danielutils v=0.9.64
 A utils library for things that I find useful for my coding workflow.\
 Feel free to use and / or contribute / improve my code :)
 

{danielutils-0.9.62 → danielutils-0.9.64}/README.md

@@ -4,7 +4,7 @@
 [![Python 3.10.11](https://img.shields.io/badge/python-3.10.11-blue.svg)](https://www.python.org/downloads/release/python-31011/)
 [![gitleaks](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml)
 [![CodeQL](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql)
-# danielutils v=0.9.62
+# danielutils v=0.9.64
 A utils library for things that I find useful for my coding workflow.\
 Feel free to use and / or contribute / improve my code :)
 

{danielutils-0.9.62 → danielutils-0.9.64}/danielutils/__init__.py

@@ -3,7 +3,7 @@
 """
 from .functions import *
 from .decorators import *
-from .io import *
+from .files_and_folders import *
 from .system import *
 from .text import *
 from .conversions import *

{danielutils-0.9.62/danielutils/Conversions → danielutils-0.9.64/danielutils/conversions}/specialized_conversions/to_hex.py

@@ -1,4 +1,4 @@
-from ...metaclasses.OverloadMeta import OverloadMeta
+from ...metaclasses.overload_meta import OverloadMeta
 from ..main_conversions import int_to_hex, char_to_hex
 
 

{danielutils-0.9.62/danielutils/Decorators → danielutils-0.9.64/danielutils/decorators}/__init__.py

@@ -5,7 +5,7 @@ from .decorate_conditionally import *
 from .limit_recursion import *
 from .memo import *
 from .overload import *
-from .PartiallyImplemented import *
+from .partially_implemented import *
 from .timeout import *
 from .chain_decorators import *
 from .threadify import *

danielutils-0.9.64/danielutils/files_and_folders.py

@@ -0,0 +1,435 @@
+# -*- coding: utf-8 -*-
+import subprocess
+from typing import IO, Iterator, Generator, Optional, cast, Union, List as t_list
+# import shutil
+from pathlib import Path
+import os
+from .decorators import validate
+from .reflection import get_python_version
+if get_python_version() >= (3, 9):
+    from builtins import list as t_list
+
+@validate
+def path_exists(path: str) -> bool:
+    """checks whether a path exists
+
+    Args:
+        path (str): path to check
+
+    Returns:
+        bool: result of check
+    """
+    return os.path.exists(path)
+
+
+@validate
+def file_exists(path: str) -> bool:
+    """checks whether a file exists at specified path
+
+    Args:
+        path (str): path to check
+
+    Returns:
+        bool: will return true iff the path exists and it is a path to a file
+    """
+    return path_exists(path) and is_file(path)
+
+
+@validate
+def directory_exists(path: str) -> bool:
+    """checks whether a directory exists at specified path
+
+    Args:
+        path (str): path to check
+
+    Returns:
+        bool: will return true iff the path exists and it is a path to a directory
+    """
+    return path_exists(path) and is_directory(path)
+
+
+@validate
+def delete_file(path: str) -> None:
+    """deletes a file if it exists
+
+    Args:
+        path (str): path of file
+    """
+    if file_exists(path):
+        os.remove(path)
+
+
+@validate
+# type:ignore
+def read_file(path: str, read_bytes: bool = False) -> Union[t_list[str], t_list[bytes]]:
+    """read all lines from a file
+
+    Args:
+        path (str): the path to the file
+
+    Returns:
+        list[str]: a list of all the lines in the file
+    """
+    try:
+        if read_bytes:
+            with open(path, "rb") as f:
+                return f.readlines()
+        else:
+            with open(path, "r", encoding="mbcs") as f:
+                return f.readlines()
+    except Exception as e:
+        if isinstance(e, UnicodeDecodeError):
+            raise UnicodeDecodeError(e.encoding, e.object, e.start, e.end,
+                                     "Can't read byte in file.\nTo use with bytes use: read_bytes = True ") from e
+        raise e
+
+
+@validate
+def is_file(path: str) -> bool:
+    """return whether a path represents a file
+
+    Args:
+        path (str): path to check
+    """
+    return os.path.isfile(path)
+
+
+@validate
+def is_directory(path: str) -> bool:
+    """return whether a path represents a directory
+
+    Args:
+        path (str): path to check
+    """
+    return os.path.isdir(path)
+
+
+@validate
+def get_files(path: str) -> t_list[str]:
+    """return a list of names of all files inside specified directory
+
+    Args:
+        path (str): directory
+
+    Returns:
+        list[str]: all files
+    """
+    files_and_directories = get_files_and_directories(path)
+    return list(
+        filter(lambda name: is_file(os.path.join(path, name)), files_and_directories))
+
+
+@validate
+def get_files_and_directories(path: str) -> t_list[str]:
+    """get a list of all files and directories in specified path
+
+    Args:
+        path (str): path to check
+
+    Returns:
+        list[str]: all files and directories
+    """
+    return os.listdir(path)
+
+
+@validate
+def get_directories(path: str) -> t_list[str]:
+    """get all directories in specified path
+
+    Args:
+        path (str): path to check
+
+    Returns:
+        list[str]: all directories
+    """
+    files_and_directories = get_files_and_directories(path)
+    return list(
+        filter(lambda name: is_directory(os.path.join(path, name)), files_and_directories))
+
+
+@ validate
+def delete_directory(path: str) -> None:
+    """delete a directory and all its contents
+
+    Args:
+        path (str): _description_
+    """
+    if is_directory(path):
+        clear_directory(path)
+        os.rmdir(path)
+
+
+@validate
+def clear_directory(path: str) -> None:
+    """clears the content of a directory
+
+    Args:
+        path (str): the path of the directory to clean
+    """
+    for file in get_files(path):
+        delete_file(os.path.join(path, file))
+    for subdir in get_directories(path):
+        delete_directory(os.path.join(path, subdir))
+
+
+@validate
+def create_directory(path: str) -> None:
+    """create a directory at the specified path if it doesn't already exists
+
+    Args:
+        path (str): the path to create a directory at
+    """
+    if not directory_exists(path):
+        os.makedirs(path)
+
+
+@validate
+def create_file(path: str) -> None:
+    if not file_exists(path):
+        with open(path, "w", encoding='utf8') as f:
+            pass
+
+
+@validate
+def get_file_type_from_directory(path: str, file_type: str) -> Iterator[str]:
+    """returns all file with specific type from a directory
+
+    Args:
+        path (str): path of directory
+        file_type (str): the desired file type. eg: ".png"
+
+    Returns:
+        list[str]: result
+    """
+    return filter(
+        lambda name: Path(os.path.join(path, name)).suffix == file_type,
+        get_files(path)
+    )
+
+
+@validate
+def get_file_type_from_directory_recursively(path: str, file_type: str) -> Generator[str, None, None]:
+    """_summary_
+
+    Args:
+        path (str): _description_
+        file_type (str): _description_
+
+    Returns:
+        _type_: _description_
+    """
+    yield from filter(
+        lambda name: Path(os.path.join(path, name)).suffix == file_type,
+        get_files(path)
+    )
+    for subdir in get_directories(path):
+        for v in get_file_type_from_directory_recursively(os.path.join(path, subdir), file_type):
+            yield os.path.join(subdir, v)
+
+
+@validate
+def rename_file(path: str, new_name: str) -> None:
+    """renames a file
+
+    Args:
+        path (str): file to rename
+        new_name (str): the desired new name
+    """
+    new_path = "./" + \
+        "/".join(Path(path).parts[:-1])+"/"+new_name+Path(path).suffix
+    move_file(path, new_path)
+
+
+@validate
+def move_file(old_path: str, new_path: str) -> None:
+    """moves a file
+
+    Args:
+        old_path (str): old path
+        new_path (str): new path
+    """
+    os.rename(old_path, new_path)
+
+
+@validate
+async def open_file(file_path: str, application_path: str) -> int:
+    """open a file with the specified application
+
+    Args:
+        file_path (str): the file to open
+        application_path (str): the application to open with
+    Returns:
+        int: return code
+    """
+    with subprocess.Popen([application_path, file_path]) as p:
+        return p.wait()
+
+
+# @validate
+# def move_directory(old_path: str, new_path: str) -> None:
+#     """moves a directory
+#
+#     Args:
+#         old_path (str): old path
+#         new_path (str): new path
+#     """
+#     shutil.move(old_path, new_path)
+#
+#
+# @validate
+# def copy_file(src: str, dest: str) -> None:
+#     """copies file from src to dest
+#
+#     Args:
+#         src (str): src
+#         dest (str): dest
+#     """
+#     shutil.copy(src, dest)
+#
+#
+# @validate
+# def copy_directory(src: str, dest: str) -> None:
+#     """copies a directory from src to dest
+#
+#     Args:
+#         src (str): stc
+#         dest (str): dest
+#     """
+#     shutil.copy(src, dest)
+#
+
+class IndentedWriter:
+    """every class that will inherit this class will have the following functions available
+        write() with the same arguments a builtin print()
+        indent()
+        undent()
+
+        also, it is expected in the __init__ function to call super().__init__()
+        also, the output_stream must be set whether by the first argument io super().__init__(...)
+        or by set_stream() explicitly somewhere else.
+
+        this class will not function properly is the output_stream is not set!
+
+    """
+
+    def __init__(self, output_stream: Optional[IO] = None, indent_value: str = "\t"):
+        self.indent_level = 0
+        self.output_stream: Optional[IO] = output_stream
+        self.indent_value = indent_value
+
+    def write(self, *args, sep=" ", end="\n") -> None:
+        """writes the supplied arguments to the output_stream
+
+        Args:
+            sep (str, optional): the str to use as a separator between arguments. Defaults to " ".
+            end (str, optional): the str to use as the final value. Defaults to "\n".
+
+        Raises:
+            ValueError: _description_
+        """
+        if self.output_stream is None:
+            raise ValueError(
+                "Can't write to an empty stream. the stream must not be None:"
+                " either by set_stream or by initialization")
+        self.output_stream.write(
+            str(self.indent_level*self.indent_value + sep.join(args)+end))
+
+    def set_stream(self, stream: IO) -> None:
+        """explicitly sets the stream
+
+        Args:
+            stream (IO): stream
+        """
+        self.output_stream = stream
+        self.output_stream = cast(IO, self.output_stream)
+
+    def indent(self) -> None:
+        """indents the preceding output with write() by one quantity more
+        """
+        self.indent_level += 1
+
+    def undent(self) -> None:
+        """un-dents the preceding output with write() by one quantity less
+            has a minimum value of 0
+        """
+        self.indent_level = max(0, self.indent_level-1)
+
+
+class IndentedWriter2:
+    """every class that will inherit this class will have the following functions available
+        write() with the same arguments a builtin print()
+        indent()
+        undent()
+
+        also, it is expected in the __init__ function to call super().__init__()
+        also, the output_stream must be set whether by the first argument io super().__init__(...)
+        or by set_stream() explicitly somewhere else.
+
+        this class will not function properly is the output_stream is not set!
+
+    """
+
+    def __init__(self, indent_value: str = "\t"):
+        self.indent_level = 0
+        self.indent_value = indent_value
+        self.buffer: str = ""
+
+    def to_stream(self, stream: IO[str]) -> None:
+        """outputs the buffer to a stream
+
+        Args:
+            stream (IO[str]): the stream to output to
+        """
+        stream.write(self.buffer)
+
+    def write(self, *args, sep=" ", end="\n") -> None:
+        """writes the supplied arguments to the output_stream
+
+        Args:
+            sep (str, optional): the str to use as a separator between arguments. Defaults to " ".
+            end (str, optional): the str to use as the final value. Defaults to "\n".
+
+        Raises:
+            ValueError: _description_
+        """
+        self.buffer += str(self.indent_level *
+                           self.indent_value + sep.join(args)+end)
+
+    def indent(self) -> None:
+        """indents the preceding output with write() by one quantity more
+        """
+        self.indent_level += 1
+
+    def undent(self) -> None:
+        """un-dents the preceding output with write() by one quantity less
+            has a minimum value of 0
+        """
+        self.indent_level = max(0, self.indent_level-1)
+
+
+__all__ = [
+    "path_exists",
+    "file_exists",
+    "directory_exists",
+    "delete_file",
+    "read_file",
+    "is_file",
+    "is_directory",
+    "get_files",
+    "get_files_and_directories",
+    "get_directories",
+    "delete_directory",
+    "clear_directory",
+    "create_directory",
+    'create_file',
+    "get_file_type_from_directory",
+    "get_file_type_from_directory_recursively",
+    "rename_file",
+    "move_file",
+    "open_file",
+    # "move_directory",
+    # "copy_file",
+    # "copy_directory",
+    "IndentedWriter",
+    "IndentedWriter2"
+]

danielutils-0.9.64/danielutils/metaclasses/__init__.py

@@ -0,0 +1,5 @@
+from .interface import *
+from .atomic_class_meta import *
+from .implicit_data_deleter_meta import *
+from .instance_cache_meta import *
+from .overload_meta import *

{danielutils-0.9.62/danielutils/Reflection → danielutils-0.9.64/danielutils/reflection}/__init__.py

@@ -1,9 +1,9 @@
-from .System import *  # this has to be first, the order matters!
-from .File import *
-from .Function import *
+from .system_reflections import *  # this has to be first, the order matters!
+from .file_reflection import *
+from .function_reflections import *
 from .get_traceback import *
-from .Module import *
-from .Class import *
+from .module_reflections import *
+from .class_reflection import *
 from .get_prev_frame import *
 # def get_class(module_name: str, class_name: str) -> type:
 #     """dynammically loads the module and returns the class from this file

{danielutils-0.9.62 → danielutils-0.9.64}/danielutils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: danielutils
-Version: 0.9.62
+Version: 0.9.64
 Summary: A python utils library for things I find useful
 Home-page: https://github.com/danielnachumdev/danielutils
 Author: danielnachumdev
@@ -36,6 +36,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.8.17
 Description-Content-Type: text/markdown
+Requires-Dist: tqdm
 
 
 [![Python package](https://github.com/danielnachumdev/danielutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/python-package.yml)
@@ -43,7 +44,7 @@ Description-Content-Type: text/markdown
 [![Python 3.10.11](https://img.shields.io/badge/python-3.10.11-blue.svg)](https://www.python.org/downloads/release/python-31011/)
 [![gitleaks](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml)
 [![CodeQL](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql)
-# danielutils v=0.9.62
+# danielutils v=0.9.64
 A utils library for things that I find useful for my coding workflow.\
 Feel free to use and / or contribute / improve my code :)
 

{danielutils-0.9.62 → danielutils-0.9.64}/danielutils.egg-info/SOURCES.txt

@@ -2,23 +2,13 @@ LISENCE
 README.md
 pyproject.toml
 setup.py
-danielutils/Aliases.py
-danielutils/Colors.py
-danielutils/Exceptions.py
-danielutils/IO.py
-danielutils/Internet.py
-danielutils/Path.py
-danielutils/Print.py
-danielutils/Relations.py
-danielutils/Signals.py
-danielutils/Text.py
-danielutils/Time.py
 danielutils/__init__.py
 danielutils/aliases.py
 danielutils/colors.py
 danielutils/date.py
 danielutils/date_time.py
 danielutils/exceptions.py
+danielutils/files_and_folders.py
 danielutils/internet.py
 danielutils/io.py
 danielutils/loops.py
@@ -35,59 +25,8 @@ danielutils.egg-info/SOURCES.txt
 danielutils.egg-info/dependency_links.txt
 danielutils.egg-info/requires.txt
 danielutils.egg-info/top_level.txt
-danielutils/Classes/Convenience.py
-danielutils/Classes/Counter.py
-danielutils/Classes/Tree.py
-danielutils/Classes/__init__.py
-danielutils/Classes/frange.py
-danielutils/Conversions/__init__.py
-danielutils/Decorators/PartiallyImplemented.py
-danielutils/Decorators/__init__.py
-danielutils/Decorators/atomic.py
-danielutils/Decorators/attach.py
-danielutils/Decorators/chain_decorators.py
-danielutils/Decorators/decorate_conditionally.py
-danielutils/Decorators/delay_call.py
-danielutils/Decorators/deprecate.py
-danielutils/Decorators/limit_recursion.py
-danielutils/Decorators/memo.py
-danielutils/Decorators/overload.py
-danielutils/Decorators/property.py
-danielutils/Decorators/threadify.py
-danielutils/Decorators/timeout.py
-danielutils/Decorators/validate.py
-danielutils/Functions/__init__.py
-danielutils/Functions/areoneof.py
-danielutils/Functions/check_foreach.py
-danielutils/Functions/isoftype.py
-danielutils/Functions/isoneof.py
-danielutils/Functions/powerset.py
-danielutils/Functions/types_subseteq.py
-danielutils/Generators/__init__.py
-danielutils/Generators/conditional_generator.py
-danielutils/Generators/generator_from_stream.py
-danielutils/Generators/join_generators.py
-danielutils/Math/Constants.py
-danielutils/Math/Functions.py
-danielutils/Math/__init__.py
-danielutils/MetaClasses/AtomicClassMeta.py
-danielutils/MetaClasses/ImplicitDataDeleterMeta.py
-danielutils/MetaClasses/InstanceCacheMeta.py
-danielutils/MetaClasses/Interface.py
-danielutils/MetaClasses/OverloadMeta.py
-danielutils/MetaClasses/__init__.py
-danielutils/Reflection/File.py
-danielutils/Reflection/Function.py
-danielutils/Reflection/Module.py
-danielutils/Reflection/System.py
-danielutils/Reflection/__init__.py
-danielutils/Reflection/get_prev_frame.py
-danielutils/Reflection/get_traceback.py
-danielutils/Snippets/__init__.py
-danielutils/Snippets/try_get.py
-danielutils/University/__init__.py
-danielutils/University/Databases/__init__.py
-danielutils/University/Databases/all.py
+danielutils/classes/Convenience.py
+danielutils/classes/Counter.py
 danielutils/classes/Tree.py
 danielutils/classes/__init__.py
 danielutils/classes/convenience.py
@@ -107,6 +46,12 @@ danielutils/conversions/main_conversions.py
 danielutils/conversions/specialized_conversions/__init__.py
 danielutils/conversions/specialized_conversions/to_hex.py
 danielutils/conversions/specialized_conversions/to_int.py
+danielutils/data_structures/Comparer.py
+danielutils/data_structures/Graph.py
+danielutils/data_structures/Heap.py
+danielutils/data_structures/Node.py
+danielutils/data_structures/Queue.py
+danielutils/data_structures/Stack.py
 danielutils/data_structures/__init__.py
 danielutils/data_structures/comparer.py
 danielutils/data_structures/default_dict.py
@@ -116,7 +61,6 @@ danielutils/data_structures/heap.py
 danielutils/data_structures/node.py
 danielutils/data_structures/queue.py
 danielutils/data_structures/stack.py
-danielutils/decorators/PartiallyImplemented.py
 danielutils/decorators/__init__.py
 danielutils/decorators/atomic.py
 danielutils/decorators/attach.py
@@ -127,6 +71,7 @@ danielutils/decorators/deprecate.py
 danielutils/decorators/limit_recursion.py
 danielutils/decorators/memo.py
 danielutils/decorators/overload.py
+danielutils/decorators/partially_implemented.py
 danielutils/decorators/processify.py
 danielutils/decorators/property.py
 danielutils/decorators/threadify.py
@@ -148,20 +93,21 @@ danielutils/math/constants.py
 danielutils/math/functions.py
 danielutils/math/math_print.py
 danielutils/math/math_symbols.py
-danielutils/metaclasses/AtomicClassMeta.py
-danielutils/metaclasses/ImplicitDataDeleterMeta.py
-danielutils/metaclasses/InstanceCacheMeta.py
 danielutils/metaclasses/Interface.py
-danielutils/metaclasses/OverloadMeta.py
 danielutils/metaclasses/__init__.py
-danielutils/reflection/Class.py
-danielutils/reflection/File.py
-danielutils/reflection/Function.py
-danielutils/reflection/Module.py
-danielutils/reflection/System.py
+danielutils/metaclasses/atomic_class_meta.py
+danielutils/metaclasses/implicit_data_deleter_meta.py
+danielutils/metaclasses/instance_cache_meta.py
+danielutils/metaclasses/interface.py
+danielutils/metaclasses/overload_meta.py
 danielutils/reflection/__init__.py
+danielutils/reflection/class_reflection.py
+danielutils/reflection/file_reflection.py
+danielutils/reflection/function_reflections.py
 danielutils/reflection/get_prev_frame.py
 danielutils/reflection/get_traceback.py
+danielutils/reflection/module_reflections.py
+danielutils/reflection/system_reflections.py
 danielutils/snippets/__init__.py
 danielutils/snippets/try_get.py
 danielutils/system/__init__.py

{danielutils-0.9.62 → danielutils-0.9.64}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "danielutils"
-version = "0.9.62"
+version = "0.9.64"
 authors = [
     { name = "danielnachumdev", email = "danielnachumdev@gmail.com" },
 ]

{danielutils-0.9.62 → danielutils-0.9.64}/setup.py

@@ -9,7 +9,7 @@ def read_file(path: str) -> "list[str]":
 
 README_PATH = 'README.md'
 DESCRIPTION = 'A python utils library for things I find useful'
-VERSION = "0.9.62"
+VERSION = "0.9.64"
 LONG_DESCRIPTION = '\n'.join(read_file(README_PATH))
 setup(
     name="danielutils",

danielutils-0.9.62/danielutils/MetaClasses/__init__.py

@@ -1,5 +0,0 @@
-from .Interface import *
-from .AtomicClassMeta import *
-from .ImplicitDataDeleterMeta import *
-from .InstanceCacheMeta import *
-from .OverloadMeta import *