memorymanagement 1.1.0__tar.gz → 1.1.2__tar.gz

{memorymanagement-1.1.0 → memorymanagement-1.1.2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: memorymanagement
-Version: 1.1.0
+Version: 1.1.2
 Summary: Adds support for memory management
-Home-page: https://github.com/Ricardo-Werner-Rivas/python-memory-management/tree/PyPI
+Home-page: https://github.com/Ricardo-Werner-Rivas/memorymanagement/tree/PyPI
 Author: Ricardo Werner Rivas
 Author-email: ricardowernerrivas@gmail.com
 License: MIT
-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
+Project-URL: Bug Tracker, https://github.com/Ricardo-Werner-Rivas/memorymanagement/issues
+Project-URL: Repository, https://github.com/Ricardo-Werner-Rivas/memorymanagement
 Classifier: Programming Language :: Python
 Classifier: Operating System :: Microsoft :: Windows
 Description-Content-Type: text/markdown
@@ -26,12 +26,12 @@ It is also possible to modify the list of flagged references through its methods
 ### `pointers`
 Provides a safe implementation of pointers for Python.
 #### Class `Pointer`
-The pointer itself. Imitates the behaviour of C pointers. This pointer points to a reference, not to an object stored in memory.
+The pointer itself. Imitates the behaviour of C pointers. `Pointer` points to a **reference**, not to an object stored in memory.
 #### Decorator `pointerize`
 Allows functions to receive pointers instead of values.
 ## Installation
-You can install the `memorymanagement` package from PyPI as follows:
-```ps
+You can install the `memorymanagement` package from **PyPI** as follows:
+```powershell
 pip install memorymanagement
 ```
 ## How to use
@@ -159,10 +159,22 @@ Value: 20
 
 ```
 ## Contribution
-To contribute to this project, clone or fork this repository.
+To contribute to this project fork this repository and clone your fork. Pull requests will be revised by the owner before being accepted or rejected.
 
-There are to branches:
-* PyPI: the main branch, for releases.
-* TestPyPI: for pre-releases or development versions.
+There are two 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.
+Pull requests from TestPyPI to PyPI will only be done by the owner when a new release is ready.
+
+To merge branches properly with PyPI branch in your cloned repository, you will need to have the `.gitattributes` file in the PyPI branch and execute the following commands, while in repo directory, in your PowerShell:
+```powershell
+git config merge.keepPyPIFiles.name "Keep README.md and setup.cfg from PyPI branch on merge"
+git config merge.keepPyPIFiles.driver "bash -c 'cp $(git rev-parse --show-toplevel)/$3 $2'"
+```
+Or in your git bash terminal:
+```bash
+git config merge.keepPyPIFiles.name "Keep README.md and setup.cfg from PyPI branch on merge"
+git config merge.keepPyPIFiles.driver "bash -c 'cp $(git rev-parse --show-toplevel)/$3 $2'"
+```
+This way, READMEs and setup files will not be overwritten in the PyPI branch.

{memorymanagement-1.1.0 → memorymanagement-1.1.2}/README.md

@@ -10,12 +10,12 @@ It is also possible to modify the list of flagged references through its methods
 ### `pointers`
 Provides a safe implementation of pointers for Python.
 #### Class `Pointer`
-The pointer itself. Imitates the behaviour of C pointers. This pointer points to a reference, not to an object stored in memory.
+The pointer itself. Imitates the behaviour of C pointers. `Pointer` points to a **reference**, not to an object stored in memory.
 #### Decorator `pointerize`
 Allows functions to receive pointers instead of values.
 ## Installation
-You can install the `memorymanagement` package from PyPI as follows:
-```ps
+You can install the `memorymanagement` package from **PyPI** as follows:
+```powershell
 pip install memorymanagement
 ```
 ## How to use
@@ -143,10 +143,22 @@ Value: 20
 
 ```
 ## Contribution
-To contribute to this project, clone or fork this repository.
+To contribute to this project fork this repository and clone your fork. Pull requests will be revised by the owner before being accepted or rejected.
 
-There are to branches:
-* PyPI: the main branch, for releases.
-* TestPyPI: for pre-releases or development versions.
+There are two 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.
+Pull requests from TestPyPI to PyPI will only be done by the owner when a new release is ready.
+
+To merge branches properly with PyPI branch in your cloned repository, you will need to have the `.gitattributes` file in the PyPI branch and execute the following commands, while in repo directory, in your PowerShell:
+```powershell
+git config merge.keepPyPIFiles.name "Keep README.md and setup.cfg from PyPI branch on merge"
+git config merge.keepPyPIFiles.driver "bash -c 'cp $(git rev-parse --show-toplevel)/$3 $2'"
+```
+Or in your git bash terminal:
+```bash
+git config merge.keepPyPIFiles.name "Keep README.md and setup.cfg from PyPI branch on merge"
+git config merge.keepPyPIFiles.driver "bash -c 'cp $(git rev-parse --show-toplevel)/$3 $2'"
+```
+This way, READMEs and setup files will not be overwritten in the PyPI branch.

{memorymanagement-1.1.0 → memorymanagement-1.1.2}/memorymanagement/cleaning/core.py

@@ -42,7 +42,7 @@ class Cleaner:
         Returns the list of variables to be erased from memory.
     None of this properties has setter or deleter. Those lists can only be manipulated through the class methods.
     """
-    def __init__(self,not_delete:list[str]=list(vars(modules["__main__"])),excluded:list[str]=[],flagged:list[str]=[]):
+    def __init__(self,not_delete:list[str]|None=None,excluded:list[str]=[],flagged:list[str]=[]):
         """
         Initializes the class instance.\n
         It is recommended to initialize the instance right after all global imports at the beggining of the program so no argument is needed.
@@ -53,13 +53,14 @@ class Cleaner:
             excluded (`list[str]`, Optional): List of variables to be excluded from the memory cleaning process. Empty list by default.
             flagged (`list[str]`, Optional): List of variables to be erased from memory. Empty list by default.
         """
+        if not not_delete:
+            not_delete=list(vars(modules["__main__"]))
         for key,value in vars(modules["__main__"]).copy().items():
             if isinstance(value,Cleaner) and key in vars(modules["__main__"]).keys():
                 del vars(modules["__main__"])[key]
         self._not_delete=not_delete.copy()
         self._excluded=excluded.copy()
         self._flagged=flagged.copy()
-        return
     def update(self,exclude:str|list[str]|tuple[str]|None=None,include:str|list[str]|tuple[str]|None=None):
         """
         Flags all the new global variables' references that were not manually excluded here or before. You can also include previously excluded references.
@@ -82,7 +83,10 @@ class Cleaner:
                 while var in self._excluded:
                     self._excluded.remove(var)
         self._flagged=[var for var in list(vars(modules["__main__"])) if var not in self._not_delete and var not in self._excluded]
-        return
+        for var in self._flagged.copy():
+            if isinstance(vars(modules["__main__"])[var],Cleaner):
+                self._flagged.remove(var)
+                self._not_delete.append(var)
     @property
     def not_delete(self):
         return self._not_delete
@@ -105,7 +109,6 @@ class Cleaner:
                 self._flagged.remove(var)
             if var not in self._excluded:
                 self._excluded.append(var)
-        return
     def include(self,*include:str):
         """
         Allows to include the desired references (previously excluded) in the cleaning process.
@@ -119,7 +122,6 @@ class Cleaner:
                 self._flagged.append(var)
             while var in self._excluded:
                 self._excluded.remove(var)
-        return
     def clean(self):
         """
         Culminates the cleaning process. Erases all the flagged references.
@@ -128,7 +130,6 @@ class Cleaner:
             if var in list(vars(modules["__main__"])):
                 del vars(modules["__main__"])[var]
         self._flagged.clear()
-        return
     def __str__(self):
         string=f"""
         Flagged: {self.flagged}

{memorymanagement-1.1.0 → memorymanagement-1.1.2}/memorymanagement/pointers/core.py

@@ -1,3 +1,17 @@
+#*===============================================================================================================================
+#* LEGEND
+#*-------------------------------------------------------------------------------------------------------------------------------
+#! Missing
+#? Question
+#* Section
+#^ Important
+# Normal comment
+#// Alternative or deprecated code
+#*===============================================================================================================================
+
+#^ The different types of comments require the "Colorful Comments Refreshed" extension for VSCode to be properly distinguished
+
+#* IMPORTS
 # Import "TypeVar" and "Generic"
 from typing import TypeVar,Generic
 # Import "modules" from "sys" package
@@ -5,10 +19,9 @@ from sys import modules
 # Import "currentframe" from "inspect" package
 from inspect import currentframe
 
-# Create new generic type
-object_type=TypeVar("object_type")
-# Define the class "Pointer"
-class Pointer(Generic[object_type]):
+#* MAIN CLASS
+# Define the class "Pointer" with generic type
+class Pointer(Generic[TypeVar("Any")]):
     """
     Implements pointers in Python for both mutable (though unneded) and non-mutable objects.
     These pointers are completely safe and do not work internally as C's pointers, they are just an imitation of their behaviour.
@@ -66,7 +79,6 @@ class Pointer(Generic[object_type]):
         self._value=value
         self._vars_dict=vars_dict
         self._attr=attr
-        name=None
         name=[]
         for key,v in vars_dict.items():
             try:
@@ -90,7 +102,11 @@ class Pointer(Generic[object_type]):
             name=None
         self._name=name
         return
+    
+    #* PROPERTIES
+    # Value
     @property
+    # Getter
     def value(self):
         if self._attr:
             if self._name and self._name not in list(self._vars_dict):
@@ -107,6 +123,7 @@ class Pointer(Generic[object_type]):
                 if self._value is not self._vars_dict[self._name]:
                     self._value=self._vars_dict[self._name]
             return self._value
+    # Setter
     @value.setter
     def value(self,value):
         if self._attr:
@@ -116,6 +133,7 @@ class Pointer(Generic[object_type]):
             if self._name and value is not self._vars_dict[self._name]:
                 self._vars_dict[self._name]=value
         return
+    # Deleter
     @value.deleter
     def value(self):
         if self._attr:
@@ -125,15 +143,186 @@ class Pointer(Generic[object_type]):
             if self._name:
                 del self._vars_dict[self._name]
         return
+    
+    #* INDEXATION
+    # Getter
     def __getitem__(self,index):
         return self.value[index]
+    # Setter
     def __setitem__(self,index,value):
         self.value[index]=value
         return
+    # Deleter
     def __delitem__(self,index):
         del self.value[index]
         return
-    def __str__(self):
-        return str(self.value)
+    
+    #* ARITHMETIC OPERATIONS
+    # Addition
+    def __add__(self,value):
+        if isinstance(value,Pointer):
+            return self.value+value.value
+        else:
+            return self.value+value
+    # Difference
+    def __sub__(self,value):
+        if isinstance(value,Pointer):
+            return self.value-value.value
+        else:
+            return self.value-value
+    # Multiplication
+    def __mul__(self,value):
+        if isinstance(value,Pointer):
+            return self.value*value.value
+        else:
+            return self.value*value
+    # Fraction
+    def __truediv__(self,value):
+        if isinstance(value,Pointer):
+            return self.value/value.value
+        else:
+            return self.value/value
+    # Integer division
+    def __floordiv__(self,value):
+        if isinstance(value,Pointer):
+            return self.value//value.value
+        else:
+            return self.value//value
+    # Module
+    def __mod__(self,value):
+        if isinstance(value,Pointer):
+            return self.value%value.value
+        else:
+            return self.value%value
+    # Power
+    def __pow__(self,value):
+        if isinstance(value,Pointer):
+            return self.value**value.value
+        else:
+            return self.value**value
+    
+    #* REFLEXED ARITHMETIC METHODS
+    # Addition
+    def __radd__(self,value):
+        return value+self.value
+    # Difference
+    def __rsub__(self,value):
+        return value-self.value
+    # Multiplication
+    def __rmul__(self,value):
+        return value*self.value
+    # Fraction
+    def __rtruediv__(self,value):
+        return value/self.value
+    # Integer division
+    def __rfloordiv__(self,value):
+        return value//self.value
+    # Module
+    def __rmod__(self,value):
+        return value%self.value
+    # Power
+    def __rpow__(self,value):
+        return value**self.value
+    
+    #* IN-PLACE ARITHMETIC METHODS
+    # Addition
+    def __iadd__(self,value):
+        self.value=self.value+value
+        return self
+    # Difference
+    def __isub__(self,value):
+        self.value=self.value-value
+        return self
+    # Multiplication
+    def __imul__(self,value):
+        self.value=self.value*value
+        return self
+    # Fraction
+    def __itruediv__(self,value):
+        self.value=self.value/value
+        return self
+    # Integer division
+    def __ifloordiv__(self,value):
+        self.value=self.value//value
+        return self
+    # Module
+    def __imod__(self,value):
+        self.value=self.value%value
+        return self
+    def __ipow__(self,value):
+        self.value=self.value**value
+        return self
+    
+    #* COMPARATIVE METHODS
+    # Equality
+    def __eq__(self,value):
+        if isinstance(value,Pointer):
+            return self.value==value.value
+        else:
+            return self.value==value
+    # Inequality
+    def __ne__(self,value):
+        if isinstance(value,Pointer):
+            return self.value!=value.value
+        else:
+            return self.value!=value
+    # Lower than
+    def __lt__(self,value):
+        if isinstance(value,Pointer):
+            return self.value<value.value
+        else:
+            return self.value<value
+    # Lower or equal
+    def __le__(self,value):
+        if isinstance(value,Pointer):
+            return self.value<=value.value
+        else:
+            return self.value<=value
+    # Greater than
+    def __gt__(self,value):
+        if isinstance(value,Pointer):
+            return self.value>value.value
+        else:
+            return self.value>value
+    # Greater or equal
+    def __ge__(self,value):
+        if isinstance(value,Pointer):
+            return self.value>=value.value
+        else:
+            return self.value>=value
+    
+    #* UNARY METHODS
+    # Negative
+    def __neg__(self):
+        return Pointer(-self.value)
+    # Positive
+    def __pos__(self):
+        return Pointer(+self.value)
+    # Absolute value
+    def __abs__(self):
+        return Pointer(abs(self.value))
+    
+    #* LENGTH
+    # Length
+    def __len__(self):
+        return len(self.value)
+    
+    #* TRANSFORMATION METHODS
+    # __int__
+    def __int__(self):
+        return int(self.value)
+    def __float__(self):
+        return float(self.value)
+    def __index__(self):
+        return self.value
+    
+    #* SCREEN
+    # Representation
     def __repr__(self):
-        return f"{self.__class__.__name__}({self.value})"
+        return f"{self.__class__.__name__}({self.value})"
+    # HTML representation
+    def _repr_html_(self):
+        return f"<p>{self.value}</p>"
+    # Printing
+    def __str__(self):
+        return str(self.value)

{memorymanagement-1.1.0 → memorymanagement-1.1.2}/memorymanagement.egg-info/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: memorymanagement
-Version: 1.1.0
+Version: 1.1.2
 Summary: Adds support for memory management
-Home-page: https://github.com/Ricardo-Werner-Rivas/python-memory-management/tree/PyPI
+Home-page: https://github.com/Ricardo-Werner-Rivas/memorymanagement/tree/PyPI
 Author: Ricardo Werner Rivas
 Author-email: ricardowernerrivas@gmail.com
 License: MIT
-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
+Project-URL: Bug Tracker, https://github.com/Ricardo-Werner-Rivas/memorymanagement/issues
+Project-URL: Repository, https://github.com/Ricardo-Werner-Rivas/memorymanagement
 Classifier: Programming Language :: Python
 Classifier: Operating System :: Microsoft :: Windows
 Description-Content-Type: text/markdown
@@ -26,12 +26,12 @@ It is also possible to modify the list of flagged references through its methods
 ### `pointers`
 Provides a safe implementation of pointers for Python.
 #### Class `Pointer`
-The pointer itself. Imitates the behaviour of C pointers. This pointer points to a reference, not to an object stored in memory.
+The pointer itself. Imitates the behaviour of C pointers. `Pointer` points to a **reference**, not to an object stored in memory.
 #### Decorator `pointerize`
 Allows functions to receive pointers instead of values.
 ## Installation
-You can install the `memorymanagement` package from PyPI as follows:
-```ps
+You can install the `memorymanagement` package from **PyPI** as follows:
+```powershell
 pip install memorymanagement
 ```
 ## How to use
@@ -159,10 +159,22 @@ Value: 20
 
 ```
 ## Contribution
-To contribute to this project, clone or fork this repository.
+To contribute to this project fork this repository and clone your fork. Pull requests will be revised by the owner before being accepted or rejected.
 
-There are to branches:
-* PyPI: the main branch, for releases.
-* TestPyPI: for pre-releases or development versions.
+There are two 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.
+Pull requests from TestPyPI to PyPI will only be done by the owner when a new release is ready.
+
+To merge branches properly with PyPI branch in your cloned repository, you will need to have the `.gitattributes` file in the PyPI branch and execute the following commands, while in repo directory, in your PowerShell:
+```powershell
+git config merge.keepPyPIFiles.name "Keep README.md and setup.cfg from PyPI branch on merge"
+git config merge.keepPyPIFiles.driver "bash -c 'cp $(git rev-parse --show-toplevel)/$3 $2'"
+```
+Or in your git bash terminal:
+```bash
+git config merge.keepPyPIFiles.name "Keep README.md and setup.cfg from PyPI branch on merge"
+git config merge.keepPyPIFiles.driver "bash -c 'cp $(git rev-parse --show-toplevel)/$3 $2'"
+```
+This way, READMEs and setup files will not be overwritten in the PyPI branch.

{memorymanagement-1.1.0 → memorymanagement-1.1.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = memorymanagement
-version = 1.1.0
+version = 1.1.2
 author = Ricardo Werner Rivas
 author_email = ricardowernerrivas@gmail.com
 description = Adds support for memory management
@@ -8,10 +8,10 @@ long_description = file:README.md
 long_description_content_type = text/markdown
 license = MIT
 license_files = LICENSE
-url = https://github.com/Ricardo-Werner-Rivas/python-memory-management/tree/PyPI
+url = https://github.com/Ricardo-Werner-Rivas/memorymanagement/tree/PyPI
 project_urls = 
-	Bug Tracker=https://github.com/Ricardo-Werner-Rivas/python-memory-management/issues
-	Repository=https://github.com/Ricardo-Werner-Rivas/python-memory-management
+	Bug Tracker=https://github.com/Ricardo-Werner-Rivas/memorymanagement/issues
+	Repository=https://github.com/Ricardo-Werner-Rivas/memorymanagement
 classifiers = 
 	Programming Language :: Python
 	Operating System :: Microsoft :: Windows