corelp 1.0.37__py3-none-any.whl → 1.0.39__py3-none-any.whl

corelp/modules/print_LP/print.py

@@ -1,326 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Date          : 2025-08-27
-# Author        : Lancelot PINCET
-# GitHub        : https://github.com/LancelotPincet
-# Library       : coreLP
-# Module        : print
-
-"""
-This function overrides python built in print function to add functionnalities.
-"""
-
-
-
-# %% Libraries
-
-
-
-# %% Libraries
-from corelp import prop
-from dataclasses import dataclass, field
-from datetime import datetime, timedelta
-from numpy._core.numeric import True_
-from rich import print as richprint
-from rich.console import Console
-from rich.theme import Theme
-from rich.markdown import Markdown
-from rich.traceback import Traceback
-from rich.progress import (
-    Progress,
-    BarColumn,
-    TextColumn,
-    TaskProgressColumn,
-    TimeElapsedColumn,
-    TimeRemainingColumn,
-    ProgressColumn,
-)
-import traceback as tb_module
-from time import perf_counter
-from pathlib import Path
-pyprint = print
-
-
-
-# %% Class
-@dataclass(slots=True, kw_only=True)
-class Print() :
-    r"""
-    Enhanced replacement for the built-in :func:`print` function, adding muting,
-    logging, rich formatting, and progress utilities.
-
-    This class is callable and behaves like :func:`print`, with extra arguments.
-
-    Parameters
-    ----------
-    *strings : tuple
-        The objects to print. Its :meth:`__str__` representation is used.
-    verbose : bool, optional
-        If ``True`` (default), printing is performed.  
-        If ``False``, printing is skipped unless overridden.
-    return_string : bool, optional
-        If ``True``, return the processed string instead of ``None``.
-    file : str or pathlib.Path or None, optional
-        If provided, overrides the configured log file.
-    mode : {"w", "a"}, optional
-        File mode used when writing logs. Default is ``"a"``.
-    end : str, optional
-        End-of-line character(s). Defaults to ``"\n"``.
-    **kwargs :
-        Additional keyword arguments passed to :func:`print` or Rich's :func:`Console.print`.
-
-    Examples
-    --------
-    Basic usage::
-
-        >>> from corelp import print
-        >>> s = "Hello *world*!\nThis is a print **example**"
-        >>> print(s)
-
-    Muting::
-
-        >>> print.verbose = False
-        >>> print(s)                 # muted
-        >>> print(s, verbose=True)   # forced printing
-        >>> print.verbose = True
-        >>> print(s)                 # prints again
-        >>> print(s, verbose=False)  # forced mute
-
-    Access to underlying print functions::
-
-        >>> print.pyprint(s)   # built-in print
-        >>> print.richprint(s) # rich.print
-        >>> print.print(s)     # Console.print
-        >>> print.log(s)       # Console.log
-
-    Logging::
-
-        >>> print.file = "log.txt"
-        >>> print("Hello")     # also writes to file
-
-    Console styling::
-
-        >>> print.theme = {"success": "green"}
-        >>> print("Done!", style="success")
-        >>> try:
-        ...     1/0
-        ... except Exception:
-        ...     print.error()
-        >>> print.export_html("log.html")
-
-    Progress / Clock::
-
-        >>> from time import sleep
-        >>> for i in print.clock(15, "Outer"):
-        ...     for j in print.clock(10, "Inner"):
-        ...         sleep(1)
-
-    Attributes
-    ----------
-    verbose : bool
-        Global muting switch.
-    pyprint : callable
-        Built-in Python :func:`print`.
-    richprint : callable
-        :mod:`rich` print function.
-    console : rich.console.Console
-        The Rich console instance used for styled printing.
-    file : pathlib.Path or None
-        Path to the log file.
-    progress : rich.progress.Progress
-        Active Rich progress manager.
-    bars : dict
-        Dictionary storing active progress bars.
-    theme : dict
-        Custom Rich style definitions.
-    """
-
-    # Main function
-    def __call__(self, *strings, verbose=None, do_stdout=True, do_file=True, return_string=False, file=None, mode='a', end='\n', **kwargs) :
-
-        # Muting
-        verbose = verbose if verbose is not None else self.verbose
-        if not verbose :
-            return None
-        
-        # Formatting string
-        string = ", ".join([str(string) for string in strings]) + end
-
-        # Printing markdown
-        if do_stdout :
-            string2print = Markdown(string) if self.apply_markdown else string
-            self.print(string2print, **kwargs)
-
-        # Writting to file
-        if do_file :
-            file = file if file is not None else self.file
-            if file is not None :
-                with open(Path(file), mode) as file :
-                    file.write(string)
-
-        # Return
-        if return_string :
-            return string
-
-
-    # MUTING
-    verbose : bool = True # True to print
-
-
-
-    # PRINT
-
-    @property
-    def print(self) :
-        return self.console.print
-    @property
-    def log(self) :
-        return self.console.log
-    pyprint = pyprint # python print
-    richprint = richprint # rich prints
-    apply_markdown : bool = field(default=True, repr=False) # True to apply rich markdown formatting in prints
-
-
-
-    # LOGGING
-
-    _file : Path = None
-    @property
-    def file(self) :
-        return self._file
-    @file.setter
-    def file(self, value) :
-        self._file = Path(value)
-
-
-
-    # CONSOLE
-
-    _theme = {}
-    @property
-    def theme(self) :
-        return self._theme
-    @theme.setter
-    def theme(self, value) :
-        self._theme.update(value)
-        self._console = None
-
-    _console : Console = field(default=None, repr=False)
-    @prop(cache=True)
-    def console(self) :
-        theme = Theme(self.theme)
-        return Console(theme=theme, record=True)
-
-    def error(self) :
-        rich_tb = Traceback.from_exception(*tb_module.sys.exc_info())
-        self.console.print(rich_tb)
-    
-    def print_locals(self) :
-        self.console.log(log_locals=True)
-    
-    def export_html(self, path) :
-        if path is None :
-            return
-        path = Path(path)
-        html_content = self.console.export_html(inline_styles=True)
-        with open(path, "w", encoding="utf-8") as file:
-            file.write(html_content)
-    
-
-
-    # CLOCK
-
-    def clock(self, iterable, title="Working...") :
-
-        # Get iterable
-        iterable = range(iterable) if isinstance(iterable, int) else iterable
-        iterable = list(iterable)
-
-        # Detect if progressbar already exists
-        first_bar = getattr(self, "_progress", None) is None
-        progress = self.progress
-        bars = self.bars
-        
-        # Opens progress
-        if first_bar :
-            verbose = self.verbose
-            self.verbose = False
-
-            # Write to file
-            if self.file is not None :
-                with open(Path(self.file), "a") as file :
-                    file.write(f'{title}...\n')
-            progress.start()
-        
-        # Create new task
-        task = bars.get(title, None)
-        if task is None : # No bar with this name exists
-            task = progress.add_task(title, total=len(iterable), avg_time=0.0)
-            bars[title] = task # store it
-        else :
-            progress.reset(task)
-        
-        # Loop
-        loop_counter = 0
-        start = perf_counter()
-        for item in iterable :
-            yield item
-            loop_counter += 1
-            elapsed = perf_counter() - start
-            avg_time = elapsed / loop_counter if loop_counter else 0
-            progress.update(task, advance=1, avg_time=avg_time)
-        
-        # Clean up
-        if first_bar :
-            progress.stop()
-            del(self.bars)
-            del(self.progress)
-            self.verbose = verbose
-
-    _progress : Progress = field(default=None, repr=False)
-    @prop(cache=True)
-    def progress(self) :
-        return Progress(
-        TextColumn("{task.description}"),
-        BarColumn(),
-        TaskProgressColumn(),
-        TextColumn("[magenta]/{task.total}[/]"),
-        TimeElapsedColumn(),
-        AvgLoopTimeColumn(),
-        TimeRemainingColumn(),
-        EndTimeColumn(),
-        transient=False,
-        console=self.console
-        )
-    
-    _bars : dict = field(default=None, repr=False)
-    @prop(cache=True)
-    def bars(self) :
-        return {}
-
-
-
-# Get instance
-print = Print() # Instance to use everywhere
-
-# Custom Progress bar columns
-class AvgLoopTimeColumn(ProgressColumn):
-    def render(self, task):
-        avg_time = task.fields.get("avg_time", None)
-        if avg_time is not None and task.completed > 0:
-            string = f"[yellow]↻ {avg_time:.2f}s[/]" if avg_time > 1 else f"[yellow]↻ {avg_time*1000:.2f}ms[/]"
-            return string
-        return ""
-class EndTimeColumn(ProgressColumn):
-    def render(self, task):
-        if task.time_remaining is not None:
-            end_time = datetime.now() + timedelta(seconds=task.time_remaining)
-            return f"[cyan]{end_time:%m-%d %H:%M:%S}[/] "
-        return ""
-
-
-
-# %% Test function run
-if __name__ == "__main__":
-    from corelp import test
-    test(__file__)

corelp/modules/print_LP/test_print.py

@@ -1,108 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Date          : 2025-08-27
-# Author        : Lancelot PINCET
-# GitHub        : https://github.com/LancelotPincet
-# Library       : coreLP
-# Module        : print
-
-"""
-This file allows to test print
-
-print : This function overrides python built in print function to add functionnalities.
-"""
-
-
-
-# %% Libraries
-from corelp import print, debug
-import pytest
-from time import sleep
-debug_folder = debug(__file__)
-
-
-# %% test prints
-def test_print() :
-    '''
-    Test print
-    '''
-    string = "# TEST\nHello *world*!\n\nThis is 1 print **example**"
-    print(string, style="magenta")
-    print.print(string, style="magenta")
-    print.log(string, style="magenta")
-    print.pyprint(string)
-    print.richprint(string)
-
-
-
-# %% test verbose
-def test_verbose() :
-    '''
-    Test verbose
-    '''
-    print.verbose = False # Muting
-    print("Should not print") # Does not print
-    print("Should print", verbose=True) # Does print
-    print("Should not print") # Does not print
-    print.verbose = True # Unmuting
-    print("Should print") # Does print
-    print("Should not print", verbose=False) # Does not print
-    print("Should print") # Does print
-
-
-
-# %% test logging
-def test_logging() :
-    '''
-    Test logging
-    '''
-    print.theme = {"success" : "green"}
-    string = "# TEST\nHello *world*!\n\nThis is 1 print **example**"
-    print(string, style="success")
-    print.print_locals()
-    try :
-        1/0
-    except Exception :
-        print.error()
-    file = debug_folder / "log.html"
-    print.export_html(file)
-
-
-
-# %% test console
-def test_console() :
-    '''
-    Test console
-    '''
-    file = debug_folder / 'log.md'
-    print.file = file
-    string = "# TEST\nHello *world*!\n\nThis is 1 print **example**"
-    print(string, style="magenta")
-    assert file.exists()
-
-
-
-# %% test clock
-def test_clock() :
-    '''
-    Test clock
-    '''
-    for i in print.clock(5, "Outer loop") :
-        print("Should not print")
-        for j in print.clock(5, "Inner loop") :
-            sleep(1)
-            print("Should not print")
-    
-    for i in print.clock(10, "Other loop") :
-        sleep(1)
-        print("Should not print")
-
-
-
-
-
-
-# %% Test function run
-if __name__ == "__main__":
-    from corelp import test
-    test(__file__)

corelp/modules/user_inputs_LP/test_user_inputs.py

@@ -1,46 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Date          : 2025-11-30
-# Author        : Lancelot PINCET
-# GitHub        : https://github.com/LancelotPincet
-# Library       : coreLP
-# Module        : user_inputs
-
-"""
-This file allows to test user_inputs
-
-user_inputs : Gets last user inputs dictionnary from global variables.
-"""
-
-
-
-# %% Libraries
-from corelp import print, debug
-import pytest
-from corelp import user_inputs
-debug_folder = debug(__file__)
-
-
-
-# %% Function test
-def test_user_inputs() :
-    '''
-    Test user_inputs function
-    '''
-    user_inputs() #init
-    a = 1
-    inputs = user_inputs()
-    if inputs != {'a': 1} :
-        raise ValueError(f'{inputs} should be dict(a=1)')
-    user_inputs() #init
-    b = 2
-    inputs = user_inputs()
-    if inputs != {'b': 2} :
-        raise ValueError(f'{inputs} should be dict(b=2)')
-
-
-
-# %% Test function run
-if __name__ == "__main__":
-    from corelp import test
-    test(__file__)

corelp/modules/user_inputs_LP/user_inputs.py

@@ -1,87 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Date          : 2025-11-30
-# Author        : Lancelot PINCET
-# GitHub        : https://github.com/LancelotPincet
-# Library       : coreLP
-# Module        : user_inputs
-
-"""
-Gets last user inputs dictionnary from global variables.
-"""
-
-
-
-# %% Libraries
-import inspect
-
-
-
-# %% Function
-
-def user_inputs(reset=False) :
-    r"""
-    Return a dictionary of variables defined by the user in the interactive environment.
-
-    Parameters
-    ----------
-    reset : bool or str
-        True to set as first call, String value to define a group of parameters
-
-    Returns
-    -------
-    dict
-        A dictionary containing the user's currently defined variables.
-
-    Examples
-    --------
-    >>> from corelp import user_inputs
-    >>> user_inputs(True)       # First call (initializes and clears import-related variables)
-    None
-    >>> a = 1               # User defines a variable
-    >>> user_inputs()       # Now returns: {'a': 1}
-    {'a': 1}
-    """
-    frame = inspect.currentframe().f_back
-    ns = {**frame.f_globals, **frame.f_locals}
-
-    # ---- Filter user variables (ignore internals starting with "_") ----
-    ns = {key: value for key, value in ns.items() if not key.startswith("_")}
-
-    # Validate status
-    if reset :
-        user_inputs.current_group = reset if isinstance(reset, str) else None
-        user_inputs.cache = None
-
-    # Case when user_inputs is on top : cache = None
-    if user_inputs.cache is None :
-        user_inputs.cache = ns
-        return
-
-    # Case when user_inputs is at bottom : cache = dict
-    else :
-        updated = { key: value for key, value in ns.items() if key not in user_inputs.cache or user_inputs.cache[key] is not value}
-        values = {key: value for key, value in updated.items() if not key.endswith('_')}
-        comments = {key: value for key, value in updated.items() if key.endswith('_')}
-        
-        # Group values
-        if user_inputs.current_group is not None :
-            user_inputs.groups_values[user_inputs.current_group] = values
-            user_inputs.groups_comments[user_inputs.current_group] = comments
-
-        # End
-        user_inputs.current_group = None
-        user_inputs.cache = None
-        return values
-
-user_inputs.cache = None
-user_inputs.current_group = None
-user_inputs.groups_values = {}
-user_inputs.groups_comments = {}
-
-
-
-# %% Test function run
-if __name__ == "__main__":
-    from corelp import test
-    test(__file__)

corelp/modules.json

@@ -1,80 +0,0 @@
-{
-    "Path": {
-        "date": "2025-09-02",
-        "description": "This function is a wrapper around the pathlib.Path and returns a compatible Path with a windows path copied inside Linux (for WSL)",
-        "module": "modules/Path_LP/Path",
-        "object": "Path"
-    },
-    "Section": {
-        "date": "2025-08-28",
-        "description": "This class defines decorator instances allowing to create section functions.",
-        "module": "modules/Section_LP/Section",
-        "object": "Section"
-    },
-    "debug": {
-        "date": "2025-08-25",
-        "description": "This function will give and create the debug folder for a given python file.",
-        "module": "modules/debug_LP/debug",
-        "object": "debug"
-    },
-    "folder": {
-        "date": "2025-08-25",
-        "description": "This function creates a new folder, while crushing previous instances if already exists.",
-        "module": "modules/folder_LP/folder",
-        "object": "folder"
-    },
-    "getmodule": {
-        "date": "2025-08-25",
-        "description": "This function is to be used in a library __init__ file. It creates lazy imports of the module imported and defines __getattr__ and __all__ for this library.",
-        "module": "modules/getmodule_LP/getmodule",
-        "object": "getmodule"
-    },
-    "kwargsself": {
-        "date": "2025-08-27",
-        "description": "This function will return all the attributes of an object (self) into a dictionnary (kwargs)",
-        "module": "modules/kwargsself_LP/kwargsself",
-        "object": "kwargsself"
-    },
-    "main": {
-        "date": "2025-08-28",
-        "description": "This function can decorate the main function of a script.",
-        "module": "modules/main_LP/main",
-        "object": "main"
-    },
-    "print": {
-        "date": "2025-08-27",
-        "description": "This function overrides python built in print function to add functionnalities.",
-        "module": "modules/print_LP/print",
-        "object": "print"
-    },
-    "prop": {
-        "date": "2025-08-25",
-        "description": "This function serves as an improved property decorator.",
-        "module": "modules/prop_LP/prop",
-        "object": "prop"
-    },
-    "rfrom": {
-        "date": "2025-08-29",
-        "description": "This function allows to do a relative import that works in module and script modes.",
-        "module": "modules/rfrom_LP/rfrom",
-        "object": "rfrom"
-    },
-    "selfkwargs": {
-        "date": "2025-08-27",
-        "description": "This function takes a dictionnary and sets all its values to an object (self).",
-        "module": "modules/selfkwargs_LP/selfkwargs",
-        "object": "selfkwargs"
-    },
-    "test": {
-        "date": "2025-08-25",
-        "description": "This function will launch the testfile for the current file using pytest library.",
-        "module": "modules/test_LP/test",
-        "object": "test"
-    },
-    "user_inputs": {
-        "date": "2025-11-30",
-        "description": "Gets last user inputs dictionnary from global variables.",
-        "module": "modules/user_inputs_LP/user_inputs",
-        "object": "user_inputs"
-    }
-}

corelp/scripts.json

@@ -1 +0,0 @@
-{}