Update

file:
(Add param<is_auto_create> & param<is_occupy> to class<File> constructor, support setting whether to automatically create the file if it does not exist and enable file lock.
Get file attribute information from property:dict<info> instead of each individual property.
Add method<create> to class<File>),
doc,
__init__:Add var<__all__>.

Author: leoweyr

README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/pypi/l/easierfile.svg)](https://github.com/leoweyr/Python-Easierfile/blob/main/LICENSE)
 [![Downloads](https://static.pepy.tech/personalized-badge/easierfile?period=total&units=international_system&left_color=grey&right_color=green&left_text=pypi%20downloads)](https://pepy.tech/project/easierfile)
 
-A simple Python package that object-oriented encapsulates Python traditional built-in file operations. It's also easier than `easygui`. o((>ω< ))o
+An easier-to-use Python package that object-oriented encapsulates Python traditional built-in file operations. It's also easier than `easygui`. o((>ω< ))o
 
 ## ⚖️License
 

doc/API reference.md

@@ -3,45 +3,44 @@
 ### Constructor
 
 ```python
-File(file_path)
+File(file_path, is_auto_create, is_occupy)
 ```
 
-| Parameter | Type   | Default | Description                                                  |
-| --------- | ------ | ------- | ------------------------------------------------------------ |
-| file_path | string |         | The absolute path or relative path of the file. If using a relative path, it must include `.` or `/`. |
+| Parameter      | Type   | Default | Description                                                  |
+| -------------- | ------ | ------- | ------------------------------------------------------------ |
+| file_path      | string |         | The absolute path or relative path of the file.              |
+| is_auto_create | bool   | True    | Whether to automatically create the file if it does not exist. |
+| is_occupy      | bool   | True    | Whether to enable file lock.                                 |
 
 ### Attributes
 
 <table>
     <tr>
-    	<td><code>File.content</code></td>
+    	<td><code>File().content</code></td>
         <td>Return the entire content of the file.</td>
     </tr>
     <tr>
-    	<td><code>File.full_name</code></td>
-        <td>Return the name of the file.</td>
-    </tr>
-    <tr>
-    	<td><code>File.name</code></td>
-        <td>Return the name of the file without the file extension.</td>
-    </tr>
-    <tr>
-    	<td><code>File.ext</code></td>
-        <td>Return the file extension of the file.</td>
+    	<td><code>File().info</code></td>
+        <td>Return a dict of file attribute information.</br>● path: the absolute path of the file</br>● dir_path: the absolute path of the directory where the file is located</br>● full_name: the name of the file</br>● name: the name of the file without file extension</br>● ext: the extension of the file</td>
     </tr>
 </table>
 
 
+
 ### Operation
 
-#### File.rewrite(content)
+#### File().create()
 
-Rewrite the entire content of the file. 
+Create file.
 
-#### File.append(content)
+#### File().delete()
 
-Append content at the end of file content.
+Delete file.
+
+#### File().rewrite(content)
 
-#### File.delete()
+Rewrite the entire content of the file. 
 
-Delete file.
+#### File().append(content)
+
+Append content at the end of file content.

easierfile/__init__.py

@@ -1,3 +1,7 @@
 from .file import (
     File
-)
+)
+
+__all__ = [
+    "File"
+]

easierfile/file.py

@@ -1,50 +1,121 @@
+import sys
+
+# This module's built-in functions about file lock.
+if sys.platform.startswith("win"):  # For Windows.
+    import msvcrt
+
+    def _lock_file(file):
+        msvcrt.locking(file.fileno(), msvcrt.LK_RLCK, 0)
+
+    def _unlock_file(file):
+        msvcrt.locking(file.fileno(), msvcrt.LK_UNLCK, 0)
+
+else:  # For Linux, Unix, MacOS.
+    import fcntl
+
+    def _lock_file(file):
+        fcntl.flock(file.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
+
+    def _unlock_file(file):
+        fcntl.flock(file.fileno(), fcntl.LOCK_UN)
+
+
 import os
 
+
 class File:
-    def __init__(self, file_path):
-        self.__m_file_path = file_path
-        self.__m_file_full_name = os.path.basename(self.__m_file_path)
-        self.__m_file_name, self.__m_file_extension = os.path.splitext(self.__m_file_full_name)
-        self.__m_dir_path = os.path.dirname(self.__m_file_path)
-
-        if os.path.exists(self.__m_dir_path) == False:  # If the directory of the file path does not exist, it will be created.
-            os.mkdir(self.__m_dir_path)
-        try:  # If the file does not exist, it will be created.
-            self.__m_file = open(self.__m_file_path, "x")
-        except FileExistsError:
-            pass  # Indicates that the file exists and no further exception handling is required.
-        else:
-            self.__m_file.close()
+    def __init__(self, file_path, is_auto_create=True, is_occupy=True):
+        # Get static file information.
+        self.__m_info = {}
+        self.__m_info["path"] = os.path.abspath(file_path)
+        self.__m_info["dir_path"] = os.path.dirname(self.__m_info["path"])
+        self.__m_info["full_name"] = os.path.basename(self.__m_info["path"])
+        self.__m_info["name"], self.__m_info["ext"] = os.path.splitext(self.__m_info["full_name"])
+        self.__m_info["ext"] = self.__m_info["ext"].split(".")[-1]  # Format ext of info to remove str<.>.
 
-    @property
-    def content(self):
-        self.__m_file = open(self.__m_file_path, "r")
-        self.__m_content = self.__m_file.read()
-        self.__m_file.close()
-        return self.__m_content
+        self.__m_is_occupy = is_occupy
+        self.__m_is_lock = False  # Initialize file lock state.
 
-    @property
-    def full_name(self):
-        return self.__m_file_full_name
+        if is_auto_create:
+            try:
+                self.create()
+            except FileExistsError:  # Indicates that the file exists and no further exception handling is required.
+                pass
 
-    @property
-    def name(self):
-        return self.__m_file_name
+        if is_occupy and (not self.__m_is_lock):
+            self.__lock(True)
 
-    @property
-    def ext(self):
-        return self.__m_file_extension.split(".")[-1]
+    def __del__(self):
+        # Release file lock.
+        if self.__m_is_lock:
+            try:
+                self.__lock(False)
+            except FileNotFoundError:  # Indicates that the file lock does not exist and no further exception handling is required.
+                pass
+
+    def __lock(self, is_lock):
+        if os.path.isfile(self.__m_info["path"]):
+            if is_lock:
+                self.__m_file = open(self.__m_info["path"], "w")
+                _lock_file(self.__m_file)
+                self.__m_is_lock = is_lock
+            else:
+                _unlock_file(self.__m_file)
+                self.__m_file.close()
+                self.__m_is_lock = not is_lock
+        else:
+            if is_lock:
+                raise FileNotFoundError("File was about to be occupied, but not found: " + self.__m_info["path"])
+            else:
+                raise FileNotFoundError("File was about to be unoccupied, but not found: " + self.__m_info["path"])
+
+    def create(self):
+        if not os.path.isfile(self.__m_info["path"]):
+            if not os.path.exists(self.__m_info["dir_path"]):  # Create the file directory if it doesn't exist, so that code<open()> doesn't throw the exception.
+                os.mkdir(self.__m_info["dir_path"])
+            try:
+                file_temp = open(self.__m_info["path"], "x")
+            except FileExistsError:  # Avoid exception caused by creating corresponding file in other ways during program execution intervals.
+                pass
+            else:
+                file_temp.close()
+            if self.__m_is_occupy:
+                self.__lock(True)
+        else:
+            raise FileExistsError("File exists: " + self.__m_info["path"])
+
+    def delete(self):
+        if self.__m_is_lock:
+            self.__lock(False)
+        if os.path.isfile(self.__m_info["path"]):
+            os.remove(self.__m_info["path"])
 
     def rewrite(self,content):
-        self.__m_file = open(self.__m_file_path, "w")
-        self.__m_file.write(content)
-        self.__m_file.close()
+        if os.path.isfile(self.__m_info["path"]):
+            file_temp = open(self.__m_info["path"], "w")
+            file_temp.write(content)
+            file_temp.close()
+        else:
+            raise FileNotFoundError("File not found: " + self.__m_info["path"])
 
     def append(self,content):
-        self.__m_file = open(self.__m_file_path, "a")
-        self.__m_file.write(content)
-        self.__m_file.close()
+        if os.path.isfile(self.__m_info["path"]):
+            file_temp = open(self.__m_info["path"], "a")
+            file_temp.write(content)
+            file_temp.close()
+        else:
+            raise FileNotFoundError("File not found: " + self.__m_info["path"])
 
-    def delete(self):
-        if os.path.exists(self.__m_file_path):
-            os.remove(self.__m_file_path)
+    @property
+    def content(self):
+        if os.path.isfile(self.__m_info["path"]):
+            file_temp = open(self.__m_info["path"], "r")
+            content = file_temp.read()
+            file_temp.close()
+            return content
+        else:
+            raise FileNotFoundError("File not found: " + self.__m_info["path"])
+
+    @property
+    def info(self):
+        return self.__m_info

pyproject.toml

@@ -1,13 +1,13 @@
 [tool.poetry]
 name = "easierfile"
-version = "1.1.0"
-description = "A simple Python package that object-oriented encapsulates Python traditional built-in file operations."
+version = "2.0.0"
+description = "An easier-to-use Python package that object-oriented encapsulates Python traditional built-in file operations."
 license = "MIT"
 authors = ["leoweyr <[email protected]>"]
 readme = "README.md"
 repository = "https://github.com/leoweyr/Python-Easierfile"
 classifiers = [
-    "Development Status :: 3 - Alpha"
+    "Development Status :: 4 - Beta"
 ]
 packages = [{include = "easierfile"}]