fileinteract 0.1.0__py3-none-any.whl

fileinteract/__init__.py

@@ -0,0 +1,169 @@
+import os
+import shutil
+
+def Exists(Path: str) -> bool:
+    return os.path.exists(Path)
+
+class File:
+    def __init__(self, Path: str):
+        self.Path = Path
+
+        if not os.path.exists(self.Path):
+            raise FileNotFoundError()
+
+        self.Name      = os.path.basename(self.Path)
+        self.Extension = os.path.splitext(self.Path)[1]
+
+    def GetContent(self, Mode: str = "normal", Encoding: str = "utf-8") -> bytes | str:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        if Mode.lower() == "normal":
+            Mode = "r"
+        elif Mode.lower() == "binary":
+            Mode = "rb"
+        else:
+            raise "Invalid argument : Mode arg must be 'normal" or 'binary'
+
+        with open(self.Path, Mode, encoding=Encoding if Mode == "r" else None) as F:
+            return F.read()
+        
+    def OverWrite(self, Content: str | bytes, Encoding: str = "utf-8") -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "wb" if str(type(Content)) == "<class 'bytes'>" else "w", encoding=Encoding if str(type(Content)) == "<class 'str'>" else None) as F:
+            F.write(Content)
+        
+    def Write(self, Content: str | bytes, Encoding: str = "utf-8") -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "ab" if str(type(Content)) == "<class 'bytes'>" else "a", encoding=Encoding if str(type(Content)) == "<class 'str'>" else None) as F:
+            F.write(Content)
+
+    def Delete(self) -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        os.remove(self.Path)
+    
+    def Copy(self, DistPath: str) -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        shutil.copy(self.Path, DistPath)
+
+    def ClearContent(self):
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "w", encoding='utf-8') as F:
+            F.write('')
+
+    def Move(self, DistPath: str) -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        shutil.copy(self.Path, DistPath)
+        os.remove(self.Path)
+
+    def GetContentLines(self, Encoding: str = 'utf-8') -> list[str]:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "r", encoding=Encoding) as F:
+            return F.readlines()
+        
+    def GetLine(self, Index: int, Encoding: str = "utf-8") -> str | None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "r", encoding=Encoding) as F:
+            ContentLines = F.readlines()
+
+            try:
+                return ContentLines[Index]
+            except IndexError:
+                return None
+        
+    def GetCharsCount(self, Encoding: str = "utf-8") -> int:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "r", encoding=Encoding) as F:
+            return len(F.read())
+
+    def GetLinesCount(self, Encoding: str = "utf-8") -> int:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "r", encoding=Encoding) as F:
+            return len(F.readlines())
+        
+    def GetSize(self) -> int:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        return os.path.getsize(self.Path)
+
+    def Rename(self, NewName: str) -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        os.rename(self.Path, os.path.join(self.Path.replace(self.Name, ""), NewName))
+
+        self.Path      = self.Path.replace(self.Name, NewName)
+        self.Name      = NewName
+        self.Extension = os.path.splitext(self.Path)[1]
+
+    def IsBinary(self) -> bool:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+
+        with open(self.Path, "rb") as F:
+            Chunk = F.read(1024) 
+
+            if b'\x00' in Chunk:
+                return True
+
+            text_chars = bytes(range(32, 127)) + b'\n\r\t\b'
+            NonStr = sum(Byte not in text_chars for Byte in Chunk)
+
+            return NonStr / len(Chunk) > 0.30 if Chunk else False
+
+    def InsertLine(self, Content: str, Index: int, Encoding: str = 'utf-8') -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        Lines = self.GetContentLines()
+
+        try:
+            Lines.insert(Index, Content)
+        except IndexError:
+            raise IndexError()
+        
+        with open(self.Path, "w", encoding=Encoding) as F:
+            F.write(Lines)
+
+    def Replace(self, WhatToReplace: str, ReplaceBy: str, Encoding: str) -> None:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+    
+        FContent = self.GetContent()
+
+        with open(self.Path, "w", encoding=Encoding) as F:
+            F.write(FContent.replace(WhatToReplace, ReplaceBy))
+    
+    def Contain(self, Search: str, Encoding: str = 'utf-8') -> bool:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+        
+        with open(self.Path, "r", encoding=Encoding) as F:
+            return True if Search in F.read() else False
+    
+    def IsEmpty(self) -> bool:
+        if not Exists(self.Path):
+            raise FileNotFoundError()
+    
+        return False if len(self.GetSize()) > 0 else True

fileinteract-0.1.0.dist-info/METADATA

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: fileinteract
+Version: 0.1.0
+Summary: A simple lib to interact with files in Python
+Author-email: Guillaume Plagier <ranswnry@gmail.com>
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file

fileinteract-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+fileinteract/__init__.py,sha256=-DoAu0HqO1P4WYq-1I6Gq1SsmMU3IihR1FNJjFtEdF8,5687
+fileinteract-0.1.0.dist-info/licenses/LICENSE,sha256=Gm9rRWPU7QZqyltsbuqgidGYSe5iChAYRmQni2unDsg,1115
+fileinteract-0.1.0.dist-info/METADATA,sha256=BuAMIqgs1cKRh7WioahyTCeuTN9XRxvtf4kWu5Ku5lA,305
+fileinteract-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fileinteract-0.1.0.dist-info/top_level.txt,sha256=XOKqT2GR0geaqmbANterRXHW8Z_UB3qbLiJXdX72gxE,13
+fileinteract-0.1.0.dist-info/RECORD,,

fileinteract-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fileinteract-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Guillaume Plagier
+
+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.

fileinteract-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fileinteract