underpyx 0.1.0__tar.gz

underpyx-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ariana Maghsoudi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

underpyx-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-exclude tests *

underpyx-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: underpyx
+Version: 0.1.0
+Summary: Fundamental utilities in python, such as encapsulation, immutability, service patterns, and JSON typing in Python.
+Author-email: Ariana Maghsoudi <ariana.maghsoudi82@gmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: assertpy; extra == "dev"
+Dynamic: license-file
+
+# underpy 🐍
+
+**Reusable Python base classes for clean, maintainable, and scalable projects.**  
+Underpy provides foundational building blocks such as encapsulated data, immutable objects, service patterns, and JSON typing — so you can start every new project with a solid, consistent architecture.
+
+---
+
+## ✨ Features
+
+- **Encapsulated** – Hide internals and expose clean public APIs
+- **Immutable** – Prevent changes to objects after initialization
+- **Service Class (Singleton)** – Enforce a single point of access for core services
+- **JSON Type** – Typed JSON data handling made easy
+- **Tested with Pytest + AssertPy** – Reliable and expressive tests
+
+---
+
+## 📦 Installation
+
+Install from source (local development):
+
+```bash
+pip install git+https://github.com/ariana126/underpy.git
+```
+
+---
+
+## 🚀 Quick Start
+
+### Example: Encapsulated
+```python
+from underpy import Encapsulated
+
+class User(Encapsulated):
+    def __init__(self, username):
+        self._username = username
+
+    def get_username(self):
+        return self._username
+
+user = User("ariana")
+print(user.get_username())  # ✅ "ariana"
+# Direct access is avoided: user._username
+```
+
+---
+
+### Example: Immutable
+```python
+from underpy import Immutable
+
+class Config(Immutable):
+    def __init__(self, host, port):
+        self.host = host
+        self.port = port
+
+cfg = Config("localhost", 8080)
+# cfg.port = 9000  # ❌ Raises AttributeError
+```
+
+---
+
+## 🧪 Running Tests
+
+```bash
+pytest
+```
+
+---
+
+## 📄 License
+This project is licensed under the **MIT License** – see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 🤝 Contributing
+Contributions are welcome!  
+If you have an improvement or find a bug:
+1. Fork the repo
+2. Create your branch
+3. Submit a pull request
+
+---
+
+## 💡 About
+This project is part of a personal utility toolkit used to maintain a consistent, clean architecture across Python projects.  
+Originally authored by [Ariana](https://github.com/ariana126).
+EOF

underpyx-0.1.0/README.md

@@ -0,0 +1,88 @@
+# underpy 🐍
+
+**Reusable Python base classes for clean, maintainable, and scalable projects.**  
+Underpy provides foundational building blocks such as encapsulated data, immutable objects, service patterns, and JSON typing — so you can start every new project with a solid, consistent architecture.
+
+---
+
+## ✨ Features
+
+- **Encapsulated** – Hide internals and expose clean public APIs
+- **Immutable** – Prevent changes to objects after initialization
+- **Service Class (Singleton)** – Enforce a single point of access for core services
+- **JSON Type** – Typed JSON data handling made easy
+- **Tested with Pytest + AssertPy** – Reliable and expressive tests
+
+---
+
+## 📦 Installation
+
+Install from source (local development):
+
+```bash
+pip install git+https://github.com/ariana126/underpy.git
+```
+
+---
+
+## 🚀 Quick Start
+
+### Example: Encapsulated
+```python
+from underpy import Encapsulated
+
+class User(Encapsulated):
+    def __init__(self, username):
+        self._username = username
+
+    def get_username(self):
+        return self._username
+
+user = User("ariana")
+print(user.get_username())  # ✅ "ariana"
+# Direct access is avoided: user._username
+```
+
+---
+
+### Example: Immutable
+```python
+from underpy import Immutable
+
+class Config(Immutable):
+    def __init__(self, host, port):
+        self.host = host
+        self.port = port
+
+cfg = Config("localhost", 8080)
+# cfg.port = 9000  # ❌ Raises AttributeError
+```
+
+---
+
+## 🧪 Running Tests
+
+```bash
+pytest
+```
+
+---
+
+## 📄 License
+This project is licensed under the **MIT License** – see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 🤝 Contributing
+Contributions are welcome!  
+If you have an improvement or find a bug:
+1. Fork the repo
+2. Create your branch
+3. Submit a pull request
+
+---
+
+## 💡 About
+This project is part of a personal utility toolkit used to maintain a consistent, clean architecture across Python projects.  
+Originally authored by [Ariana](https://github.com/ariana126).
+EOF

underpyx-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "twine"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "underpyx"
+version = "0.1.0"
+description = "Fundamental utilities in python, such as encapsulation, immutability, service patterns, and JSON typing in Python."
+authors = [
+    { name = "Ariana Maghsoudi", email = "ariana.maghsoudi82@gmail.com" }
+]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest", "assertpy"]
+
+[tool.setuptools.packages.find]
+include = ["underpy*"]
+exclude = ["tests*"]

underpyx-0.1.0/setup.cfg

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

underpyx-0.1.0/underpy/__init__.py

@@ -0,0 +1,6 @@
+from .encapsulation import Encapsulated
+from .mutability import Immutable
+from .service import ServiceClass
+from .typing import JSON
+
+__all__ = ["Encapsulated", "Immutable", "ServiceClass", "JSON"]

underpyx-0.1.0/underpy/encapsulation.py

@@ -0,0 +1,75 @@
+import inspect
+from abc import ABC
+
+# TODO: Make _check_ functions and _initialized private.
+
+class Encapsulated(ABC):
+    def __getattribute__(self, name):
+        # Skip internal attributes and methods to avoid recursion
+        if (name.startswith('_Encapsulated__') or
+                name.startswith('_check_') or
+                name in ('_initialized', '__dict__', '__class__')):
+            return object.__getattribute__(self, name)
+
+        # Handle encapsulation
+        if name.startswith('__') and not name.endswith('__'):
+            # Private attribute
+            if not self._check_private_access(name):
+                raise AttributeError(f"Cannot access private attribute {name}")
+        elif name.startswith('_') and not name.startswith('__'):
+            # Protected attribute
+            if not self._check_protected_access(name):
+                raise AttributeError(f"Cannot access protected attribute {name}")
+
+        return object.__getattribute__(self, name)
+
+    def __setattr__(self, name, value):
+        # Handle encapsulation checks first
+        if hasattr(self, '_initialized'):  # Only check after initialization
+            if name.startswith('__') and not name.endswith('__'):
+                # Private attribute - check access
+                if not self._check_private_access(name):
+                    raise AttributeError(f"Cannot access private attribute {name}")
+            elif name.startswith('_') and not name.startswith('__'):
+                # Protected attribute - check access
+                if not self._check_protected_access(name):
+                    raise AttributeError(f"Cannot access protected attribute {name}")
+
+        # Call parent's __setattr__ (cooperative inheritance)
+        super().__setattr__(name, value)
+
+    def _check_private_access(self, name):
+        """Check if private attribute access is allowed"""
+        try:
+            frame = inspect.currentframe().f_back.f_back
+            caller_locals = frame.f_locals
+            caller_class = None
+
+            if 'self' in caller_locals:
+                caller_class = caller_locals['self'].__class__
+            elif 'cls' in caller_locals:
+                caller_class = caller_locals['cls']
+
+            # Private access only allowed from exact same class
+            return caller_class is self.__class__
+        except:
+            return False
+
+    def _check_protected_access(self, name):
+        """Check if protected attribute access is allowed"""
+        try:
+            frame = inspect.currentframe().f_back.f_back
+            caller_locals = frame.f_locals
+            caller_class = None
+
+            if 'self' in caller_locals:
+                caller_class = caller_locals['self'].__class__
+            elif 'cls' in caller_locals:
+                caller_class = caller_locals['cls']
+
+            # Protected access allowed from same class or subclasses
+            return (caller_class is self.__class__ or
+                    (caller_class and issubclass(caller_class, self.__class__)) or
+                    (caller_class and issubclass(self.__class__, caller_class)))
+        except:
+            return False

underpyx-0.1.0/underpy/mutability.py

@@ -0,0 +1,20 @@
+from abc import ABC, ABCMeta
+
+# TODO: Make _initialized private.
+
+class ImmutableMeta(ABCMeta):
+    def __call__(cls, *args, **kwargs):
+        instance = super().__call__(*args, **kwargs)
+        instance._initialized = True
+        return instance
+
+class Immutable(ABC, metaclass=ImmutableMeta):
+    def __setattr__(self, name, value):
+        if hasattr(self, '_initialized'):
+            raise AttributeError(f"Cannot modify immutable object")
+        super().__setattr__(name, value)
+
+    def __delattr__(self, name):
+        if hasattr(self, '_initialized'):
+            raise AttributeError(f"Cannot delete from immutable object")
+        super().__delattr__(name)

underpyx-0.1.0/underpy/service.py

@@ -0,0 +1,6 @@
+from abc import ABC
+from underpy import Encapsulated, Immutable
+
+
+class ServiceClass(Encapsulated, Immutable, ABC):
+    pass

underpyx-0.1.0/underpy/typing.py

@@ -0,0 +1,11 @@
+from typing import Union, List, Dict
+
+JSON = Union[
+    str,
+    int,
+    float,
+    bool,
+    None,
+    Dict[str, "JSON"],
+    List["JSON"]
+]

underpyx-0.1.0/underpyx.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: underpyx
+Version: 0.1.0
+Summary: Fundamental utilities in python, such as encapsulation, immutability, service patterns, and JSON typing in Python.
+Author-email: Ariana Maghsoudi <ariana.maghsoudi82@gmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: assertpy; extra == "dev"
+Dynamic: license-file
+
+# underpy 🐍
+
+**Reusable Python base classes for clean, maintainable, and scalable projects.**  
+Underpy provides foundational building blocks such as encapsulated data, immutable objects, service patterns, and JSON typing — so you can start every new project with a solid, consistent architecture.
+
+---
+
+## ✨ Features
+
+- **Encapsulated** – Hide internals and expose clean public APIs
+- **Immutable** – Prevent changes to objects after initialization
+- **Service Class (Singleton)** – Enforce a single point of access for core services
+- **JSON Type** – Typed JSON data handling made easy
+- **Tested with Pytest + AssertPy** – Reliable and expressive tests
+
+---
+
+## 📦 Installation
+
+Install from source (local development):
+
+```bash
+pip install git+https://github.com/ariana126/underpy.git
+```
+
+---
+
+## 🚀 Quick Start
+
+### Example: Encapsulated
+```python
+from underpy import Encapsulated
+
+class User(Encapsulated):
+    def __init__(self, username):
+        self._username = username
+
+    def get_username(self):
+        return self._username
+
+user = User("ariana")
+print(user.get_username())  # ✅ "ariana"
+# Direct access is avoided: user._username
+```
+
+---
+
+### Example: Immutable
+```python
+from underpy import Immutable
+
+class Config(Immutable):
+    def __init__(self, host, port):
+        self.host = host
+        self.port = port
+
+cfg = Config("localhost", 8080)
+# cfg.port = 9000  # ❌ Raises AttributeError
+```
+
+---
+
+## 🧪 Running Tests
+
+```bash
+pytest
+```
+
+---
+
+## 📄 License
+This project is licensed under the **MIT License** – see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 🤝 Contributing
+Contributions are welcome!  
+If you have an improvement or find a bug:
+1. Fork the repo
+2. Create your branch
+3. Submit a pull request
+
+---
+
+## 💡 About
+This project is part of a personal utility toolkit used to maintain a consistent, clean architecture across Python projects.  
+Originally authored by [Ariana](https://github.com/ariana126).
+EOF

underpyx-0.1.0/underpyx.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+underpy/__init__.py
+underpy/encapsulation.py
+underpy/mutability.py
+underpy/service.py
+underpy/typing.py
+underpyx.egg-info/PKG-INFO
+underpyx.egg-info/SOURCES.txt
+underpyx.egg-info/dependency_links.txt
+underpyx.egg-info/requires.txt
+underpyx.egg-info/top_level.txt

underpyx-0.1.0/underpyx.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

underpyx-0.1.0/underpyx.egg-info/requires.txt

@@ -0,0 +1,4 @@
+
+[dev]
+pytest
+assertpy

underpyx-0.1.0/underpyx.egg-info/top_level.txt

@@ -0,0 +1 @@
+underpy