pyconject 0.1.0__tar.gz

pyconject-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyconject-0.1.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: pyconject
+Version: 0.1.0
+Summary: pyconject --- a highly opinionated PYthon CONfig inJECTor library.
+Author-email: "Edward L." <neolaw+pyconject@gmail.com>
+Project-URL: Homepage, https://github.com/neolaw84/pyconject
+Project-URL: Issues, https://github.com/neolaw84/pyconject/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# pyconject
+
+`pyconject` is a (highly) opinionated PYthon CONfig inJECTor library inspired by Spring Framework (and Spring Boot Framework).
+
+> **How to pronounce `pyconject`**
+> 
+> `pyconject` is pronounced PY-CON-JECT, a word play for Burmese "ပိုက်ကွန်ချက်" = "the art of throwing net". It represents how it can be used to capture all types of configs and inject them into all types of packages.
+
+# Usage
+
+For detailed usage, refer to [usage.md](usage.md).
+
+## TL;DR
+
+Instead of this: 
+
+```python
+# in usr_p/usr_sp/usr_m.py
+from black_p.black_sp.black_m import black_func
+
+# initialize values_a, value_b, 
+# value_c and value_d.
+# this part is often the ugly mess
+# because it involves reading yaml 
+# or other tree-like files and 
+# assigning values
+import yaml
+with open("./configs.yml", "rt") as f:
+  configs = yaml.safe_load(f)
+  black_func_parameters = configs["black_p"]["black_sp"]["black_m"]["black_func"]
+  value_a = black_func_parameters["a"]
+  # more ugly things here; you get the gist ...
+
+black_func(a=value_a, b=value_b, c=value_c, d=value_d)
+```
+
+With `pyconject`, we can do this:
+
+
+```python
+# in usr_p/usr_sp/usr_m.py
+from black_p.black_sp.black_m import black_func
+
+# pyconject initializes values of a, b, c and d.
+from pyconject import pyconject
+
+pyconject.init(globals())
+
+with pyconject.cntx():
+    black_func() 
+```
+
+## Developing with `pyconject`
+
+Instead of this:
+
+```python
+# in dev_p/dev_sp/dev_m.py
+import os
+
+env = os.environ["environment"]
+
+def dev_func(a=None, b=None, c=None, d=None):
+  if env == "dev":
+    if a is None: a = "dev-a"
+    if b is None: b = "dev-b"
+    # you know the rest
+  elif env == "stg":
+    if a is None: a = "stg-a"
+    if b is None: b = "stg-b"
+    # you know the rest
+  elif env == "prd":
+    if a is None: a = "prd-a"
+    if b is None: b = "prd-b"
+    # you know the rest
+  # ... 
+  # your application logic
+  return results
+```
+
+With `pyconject`, you can do this:
+
+```yaml
+# in dev_p/dev_sp/pyconject-dev_m-dev.py
+dev_func:
+  a : "dev-a"
+  b : "dev_b"
+  ...
+```
+
+```python
+# in dev_p/dev_sp/dev_m.py
+from pyconject import pyconject
+
+@pyconject.func
+def dev_func(a, b, c, d):
+  # your application logic
+  return results
+```
+
+# To dos
+
+* Developer integration
+  * ~~Functions~~ done
+  * Singletons/Classes
+  * ~~Modules~~ done
+  * ~~Packages~~ done
+  
+* Client integration
+  * ~~Functions~~ done
+  * Singletons/Classes
+  * ~~Modules~~
+  * ~~Packages~~
+  * ~~Auto-detect when cntx open~~ use `pyconject.init(globals())` instead
+
+* Generate config files
+
+* Raw retrieval of resolved configs (to manipulate by user)
+
+* Type of configs
+  * ~~**yaml -- priority**~~ done
+  * ~~environment/target selection~~ done
+  * .env
+  * overrides
+    * environment variables
+    * commandline arguments
+
+* Documentations
+  * ~~Usage~~ done
+
+* CI/CD
+  * github actions to unittest at push and pull-request
+  * github actions to publish to pypi after merge

pyconject-0.1.0/README.md

@@ -0,0 +1,133 @@
+# pyconject
+
+`pyconject` is a (highly) opinionated PYthon CONfig inJECTor library inspired by Spring Framework (and Spring Boot Framework).
+
+> **How to pronounce `pyconject`**
+> 
+> `pyconject` is pronounced PY-CON-JECT, a word play for Burmese "ပိုက်ကွန်ချက်" = "the art of throwing net". It represents how it can be used to capture all types of configs and inject them into all types of packages.
+
+# Usage
+
+For detailed usage, refer to [usage.md](usage.md).
+
+## TL;DR
+
+Instead of this: 
+
+```python
+# in usr_p/usr_sp/usr_m.py
+from black_p.black_sp.black_m import black_func
+
+# initialize values_a, value_b, 
+# value_c and value_d.
+# this part is often the ugly mess
+# because it involves reading yaml 
+# or other tree-like files and 
+# assigning values
+import yaml
+with open("./configs.yml", "rt") as f:
+  configs = yaml.safe_load(f)
+  black_func_parameters = configs["black_p"]["black_sp"]["black_m"]["black_func"]
+  value_a = black_func_parameters["a"]
+  # more ugly things here; you get the gist ...
+
+black_func(a=value_a, b=value_b, c=value_c, d=value_d)
+```
+
+With `pyconject`, we can do this:
+
+
+```python
+# in usr_p/usr_sp/usr_m.py
+from black_p.black_sp.black_m import black_func
+
+# pyconject initializes values of a, b, c and d.
+from pyconject import pyconject
+
+pyconject.init(globals())
+
+with pyconject.cntx():
+    black_func() 
+```
+
+## Developing with `pyconject`
+
+Instead of this:
+
+```python
+# in dev_p/dev_sp/dev_m.py
+import os
+
+env = os.environ["environment"]
+
+def dev_func(a=None, b=None, c=None, d=None):
+  if env == "dev":
+    if a is None: a = "dev-a"
+    if b is None: b = "dev-b"
+    # you know the rest
+  elif env == "stg":
+    if a is None: a = "stg-a"
+    if b is None: b = "stg-b"
+    # you know the rest
+  elif env == "prd":
+    if a is None: a = "prd-a"
+    if b is None: b = "prd-b"
+    # you know the rest
+  # ... 
+  # your application logic
+  return results
+```
+
+With `pyconject`, you can do this:
+
+```yaml
+# in dev_p/dev_sp/pyconject-dev_m-dev.py
+dev_func:
+  a : "dev-a"
+  b : "dev_b"
+  ...
+```
+
+```python
+# in dev_p/dev_sp/dev_m.py
+from pyconject import pyconject
+
+@pyconject.func
+def dev_func(a, b, c, d):
+  # your application logic
+  return results
+```
+
+# To dos
+
+* Developer integration
+  * ~~Functions~~ done
+  * Singletons/Classes
+  * ~~Modules~~ done
+  * ~~Packages~~ done
+  
+* Client integration
+  * ~~Functions~~ done
+  * Singletons/Classes
+  * ~~Modules~~
+  * ~~Packages~~
+  * ~~Auto-detect when cntx open~~ use `pyconject.init(globals())` instead
+
+* Generate config files
+
+* Raw retrieval of resolved configs (to manipulate by user)
+
+* Type of configs
+  * ~~**yaml -- priority**~~ done
+  * ~~environment/target selection~~ done
+  * .env
+  * overrides
+    * environment variables
+    * commandline arguments
+
+* Documentations
+  * ~~Usage~~ done
+
+* CI/CD
+  * github actions to unittest at push and pull-request
+  * github actions to publish to pypi after merge

pyconject-0.1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyconject"
+dynamic = ["version"]
+authors = [
+  { name="Edward L.", email="neolaw+pyconject@gmail.com" },
+]
+description = "pyconject --- a highly opinionated PYthon CONfig inJECTor library."
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/neolaw84/pyconject"
+Issues = "https://github.com/neolaw84/pyconject/issues"
+
+[tool.setuptools.dynamic]
+version = {attr = "pyconject.__version__"}
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src", "tests"
+]
+
+[tool.bumpversion]
+current_version = "0.1.0"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<micro>\\d+)"
+serialize = ["{major}.{minor}.{micro}"]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = true
+sign_tags = false
+tag_name = "v{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+commit = true
+message = "Bump version: {current_version} → {new_version}"
+commit_args = ""
+
+[[tool.bumpversion.files]]
+filename = "./src/pyconject/__init__.py"
+search = "__version__ = '{current_version}'"
+replace = "__version__ = '{new_version}'"

pyconject-0.1.0/setup.cfg

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

pyconject-0.1.0/src/pyconject/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

pyconject-0.1.0/src/pyconject/context.py

@@ -0,0 +1,84 @@
+from copy import deepcopy
+from pathlib import Path
+import inspect
+from .registry import Registry
+from .utils import Stack, get_target_frame, load_and_merge_configs, get_imported_modules_and_funcs
+
+# def _get_caller():
+#     """Retrieves the globals() dictionary of the caller's frame."""
+
+#     caller_frame = inspect.currentframe().f_back.f_back
+#     return caller_frame
+
+class Cntx:
+    def __init__(self, target=None, config_path=None, cntx_stack=None):
+        self.cntx_stack = cntx_stack if cntx_stack else _cntx_stack
+
+        frame = inspect.currentframe()
+
+        while frame:
+            filename = inspect.getframeinfo(frame).filename
+            if not any(pattern in filename for pattern in ["<frozen importlib._bootstrap>", "<pytest", "<ipython-input-"]):
+                self.glb = frame.f_globals
+                break  # Exit after modifying the first suitable frame
+            frame = frame.f_back
+
+        self.target = target
+        self.config_path = config_path
+
+    def __enter__(self):
+        self.cntx_stack.stack(target=self.target, config_path=self.config_path)
+        
+        # new_globals = {n: self.cntx_stack.registry.register(v, by_dev=False) for n, v in self.glb.items()}
+        # for n, v in new_globals.items():
+        #     self.glb[n] = v
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.cntx_stack.unstack()
+
+
+class CntxStack:
+    _instance = None
+
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super(CntxStack, cls).__new__(cls)
+        return cls._instance
+    
+    def __init__(self):
+        self.config_stack = Stack()
+        self.registry = Registry(self)
+
+    def _resolve_dev_configs(self, target):
+        dev_configs = self.registry.load_dev_configs(force=True, target=target)
+        self.config_stack.push(dev_configs)
+        return dev_configs
+
+    def stack(self, target=None, config_path=None):
+        prev_configs = self.config_stack.peek()
+        if prev_configs is None:
+            prev_configs = self._resolve_dev_configs(target)
+        # at this point, prev_configs is not None
+        configs = deepcopy(prev_configs)
+        if config_path is None: 
+            config_path = "./configs.yml"
+        config_path = Path(config_path)
+        configs = load_and_merge_configs(config_path, configs)
+        
+        if target is not None: 
+            tgt_config_path = config_path.parent / f"{config_path.stem}-{target}{config_path.suffix}"
+            configs = load_and_merge_configs(tgt_config_path, configs)
+        
+        self.config_stack.push(configs)
+
+        return configs
+    
+    def get_configs(self):
+        return self.config_stack.peek() if len(self.config_stack) > 1 else {}
+    
+    def unstack(self):
+        self.config_stack.pop()
+        if len(self.config_stack) == 1: self.config_stack.pop()
+
+_cntx_stack = CntxStack()

pyconject-0.1.0/src/pyconject/pyconject.py

@@ -0,0 +1,19 @@
+import functools
+
+from .context import _cntx_stack, Cntx
+
+def func(_func=None):
+    return functools.partial(_cntx_stack.registry.register, by_dev=True) \
+        if _func is None \
+        else _cntx_stack.registry.register(_func, by_dev=True)
+
+def mdle(_mdle:str):
+    return _cntx_stack.registry.register(_mdle, by_dev=True)
+
+def init(caller_globals):
+    new_globals = {n: _cntx_stack.registry.register(v, by_dev=False) for n, v in caller_globals.items()}
+    caller_globals.update(new_globals)
+
+def cntx(config_path=None, target=None):
+    cntx = Cntx(target=target, config_path=config_path)
+    return cntx 

pyconject-0.1.0/src/pyconject/registry.py

@@ -0,0 +1,244 @@
+
+from __future__ import annotations
+
+import importlib
+from enum import Enum
+
+import functools
+import inspect
+from pathlib import Path
+from typing import Callable, Dict, Union, List
+
+from abc import ABC, abstractmethod
+
+from .utils import get_from_prefixed_tree, get_subs, init_default_dev_configs, load_and_merge_configs
+
+def _check_if_method(func: Callable):
+    return hasattr(func, "__self__") and getattr(func, "__self__", None) is not None 
+
+class RegItemType(Enum):
+    UNKN = 0
+    FUNC = 1
+    MTHD = 2
+    MODL = 3
+    PKGE = 4
+
+class RegItem(ABC):
+    def __init__(self, item: Union[Callable, str], reg_item_type:RegItemType, file_path:Path, m):
+        self.item = item
+        self.reg_item_type = reg_item_type
+        self.file_path = file_path
+        # self.configs = configs
+        self.m = m
+        self.cname = self.get_cname()
+        self.prefix = self.get_prefix()
+
+    @abstractmethod
+    def get_cname(self):
+        raise NotImplementedError("Entry is an abstract class and hasn't implemented get_cname.")
+    
+    def __eq__(self, value: object) -> bool:
+        if not isinstance(value, RegItem): return False
+        return all(
+            self.item == value.item, 
+            self.reg_item_type == value.reg_item_type, 
+            self.file_path == value.file_path, 
+            # self.configs == value.configs, 
+            self.m == value.m,
+            self.cname == value.cname
+        )
+    
+    @abstractmethod
+    def get_dev_config_paths(self):
+        raise NotImplementedError("entry is an abstract class and hasn't implemented get_dev_config_paths.")
+    
+    @abstractmethod
+    def get_prefix(self):
+        raise NotImplementedError("entry is an abstract class and hasn't implemented get_prefix.")
+
+class Function(RegItem):
+    def get_cname(self):
+        return (self.item.__module__, self.item.__qualname__)
+    
+    def get_dev_config_paths(self):
+        configs_parent = Path(self.m.__file__).parent
+        
+        dev_configs = None
+        if hasattr(self.item, "pyconject"): dev_configs = getattr(self.item, "pyconject")
+
+        if isinstance(dev_configs, str): 
+            cfg_path = Path(dev_configs)
+            return init_default_dev_configs(configs_parent, cfg_path.stem, cfg_path.suffix)
+        
+        base_file = "-".join(["pyconject", self.cname[0].split(".")[-1], self.cname[1]])    
+        _temp_dict = init_default_dev_configs(configs_parent, base_file)
+        
+        if isinstance(dev_configs, dict):
+            for k, v in dev_configs.items():
+                _temp_dict[k] = str(configs_parent / v)
+
+        return _temp_dict # this also covers when self.configs is None
+    
+    def get_prefix(self):
+        return ".".join(self.cname) if self.reg_item_type == RegItemType.FUNC else ".".join((self.cname[0], self.cname[1].replace(".", "-")))
+
+class Module(RegItem):
+    def get_cname(self):
+        parts = self.m.__name__.split(".")
+        return (".".join(parts[:-1]), parts[-1])
+    
+    def get_dev_config_paths(self):
+        configs_parent = Path(self.m.__file__).parent
+        
+        dev_configs = None
+        if hasattr(self.m, "pyconject"): dev_configs = getattr(self.m, "pyconject")
+
+        if isinstance(dev_configs, str): 
+            cfg_path = Path(dev_configs)
+            return init_default_dev_configs(configs_parent, cfg_path.stem, cfg_path.suffix)
+        
+        base_file = "-".join(["pyconject", self.cname[1]])    
+        _temp_dict = init_default_dev_configs(configs_parent, base_file)
+        
+        if isinstance(dev_configs, dict):
+            for k, v in dev_configs.items():
+                _temp_dict[k] = str(configs_parent / v)
+
+        return _temp_dict # this also covers when self.configs is None
+    
+    def get_prefix(self):
+        return ".".join(self.cname) if self.reg_item_type == RegItemType.FUNC else ".".join((self.cname[0], self.cname[1].replace(".", "-")))
+    
+class Package(RegItem):
+    def get_cname(self):
+        parts = self.m.__name__.split(".")
+        return (".".join(parts[:-1]), parts[-1])
+    
+    def get_dev_config_paths(self):
+        configs_parent = Path(self.m.__file__).parent
+        
+        dev_configs = None
+        if hasattr(self.m, "pyconject"): dev_configs = getattr(self.m, "pyconject")
+        
+        if isinstance(dev_configs, str): 
+            cfg_path = Path(dev_configs)
+            return init_default_dev_configs(configs_parent, cfg_path.stem, cfg_path.suffix)
+        
+        base_file = "pyconject"    
+        _temp_dict = init_default_dev_configs(configs_parent, base_file)
+        
+        if isinstance(dev_configs, dict):
+            for k, v in dev_configs.items():
+                _temp_dict[k] = str(configs_parent / v)
+
+        return _temp_dict # this also covers when dev_configs is None
+    
+    def get_prefix(self):
+        return ".".join(self.cname) if self.reg_item_type == RegItemType.FUNC else ".".join((self.cname[0], self.cname[1].replace(".", "-")))
+
+def _create_reg_item(item)->RegItem:
+    try:
+        reg_item_type, file_path, m = RegItemType.UNKN, None, None
+        if callable(item): 
+            m = importlib.import_module(item.__module__)
+            file_path = Path(m.__file__)
+            reg_item_type = RegItemType.MTHD if _check_if_method(item) else RegItemType.FUNC
+        else: # package or sub-module registration
+            if isinstance(item, str): # package/module registration by name
+                m = importlib.import_module(item)
+            else: # package/module registration by package/module itself
+                m = item 
+                item = f"{m.__module__}.{m.__name__}"
+            file_path = Path(m.__file__)
+            reg_item_type = RegItemType.PKGE if file_path.stem == "__init__" else RegItemType.MODL
+    finally:
+        entry_type_to_entry_class: Dict[RegItemType, RegItem] = {
+            RegItemType.FUNC : Function, 
+            RegItemType.MTHD : Function,
+            RegItemType.MODL : Module, 
+            RegItemType.PKGE : Package
+        }
+        Ent: RegItem = entry_type_to_entry_class.get(reg_item_type, None)
+        if Ent: return Ent(item, reg_item_type, file_path, m)
+
+def _register_func(f, cntx_stack):
+    @functools.wraps(f)
+    def wrapper_func(*args, **kwargs):
+        # Get the function signature.
+        sig = inspect.signature(f)
+        
+        # Bind the given arguments to the function signature.
+        bound_args = sig.bind_partial(*args, **kwargs)
+        
+        # Iterate over the parameters in the function signature.
+        reg_item = _create_reg_item(item=f)
+        configs = cntx_stack.get_configs()
+        kw_args = get_from_prefixed_tree(prefix=reg_item.prefix, tree=configs)
+        if kw_args:
+            for param_name, param in sig.parameters.items():
+                # If a parameter is missing from the bound arguments
+                # and present in the configs in the dictionary at top 
+                # of cntx_stack, use the value from the dictionary.
+                
+                if param_name not in bound_args.arguments and param_name in kw_args:
+                    kwargs[param_name] = kw_args[param_name]
+        value = f(*args, **kwargs)
+        return value
+    return wrapper_func
+
+class Registry:
+    
+    def __init__(self, cntx_stack):
+        self._cntx_stack = cntx_stack
+        self._registry = {}
+        self._loaded_dev_configs = None
+
+    def _register(self, item: Union[Callable,str], dev_override:bool=False) -> None:
+        # override is for dev registration only; 
+        # if it is by client, it does not matter
+        entry_inst = _create_reg_item(item=item)
+        
+        if entry_inst is None: return item # can't do anything here
+
+        prefix = entry_inst.prefix
+        
+        # dev_override means direct dev call
+        if prefix not in self._registry.keys() or dev_override: 
+            self._registry[prefix] = entry_inst
+
+            if entry_inst.reg_item_type in [RegItemType.FUNC, RegItemType.MTHD]:
+                entry_inst.item = _register_func(f=entry_inst.item, cntx_stack=self._cntx_stack)
+
+            if entry_inst.reg_item_type in [RegItemType.MODL, RegItemType.PKGE]:
+                # recursively register all sub-modules  
+                _subs = {sub_name: self._register(sub) for sub_name, sub in get_subs(entry_inst.m)}
+                
+                for sn, sv in _subs.items():
+                    vars(entry_inst.m)[sn] = sv
+
+        return self._registry[prefix].item
+
+    def register(self, item: Union[Callable, str], by_dev:bool=True) -> None:
+        try:
+            return self._register(item, dev_override=by_dev)
+        except: 
+            return item 
+        
+    def load_dev_configs(self, force=False, target=None) -> Dict:
+        if self._loaded_dev_configs is not None and not force:
+            return self._loaded_dev_configs
+        
+        sorted_prefixes = sorted([prefix for prefix in self._registry.keys()], key=lambda x : len(".".join(x).split(".")))
+
+        sorted_reg_items : List[RegItem] = [self._registry[prefix] for prefix in sorted_prefixes]
+        
+        configs = {}
+        for reg_item in sorted_reg_items:
+            dev_config_path = reg_item.get_dev_config_paths()
+            configs = load_and_merge_configs(dev_config_path[""], configs, reg_item.prefix)
+            
+            if target is not None and target in dev_config_path:
+                configs = load_and_merge_configs(dev_config_path[target], configs, reg_item.prefix)
+
+        self._loaded_dev_configs = configs
+        return configs

pyconject-0.1.0/src/pyconject/utils.py

@@ -0,0 +1,97 @@
+from typing import Dict
+
+import inspect
+import yaml 
+
+def merge_dictionaries(dict1, dict2):
+    merged = dict1.copy()
+    for key, value in dict2.items():
+        if key in merged and isinstance(merged[key], dict) and isinstance(value, dict):
+            merged[key] = merge_dictionaries(merged[key], value)
+        else:
+            merged[key] = value
+    return merged
+
+
+def create_prefixed_tree(cfg: Dict, prefix: str) -> Dict:
+    parts = prefix.split(".")
+    tree = cfg
+    for part in reversed(parts):
+        if part != "": tree = {part: tree}
+    return tree
+
+def get_from_prefixed_tree(tree: Dict, prefix: str):
+    parts = prefix.split(".")
+    for part in parts:
+        if isinstance(tree, dict) and part in tree:
+            tree = tree[part]
+        else:
+            return {}  # Prefix not found
+    return tree
+
+
+def init_default_dev_configs(configs_parent, base_file_stem, base_file_ext=".yml"):
+    _dict = {t: str(configs_parent / ("-".join([base_file_stem, t]) + base_file_ext)) for t in ["stg", "dev", "prd"]}
+    _dict[""] = str(configs_parent / base_file_stem) + base_file_ext
+    return _dict
+
+
+def load_and_merge_configs(config_path, configs, prefix=""):
+        try:
+            with open(config_path, "rt") as f:
+                cfgs = yaml.safe_load(f)
+            tmp = create_prefixed_tree(cfgs, prefix)
+            configs = merge_dictionaries(configs, tmp)
+        except:
+            pass 
+        return configs
+
+def get_target_frame(num_back=2):
+    target_frame = inspect.currentframe()
+    for _ in range(num_back + 1):  # +1 to account for the function itself
+        if target_frame is None:
+            break
+        target_frame = target_frame.f_back 
+    return target_frame
+
+def get_imported_modules_and_funcs(num_back=2):
+    target_frame = get_target_frame(num_back)
+
+    if target_frame is None:
+        return {}  # Return an empty dictionary if the frame is not found
+
+    # Retrieve the target frame's local variables.
+    mods_and_funcs = {k: v for k, v in target_frame.f_globals.items() if callable(v) or inspect.ismodule(v)} 
+
+    return mods_and_funcs
+    # mods_and_funs = {k: v for k, v in globals().items() if callable(v) or inspect.ismodule(v)}
+    # return mods_and_funs
+
+def get_subs(module):
+    def _is_interest(v):
+        return (inspect.ismodule(v) and inspect.getmodule(v) is module) or \
+            ((inspect.isfunction(v) or inspect.ismethod(v)) and inspect.getmodule(v) is module)
+    return {n: v for n, v in vars(module).items() if _is_interest(v)}
+
+class Stack:
+    def __init__(self):
+        self._items = []
+
+    def __len__(self):
+        return len(self._items)
+
+    def is_empty(self):
+        return len(self._items) == 0
+
+    def pop(self):
+        if self.is_empty():
+            raise IndexError("Cannot pop from an empty stack")
+        return self._items.pop()
+
+    def push(self, item):
+        self._items.append(item)
+
+    def peek(self):
+        if self.is_empty():
+            return None
+        return self._items[-1]

pyconject-0.1.0/src/pyconject.egg-info/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: pyconject
+Version: 0.1.0
+Summary: pyconject --- a highly opinionated PYthon CONfig inJECTor library.
+Author-email: "Edward L." <neolaw+pyconject@gmail.com>
+Project-URL: Homepage, https://github.com/neolaw84/pyconject
+Project-URL: Issues, https://github.com/neolaw84/pyconject/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# pyconject
+
+`pyconject` is a (highly) opinionated PYthon CONfig inJECTor library inspired by Spring Framework (and Spring Boot Framework).
+
+> **How to pronounce `pyconject`**
+> 
+> `pyconject` is pronounced PY-CON-JECT, a word play for Burmese "ပိုက်ကွန်ချက်" = "the art of throwing net". It represents how it can be used to capture all types of configs and inject them into all types of packages.
+
+# Usage
+
+For detailed usage, refer to [usage.md](usage.md).
+
+## TL;DR
+
+Instead of this: 
+
+```python
+# in usr_p/usr_sp/usr_m.py
+from black_p.black_sp.black_m import black_func
+
+# initialize values_a, value_b, 
+# value_c and value_d.
+# this part is often the ugly mess
+# because it involves reading yaml 
+# or other tree-like files and 
+# assigning values
+import yaml
+with open("./configs.yml", "rt") as f:
+  configs = yaml.safe_load(f)
+  black_func_parameters = configs["black_p"]["black_sp"]["black_m"]["black_func"]
+  value_a = black_func_parameters["a"]
+  # more ugly things here; you get the gist ...
+
+black_func(a=value_a, b=value_b, c=value_c, d=value_d)
+```
+
+With `pyconject`, we can do this:
+
+
+```python
+# in usr_p/usr_sp/usr_m.py
+from black_p.black_sp.black_m import black_func
+
+# pyconject initializes values of a, b, c and d.
+from pyconject import pyconject
+
+pyconject.init(globals())
+
+with pyconject.cntx():
+    black_func() 
+```
+
+## Developing with `pyconject`
+
+Instead of this:
+
+```python
+# in dev_p/dev_sp/dev_m.py
+import os
+
+env = os.environ["environment"]
+
+def dev_func(a=None, b=None, c=None, d=None):
+  if env == "dev":
+    if a is None: a = "dev-a"
+    if b is None: b = "dev-b"
+    # you know the rest
+  elif env == "stg":
+    if a is None: a = "stg-a"
+    if b is None: b = "stg-b"
+    # you know the rest
+  elif env == "prd":
+    if a is None: a = "prd-a"
+    if b is None: b = "prd-b"
+    # you know the rest
+  # ... 
+  # your application logic
+  return results
+```
+
+With `pyconject`, you can do this:
+
+```yaml
+# in dev_p/dev_sp/pyconject-dev_m-dev.py
+dev_func:
+  a : "dev-a"
+  b : "dev_b"
+  ...
+```
+
+```python
+# in dev_p/dev_sp/dev_m.py
+from pyconject import pyconject
+
+@pyconject.func
+def dev_func(a, b, c, d):
+  # your application logic
+  return results
+```
+
+# To dos
+
+* Developer integration
+  * ~~Functions~~ done
+  * Singletons/Classes
+  * ~~Modules~~ done
+  * ~~Packages~~ done
+  
+* Client integration
+  * ~~Functions~~ done
+  * Singletons/Classes
+  * ~~Modules~~
+  * ~~Packages~~
+  * ~~Auto-detect when cntx open~~ use `pyconject.init(globals())` instead
+
+* Generate config files
+
+* Raw retrieval of resolved configs (to manipulate by user)
+
+* Type of configs
+  * ~~**yaml -- priority**~~ done
+  * ~~environment/target selection~~ done
+  * .env
+  * overrides
+    * environment variables
+    * commandline arguments
+
+* Documentations
+  * ~~Usage~~ done
+
+* CI/CD
+  * github actions to unittest at push and pull-request
+  * github actions to publish to pypi after merge

pyconject-0.1.0/src/pyconject.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+src/pyconject/__init__.py
+src/pyconject/context.py
+src/pyconject/pyconject.py
+src/pyconject/registry.py
+src/pyconject/utils.py
+src/pyconject.egg-info/PKG-INFO
+src/pyconject.egg-info/SOURCES.txt
+src/pyconject.egg-info/dependency_links.txt
+src/pyconject.egg-info/top_level.txt
+tests/test_client_usages.py
+tests/test_dev_usages.py

pyconject-0.1.0/src/pyconject.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyconject-0.1.0/src/pyconject.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyconject

pyconject-0.1.0/tests/test_client_usages.py

@@ -0,0 +1,108 @@
+import os
+from unittest import TestCase
+from unittest.mock import patch
+import tempfile
+from pathlib import Path
+import yaml
+
+from pyconject import pyconject
+
+from unittest_utils import get_dynamic_mock_open, remove_file_or_directory
+from black_p.black_sp.black_m import black_func
+from dev_p.dev_sp.dev_m import dev_func_m
+
+class ClientUsageTest(TestCase):
+
+    def setUp(self):
+        self.configs = yaml.dump({
+            "black_p": {
+                "black_sp": {
+                    "black_m": {
+                        "black_func": {
+                            "b": "clt-defined-in-configs-b",
+                            "c": "clt-defined-in-configs-c"
+                        }
+                    }
+                }
+            }
+        })
+        self.configs_dev = yaml.dump({
+            "black_p": {
+                "black_sp": {
+                    "black_m": {
+                        "black_func": {
+                            "c": "clt-defined-in-configs-dev-c"
+                        }
+                    }
+                }
+            }
+        })
+        with open("tests/cfgs.yml", "wt") as f:
+            yaml.safe_dump({
+                "dev_p": {
+                    "dev_sp": {
+                        "dev_m": {
+                            "dev_func_m": {
+                                "a": "a1"
+                            }
+                        }
+                    }
+                }
+            }, f)
+
+    def tearDown(self) -> None:
+        remove_file_or_directory(Path("tests/cfgs.yml"))
+        return super().tearDown()
+
+    def test_vanilla(self):
+        with self.assertRaises(TypeError):
+            black_func()
+
+        a, b, c, d = black_func(1, 2, 3)
+        assert (a, b, c, d) == (1, 2, 3, "dev-default-in-func-definion")
+
+    def test_cntx_default(self):
+        with patch("builtins.open", get_dynamic_mock_open({
+            (Path("./configs.yml"), "rt") : self.configs,
+            (Path("./configs-dev.yml"), "rt") : self.configs_dev
+        })):
+            pyconject.init(globals())
+            with pyconject.cntx():
+                a, b, c, d = black_func(1, 2)
+                assert (a, b, c, d) == (1, 2, "clt-defined-in-configs-c", "dev-default-in-func-definion")
+        
+    def test_cntx_target_dev(self):
+        with patch("builtins.open", get_dynamic_mock_open({
+            (Path("./configs.yml"), "rt") : self.configs,
+            (Path("./configs-dev.yml"), "rt") : self.configs_dev
+        })):
+            pyconject.init(globals())
+            with pyconject.cntx(target="dev"):
+                a, b, c, d = black_func(1, 2)
+                assert (a, b, c, d) == (1, 2, "clt-defined-in-configs-dev-c", "dev-default-in-func-definion")
+
+    def test_cntx_custom_cfg_files(self):
+        with patch("builtins.open", get_dynamic_mock_open({
+            (Path("./cfgs.yml"), "rt") : self.configs,
+            (Path("./cfgs-dev.yml"), "rt") : self.configs_dev
+        })):
+            pyconject.init(globals())
+            with pyconject.cntx(config_path="cfgs.yml"):
+                a, b, c, d = black_func(1, 2)
+                assert (a, b, c, d) == (1, 2, "clt-defined-in-configs-c", "dev-default-in-func-definion")
+
+    def test_cntx_custom_cfg_files_target_dev(self):
+        with patch("builtins.open", get_dynamic_mock_open({
+            (Path("./cfgs.yml"), "rt") : self.configs,
+            (Path("./cfgs-dev.yml"), "rt") : self.configs_dev
+        })):
+            pyconject.init(globals())
+            with pyconject.cntx(config_path="cfgs.yml", target="dev"):
+                a, b, c, d = black_func(1, 2)
+                assert (a, b, c, d) == (1, 2, "clt-defined-in-configs-dev-c", "dev-default-in-func-definion")
+            
+    def test_cntx_default_m_func(self):
+        pyconject.init(globals())
+        with pyconject.cntx(config_path="tests/cfgs.yml"):
+            a, b, c, d = dev_func_m()
+            assert (a, b, c, d) == ("a1", 20002, 3003, 404)

pyconject-0.1.0/tests/test_dev_usages.py

@@ -0,0 +1,84 @@
+import os
+from unittest import TestCase
+from unittest.mock import patch
+import tempfile
+from pathlib import Path
+import yaml
+
+# import pyconject as root_pyconject
+from pyconject import pyconject
+
+from unittest_utils import get_dynamic_mock_open
+from dev_p.dev_sp.dev_m import dev_func, dev_func_sp, dev_func_m, dev_func_sp_custom, dev_func_sp_custom2
+
+class DevUsageTest(TestCase):
+
+    def test_vanilla(self):
+        with self.assertRaises(TypeError):
+            dev_func()
+
+        a, b, c, d = dev_func(1, 2, 3)
+        assert (a, b, c, d) == (1, 2, 3, "dev-default-in-func-definion")
+
+    def test_cntx_default(self):
+        pyconject.init(globals())
+        with pyconject.cntx():
+            a, b, c, d = dev_func(1, 2)
+            assert (a, b, c, d) == (1, 2, 303, 404)
+
+    def test_cntx_target_dev(self):
+        pyconject.init(globals())
+        with pyconject.cntx(target="dev"):
+            a, b, c, d = dev_func(1, 2)
+            assert (a, b, c, d) == (1, 2, 303, "404-dev")
+
+    def test_cntx_default_sp(self):
+        pyconject.init(globals())
+        with pyconject.cntx():
+            a, b, c, d = dev_func_sp(1, 2)
+            assert (a, b, c, d) == (1, 2, 3003, 404)
+
+    def test_cntx_target_dev_sp(self):
+        pyconject.init(globals())
+        with pyconject.cntx(target="dev"):
+            a, b, c, d = dev_func_sp(1)
+            assert (a, b, c, d) == (1, 2002, "3003-dev", "404-dev")
+
+    def test_cntx_default_m_func(self):
+        pyconject.init(globals())
+        with pyconject.cntx():
+            a, b, c, d = dev_func_m()
+            assert (a, b, c, d) == (100001, 20002, 3003, 404)
+
+    def test_cntx_default_m_func_custom(self):
+        pyconject.init(globals())
+        with pyconject.cntx():
+            a, b, c, d = dev_func_sp_custom()
+            assert (a, b, c, d) == (11, 22, "c", "d")
+
+    def test_cntx_default_m_func_custom2(self):
+        pyconject.init(globals())
+        with pyconject.cntx(target="dev"):
+            a, b, c, d = dev_func_sp_custom2()
+            assert (a, b, c, d) == (111, 22, "cc", "dd")
+
+    # def test_cntx_custom_cfg_files(self):
+    #     with patch("builtins.open", get_dynamic_mock_open({
+    #         (Path("./cfgs.yml"), "rt") : self.configs,
+    #         (Path("./cfgs-dev.yml"), "rt") : self.configs_dev
+    #     })):
+    #         pyconject.init(globals())
+    #         with pyconject.cntx(config_path="cfgs.yml"):
+    #             a, b, c, d = dev_func(1, 2)
+    #             assert (a, b, c, d) == (1, 2, "clt-defined-in-configs-c", "dev-default-in-func-definion")
+
+    # def test_cntx_custom_cfg_files_target_dev(self):
+    #     with patch("builtins.open", get_dynamic_mock_open({
+    #         (Path("./cfgs.yml"), "rt") : self.configs,
+    #         (Path("./cfgs-dev.yml"), "rt") : self.configs_dev
+    #     })):
+    #         pyconject.init(globals())
+    #         with pyconject.cntx(config_path="cfgs.yml", target="dev"):
+    #             a, b, c, d = dev_func(1, 2)
+    #             assert (a, b, c, d) == (1, 2, "clt-defined-in-configs-dev-c", "dev-default-in-func-definion")
+