memorymanagement 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

memorymanagement/cleaning/__init__.py

@@ -1,2 +1,41 @@
+"""
+# Module `cleaning`
+Implements the class `Cleaner` to keep track of the references and erase it easily.
+## Overview
+Initialize a `Cleaner` object:
+```
+# Default arguments' values
+cleaner=Cleaner(
+    not_delete:list[str]=list(vars(modules["main"])), # List of global variables at that moment (modules comes from sys library)
+    excluded:list[str]=[], # Empty list to be modified later if you need
+    flagged:list[str]=[] # List of references to undo
+)
+```
+Now `cleaner` has the following attributes:
+```
+cleaner._not_delete=list(vars(modules["main"])) # At initialization moment
+cleaner._excluded=[] # Wasn't asked to exclude any reference.
+cleaner._flagged=[] # Wasn't asked to include any reference.
+```
+To automatically include all the new references, use the `.update()` method:
+```
+x=10
+y="Hello world"
+z=f"Hello Python for time number {x}"
+# Default arguments' values
+cleaner.update(
+    exclude:str|list[str]|tuple[str]|None=None, # Excludes flagged or yet not created references from the process
+    include:str|list[str]|tuple[str]|None=None # Includes references into the process
+)
+print(cleaner)
+```
+The cell above prints (via `__str__` method):
+```
+Flagged: ["x","y","z"]
+
+Excluded: []
+
+Not delete: <list(vars(modules["main"]))> # Unchanged since initialization
+"""
 # Imports
-from .cleaning import Cleaner
+from .core import Cleaner

memorymanagement/cleaning/{cleaning.py → core.py}

@@ -128,4 +128,15 @@ class Cleaner:
             if var in list(vars(modules["__main__"])):
                 del vars(modules["__main__"])[var]
         self._flagged.clear()
-        return
+        return
+    def __str__(self):
+        string=f"""
+        Flagged: {self.flagged}
+        
+        Excluded: {self.excluded}
+        
+        Not delete: {self.not_delete}
+        """
+        return string
+    def __repr__(self):
+        return f"{self.__class__.__name__}(flagged={self.flagged})"

memorymanagement/pointers/__init__.py

@@ -1,3 +1,15 @@
+"""
+# Module `pointers`
+A safe implementation of pointers written in pure Python.
+
+It is safe beacause it doesn't imitate the internal behaviour of C pointers because it could break the memory.
+It only replicates the visible effects and behaviour of C pointers.
+## Class `Pointer`
+This is the core of the module. The class `Pointer` points to a specific reference,
+which will be syncrhonized with the pointer's value since the moment of the pointer's creation.
+## Decorator `pointerize`
+This decorator makes any function able to receive `Pointer` objects instead of the originally expected.
+"""
 # Import from modules
 from .core import Pointer # Class "Pointer"
 from .decorators import pointerize # Decorator "pointerize"

memorymanagement/pointers/core.py

@@ -124,4 +124,16 @@ class Pointer(Generic[object_type]):
             del self._value
             if self._name:
                 del self._vars_dict[self._name]
-        return
+        return
+    def __getitem__(self,index):
+        return self.value[index]
+    def __setitem__(self,index,value):
+        self.value[index]=value
+        return
+    def __delitem__(self,index):
+        del self.value[index]
+        return
+    def __str__(self):
+        return str(self.value)
+    def __repr__(self):
+        return f"{self.__class__.__name__}({self.value})"

{memorymanagement-1.0.0.dist-info → memorymanagement-1.1.0.dist-info}/METADATA

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: memorymanagement
-Version: 1.0.0
+Version: 1.1.0
 Summary: Adds support for memory management
-Home-page: https://github.com/Ricardo-Werner-Rivas/python-memory-management/tree/main
+Home-page: https://github.com/Ricardo-Werner-Rivas/python-memory-management/tree/PyPI
 Author: Ricardo Werner Rivas
 Author-email: ricardowernerrivas@gmail.com
 License: MIT
-Project-URL: Issues Page, https://github.com/Ricardo-Werner-Rivas/python-memory-management/issues
+Project-URL: Bug Tracker, https://github.com/Ricardo-Werner-Rivas/python-memory-management/issues
 Project-URL: Repository, https://github.com/Ricardo-Werner-Rivas/python-memory-management
 Classifier: Programming Language :: Python
 Classifier: Operating System :: Microsoft :: Windows
@@ -16,6 +16,9 @@ Dynamic: license-file
 
 # `memorymanagement`
 Provides memory management support.
+
+The only Python implementation currently supported is the one made by the **CPython** team.
+The rest remain untested.
 ## Modules
 ### `cleaning`
 Provides the class `Cleaner`, which allows you to flag references stored in memory to eventually erase them.
@@ -27,15 +30,10 @@ The pointer itself. Imitates the behaviour of C pointers. This pointer points to
 #### Decorator `pointerize`
 Allows functions to receive pointers instead of values.
 ## Installation
-You can install the `memorymanager` package from PyPI as follows:
-```bash
+You can install the `memorymanagement` package from PyPI as follows:
+```ps
 pip install memorymanagement
 ```
-You can also install the `memorymanager` package (Test PyPI versión of `memorymanager`) from TestPyPI as follows:
-```bash
-pip install --index-url https://test.pypi.org/simple/ memorymanager
-```
-For TestPyPI versión, `--no-deps` option is not needed because it has no dependencies.
 ## How to use
 ### Class `Cleaner`
 ```py
@@ -160,3 +158,11 @@ Value: 10
 Value: 20
 
 ```
+## Contribution
+To contribute to this project, clone or fork this repository.
+
+There are to branches:
+* PyPI: the main branch, for releases.
+* TestPyPI: for pre-releases or development versions.
+
+Pull requests from TestPyPI to PyPI will be accepted when a new release is finished.

memorymanagement-1.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+memorymanagement/__init__.py,sha256=Clyt9uUH0DZW36BdmWCMYNg4R2uLYYsSdsn1UgeLSJs,816
+memorymanagement/cleaning/__init__.py,sha256=zC6dWTCTP6b-E3_Q7L45i2ZK_5DrVBbjzKT2AFuXdJk,1359
+memorymanagement/cleaning/core.py,sha256=ya_mxI9gJDmq3zR7Y6Dw8aPQOBkMLVDNECT4X6bCke4,6539
+memorymanagement/pointers/__init__.py,sha256=MmQnt8KtC2GTHuc-JIypjeyc_iWHJsQTvQdwZPilF34,734
+memorymanagement/pointers/core.py,sha256=uZqQYFwevU_lfOhjcA-2L4DQWFmkxgRQgQmafsI07FA,6611
+memorymanagement/pointers/decorators.py,sha256=NDMlexU6s123jPU0Tqny8HkMdtPsfwrzVAgjCAYpy4A,2869
+memorymanagement-1.1.0.dist-info/licenses/LICENSE,sha256=oomqnX6WpwczxhGg1lDAUrS13YL-0NFIpomyReHWgKo,1098
+memorymanagement-1.1.0.dist-info/METADATA,sha256=1LlTWZ4bqUBROGKh8OUfR6rGVeHwsfH3sw7eP5YqAuQ,4104
+memorymanagement-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+memorymanagement-1.1.0.dist-info/top_level.txt,sha256=7SwrpC3BY9Cm6sqwu082DJE5SteRBira0LGqziTO7eQ,17
+memorymanagement-1.1.0.dist-info/RECORD,,

{memorymanagement-1.0.0.dist-info → memorymanagement-1.1.0.dist-info}/licenses/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Ricardo Werner Rivas
-
-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.
+MIT License
+
+Copyright (c) 2025 Ricardo Werner Rivas
+
+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.

memorymanagement-1.0.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-memorymanagement/__init__.py,sha256=Clyt9uUH0DZW36BdmWCMYNg4R2uLYYsSdsn1UgeLSJs,816
-memorymanagement/cleaning/__init__.py,sha256=YnrtCkREJ01-FOGURPYQmlpWGT9TtreG40z5X0-WYJY,40
-memorymanagement/cleaning/cleaning.py,sha256=FjwfFw5nv-zGt2UdRTUE9NNaHs8ZXsIaMsXwEm4hye8,6237
-memorymanagement/pointers/__init__.py,sha256=mSC1rCofRafPigcndKzYncHT2KYV5NNjtOj0ixlLfjw,127
-memorymanagement/pointers/core.py,sha256=f9FBOCUX-_lCI-zgt2J7tUJb3JdkkECcYwpdXRHAFz0,6233
-memorymanagement/pointers/decorators.py,sha256=NDMlexU6s123jPU0Tqny8HkMdtPsfwrzVAgjCAYpy4A,2869
-memorymanagement-1.0.0.dist-info/licenses/LICENSE,sha256=YbbIWfIjYfz9q2bm60jGAfdvdIqD96jDLvz16YsFOOk,1077
-memorymanagement-1.0.0.dist-info/METADATA,sha256=HdZOYIds5L5rqrhEJ0sGTixBKunUWS4jrirbM74S0sA,3980
-memorymanagement-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-memorymanagement-1.0.0.dist-info/top_level.txt,sha256=7SwrpC3BY9Cm6sqwu082DJE5SteRBira0LGqziTO7eQ,17
-memorymanagement-1.0.0.dist-info/RECORD,,