corelp 1.0.28__py3-none-any.whl

corelp/modules/rfrom_LP/rfrom.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-08-29
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : coreLP
+# Module        : rfrom
+
+"""
+This function allows to do a relative import that works in module and script modes.
+"""
+
+
+
+# %% Libraries
+import importlib
+import sys
+
+
+# %% Function
+def rfrom(module, *functions) :
+    '''
+    This function allows to do a relative import that works in module and script modes.
+    
+    Parameters
+    ----------
+    module : str
+        Name of relative module (with the point).
+    functions : str
+        Names of objects to import from module.
+
+    Returns
+    -------
+    imported : object
+        objects imported.
+
+    Examples
+    --------
+    >>> from corelp import rfrom
+    ...
+    >>> func = rfrom(".module", "func")
+    >>> func1, func2 = rfrom(".module", "func1", "func2")
+    '''
+
+    caller_globals = sys._getframe(1).f_globals
+    package = caller_globals.get("__package__")
+
+    mod = None
+    if module.startswith(".") and package:
+        # Only attempt relative import if inside a package
+        try:
+            mod = importlib.import_module(module, package)
+        except ImportError:
+            pass
+
+    if mod is None:
+        # fallback to absolute import (strip leading dots)
+        mod = importlib.import_module(module.lstrip("."))
+
+    # If no functions asked, returns module
+    if len(functions) == 0 :
+        return mod
+
+    imported = tuple(getattr(mod, f) for f in functions)
+    return imported[0] if len(imported) == 1 else imported
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

corelp/modules/rfrom_LP/test_rfrom.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-08-29
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : coreLP
+# Module        : rfrom
+
+"""
+This file allows to test rfrom
+
+rfrom : This function allows to do a relative import that works in module and script modes.
+"""
+
+
+
+# %% Libraries
+from corelp import print, debug
+import pytest
+from corelp import rfrom
+debug_folder = debug(__file__)
+
+
+
+# %% Function test
+def test_function() :
+    '''
+    Test rfrom function
+    '''
+    print('Hello world!')
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

corelp/modules/selfkwargs_LP/selfkwargs.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-08-27
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : coreLP
+# Module        : selfkwargs
+
+"""
+This function takes a dictionnary and sets all its values to an object (self).
+"""
+
+
+
+# %% Function
+def selfkwargs(self, kwargs) :
+    '''
+    This function takes a dictionnary (kwargs) and sets all its values to an object (self).
+    
+    Parameters
+    ----------
+    self : object
+        Object instance where to set attributes.
+    kwargs : object
+        Dictionnary defining which attributes to set and its values.
+
+    Examples
+    --------
+    >>> from corelp import selfkwargs
+    ...
+    >>> # Typicall use is in __init__ function :
+    >>> class MyClass :
+    ...     def __init__(self, **kwargs) :
+    ...         selkwargs(self, kwargs) # Sets all the keyword arguments to self
+    ...
+    >>> instance = MyClass(a=1, b=2)
+    >>> print(instance.a)
+    1
+    >>> print(instance.b)
+    2
+    '''
+
+    for key, value in kwargs.items() :
+        setattr(self, key, value)
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

corelp/modules/selfkwargs_LP/test_selfkwargs.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-08-27
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : coreLP
+# Module        : selfkwargs
+
+"""
+This file allows to test selfkwargs
+
+selfkwargs : This function takes a dictionnary and sets all its values to an object (self).
+"""
+
+
+
+# %% Libraries
+from corelp import debug, selfkwargs
+import pytest
+debug_folder = debug(__file__)
+
+
+
+# %% Function test
+def test_function() :
+    '''
+    Test selfkwargs
+    '''
+    class MyClass() :
+        def __init__(self, **kwargs) :
+            selfkwargs(self, kwargs)
+    instance = MyClass(a="a", b="b")
+    assert instance.a == "a"
+    assert instance.b == "b"
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

corelp/modules/test_LP/test.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-08-25
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : coreLP
+# Module        : test
+
+"""
+This function will launch the testfile for the current file using pytest library.
+"""
+
+
+
+# %% Libraries
+from pathlib import Path
+import subprocess
+
+
+
+# %% Function
+def test(file, new=True) :
+    '''
+    This function will launch the testfile for the current file using pytest library.
+    
+    Parameters
+    ----------
+    file : str
+        __file__ string in the current python file to be tested.
+    new : bool
+        True to create a new folder.
+
+    Examples
+    --------
+    >>> # %% Test function run
+    ... if __name__ == "__main__":
+    ...     from corelp import test
+    ...     test(__file__)
+    '''
+
+    # Get paths
+    file = Path(file)
+    module_folder = file.parent
+    file_name = file.name
+    test_name = file_name if file_name.startswith('test_') else "test_" + file_name
+    test_file = module_folder / test_name
+
+    # __init__ files
+    if file_name == '__init__.py' :
+        return None
+    
+    # Testing
+    if test_file.exists() :
+        subprocess.run(["pytest", "-s", test_name], cwd=module_folder, check=True)
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

corelp/modules/test_LP/test_test.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : template_moduledate
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : coreLP
+# Module        : test
+
+"""
+This file allows to test test
+
+test : This function will launch the testfile for the current file using pytest library.
+"""
+
+
+
+# %% Libraries
+from corelp import debug
+import pytest
+debug_folder = debug(__file__)
+
+
+
+# %% Test function
+def test_function() :
+    print('Hello world!')
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

corelp/modules/user_inputs_LP/test_user_inputs.py

@@ -0,0 +1,45 @@
+#!/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
+    if user_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

@@ -0,0 +1,81 @@
+#!/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
+from IPython import get_ipython
+
+
+
+# %% Function
+_user_inputs = {} # User inputs cache
+
+def user_inputs() :
+    r"""
+    Return a dictionary of variables defined by the user in the interactive
+    environment.
+
+    This function is intended for use inside other functions via
+    ``function(**user_inputs())``.  
+    **It should not be used to store its return value**, e.g. **do not do**::
+
+        variable = user_inputs()
+
+    Instead, call it directly when needed.
+
+    Returns
+    -------
+    dict
+        A dictionary containing the user's currently defined variables.
+
+    Examples
+    --------
+    >>> from corelp import user_inputs
+    >>> user_inputs()       # First call (initializes and clears import-related variables)
+    {}
+    >>> a = 1               # User defines a variable
+    >>> user_inputs()       # Now returns: {'a': 1}
+    {'a': 1}
+    """
+
+    # ---- Detect execution environment ----
+    ipy = get_ipython()
+
+    if ipy is not None:
+        # Running in IPython or Jupyter
+        ns = ipy.user_ns
+    else:
+        # Running in normal Python script
+        frame = inspect.currentframe().f_back
+        ns = {**frame.f_globals, **frame.f_locals}
+
+    # ---- Filter user variables (ignore internals starting with "_") ----
+    ns = {k: v for k, v in ns.items() if not k.startswith("_")}
+
+    # ---- Return only new or updated variables ----
+    updated = {
+        k: v
+        for k, v in ns.items()
+        if k not in _user_inputs or _user_inputs[k] is not v
+    }
+
+    _user_inputs.update(updated)
+    return updated
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

corelp/modules.json

@@ -0,0 +1,80 @@
+{
+    "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

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

corelp-1.0.28.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.3
+Name: corelp
+Version: 1.0.28
+Summary: A library that gathers core functions for python programming.
+Requires-Dist: ipython
+Requires-Dist: ipywidgets
+Requires-Dist: joblib
+Requires-Dist: rich
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# coreLP
+
+```text
+Author        : Lancelot PINCET
+GitHub        : https://github.com/LancelotPincet/coreLP
+HTTPS         : https://github.com/LancelotPincet/coreLP.git
+SSH           : git@github.com:LancelotPincet/coreLP.git
+PyPI          : https://pypi.org/project/coreLP
+Docs          : https://coreLP.readthedocs.io
+```
+
+**A library that gathers core functions for python programming.**
+
+coreLP is available on [PyPI](https://pypi.org/project/coreLP) for pip installs.
+For more information, do not hesitate to consult the [Documentation](https://coreLP.readthedocs.io).
+
+---
+
+## MIT License
+
+<details>
+<summary>details</summary>
+
+Intellectual property behind this Library is protected via an [MIT license](LICENSE). This means everyone can *freely* use it in a personnal, academic or commercial manner, if they **keep the copyright name** at the top of the codes.
+
+The library can be redistributed, *with or without modifications*, in open or closed projects. However the **MIT license must be conserved**. For example in a commercial closed project, this means the **copyright and license must be visible somewhere**, like in the documentation or credits.
+
+The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+
+</details>

corelp-1.0.28.dist-info/RECORD

@@ -0,0 +1,48 @@
+corelp/__init__.py,sha256=B3HNFgCh9DLRahtokFJYbbHSJeeA6XPrLYAnpGuY7MQ,684
+corelp/icon_pythonLP.ico,sha256=D2ANffgbGXpJlr9wqtB7ysuq6UM-lIC2wDyDTrebjFA,67646
+corelp/modules/Path_LP/Path.py,sha256=wfvO1DuewIUSEA9_g66O5nCEp95Pr5XM-yxaOOEimTs,2418
+corelp/modules/Path_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/Path_LP/test_Path.py,sha256=8VSn9VVbhc3EDxXpxQV18rnAq_T2a1uuoRFKdmsqX-I,715
+corelp/modules/Section_LP/Section.py,sha256=D8zdQ6HXopfZ0JMdUD8s_dNaWq6mWAnsQvOyQpFedKw,6048
+corelp/modules/Section_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/Section_LP/test_Section.py,sha256=zcrIbJueMDT90t0_M-RD40IWpkx4OT7Q52tE6HzbfIo,812
+corelp/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/debug_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/debug_LP/debug.py,sha256=Mkn3WPTkaKSXdfmY8ioEwu4OXQqiDoM2Akhbz62Nnis,1623
+corelp/modules/debug_LP/test_debug.py,sha256=FIDfwO-OAwflEQ5y2djQNUh_-BcxgQDm9jPLvaUdzDo,716
+corelp/modules/folder_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/folder_LP/folder.py,sha256=Wd5gaT0oX1rWpXPUcHTVIPQjNPD-IPWPEcGSgetPl1U,2497
+corelp/modules/folder_LP/test_folder.py,sha256=zccBcsE10dTQLnCX7tK-Fa2n3F_JzmyzSkQVAXz50yw,928
+corelp/modules/getmodule_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/getmodule_LP/getmodule.py,sha256=7I4ehsBtgfi-wUyiQ5eT07lc8FiUVN7Fbdm0pXLA5T4,2694
+corelp/modules/kwargsself_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/kwargsself_LP/kwargsself.py,sha256=24HVn1G7ALdhQFSLT0U2dVjVzop6c2s-nr7DrMK53iw,1865
+corelp/modules/kwargsself_LP/test_kwargsself.py,sha256=BaqGu0bqFuFemiYUEDMviFfegTb0aF6lmeFm3KJa8sw,1241
+corelp/modules/main_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/main_LP/main.py,sha256=I7D1gYv9AQq2DWU21blB8nL2RlqpexLEE5p1DLdoPdo,9288
+corelp/modules/main_LP/test_main.py,sha256=mxL645pZdkJ8J5MFdj0K-z8xRCGKQ0zw1NvmW3iPGB4,1741
+corelp/modules/print_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/print_LP/print.py,sha256=7TYjAGypT_TI0UHmL9F8zPL7gjFfJn2DnCpx0cu4IGM,8565
+corelp/modules/print_LP/test_print.py,sha256=uMmCrnyIVSlZg_ZEOk2mr5zDlEpTN2KMq4jFu5p6n4I,2292
+corelp/modules/prop_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/prop_LP/prop.py,sha256=lfsENmjg65mpXxt9V9n3Nn__wHgNJA61l8_UXBKn1lc,3999
+corelp/modules/prop_LP/test_prop.py,sha256=X5GJwIyik5Gzd6Z28h1kGdZzVVhb1D5FXTHXvXBbwfA,2302
+corelp/modules/rfrom_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/rfrom_LP/rfrom.py,sha256=f5-zPUUxlxInnaBM_WMuAaSMjdaoyOjsn5WbpLIfSVk,1690
+corelp/modules/rfrom_LP/test_rfrom.py,sha256=e6Q-PmvsNT7CrZOjrjW_-xrLDYyfqfTkLwC6y0lhz9Q,673
+corelp/modules/selfkwargs_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/selfkwargs_LP/selfkwargs.py,sha256=7yWkpVQRwb2VnDPUGxREXjyVIn0n8RpptlP3lnP57wU,1203
+corelp/modules/selfkwargs_LP/test_selfkwargs.py,sha256=Ex-y60W9oD1OUtDlRvyxn-Wlq1l3JmIJY0Iot2uGQbY,826
+corelp/modules/test_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/test_LP/test.py,sha256=KwAeIZWQ7pZX85J50q6qfB4HuJUgREu1ieB_byPqI2g,1361
+corelp/modules/test_LP/test_test.py,sha256=sXI6G4OBnWXSqrfMy9QdabkYIvcD80EmnNcnQiXxcRI,605
+corelp/modules/user_inputs_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/modules/user_inputs_LP/test_user_inputs.py,sha256=lK8pYm5q5ob9ry3T-gU3J_-KZMKWCCmeuFjjH7DkF_8,927
+corelp/modules/user_inputs_LP/user_inputs.py,sha256=2lGkIl2dA_1mcDB8ExvJg4xlcx26viKi878M9ml0MUo,1964
+corelp/modules.json,sha256=ZQ8BMU8X2u71wfVj_AufwOoJUPdaxU_AHn7Ohbkp-Pc,3122
+corelp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+corelp/scripts.json,sha256=RBNvo1WzZ4oRRq0W9-hknpT7T8If536DEMBg9hyq_4o,2
+corelp-1.0.28.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+corelp-1.0.28.dist-info/METADATA,sha256=ZuuQnpjGFKhTSOVG4DaXwHWPBJFdRq4NjrXZL4d2czU,1747
+corelp-1.0.28.dist-info/RECORD,,

corelp-1.0.28.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.24
+Root-Is-Purelib: true
+Tag: py3-none-any