flockfile 0.2.0__py3-none-any.whl

flockfile/__init__.py

@@ -0,0 +1,66 @@
+import fcntl
+import os
+
+try:
+    from ._version import version as __version__
+except ImportError:  # _version.py is generated by setuptools-scm at build time
+    __version__ = "0.0.0+unknown"
+
+
+class FileNotLocked(Exception):
+    pass
+
+
+class FlockFile:
+    def check_lock(self):
+        """Returns true if locked, false if not"""
+
+        if hasattr(self.lockfd, "read"):
+            # is a file type object, return whether or not it is open
+            return not self.lockfd.closed
+
+        else:
+            return False
+
+    def unlock(self):
+        """unlock and delete the file"""
+
+        self.lockfd.close()
+        self.lockfd = None
+
+        if self.delete_on_unlock:
+            os.remove(self.lock_file)
+
+    def lock(self):
+        """create and lock the file"""
+
+        # if it's a directory, crash
+        if os.path.isdir(self.lock_file):
+            raise RuntimeError("The lock file path is a directory.")
+
+        # touch the file if it doesn't exist.
+        if not os.path.isfile(self.lock_file):
+            open(self.lock_file, "a").close()
+
+        try:
+            self.lockfd = open(self.lock_file, "w")
+            fcntl.flock(self.lockfd, fcntl.LOCK_EX | fcntl.LOCK_NB)
+        except IOError:
+            raise FileNotLocked("Unable to obtain lock on {}".format(self.lock_file))
+
+    def __init__(self, file_name, lock_dir="/tmp", delete_on_unlock=True):
+
+        self.lock_file = os.path.join(lock_dir, file_name)
+        self.lockfd = None
+        self.delete_on_unlock = delete_on_unlock
+
+    def __enter__(self):
+        """acquire the lock on entering a 'with' block"""
+
+        self.lock()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """release the lock on leaving a 'with' block"""
+
+        self.unlock()

flockfile/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.2.0'
+__version_tuple__ = version_tuple = (0, 2, 0)
+
+__commit_id__ = commit_id = 'g9aa2e5e4b'

flockfile-0.2.0.dist-info/METADATA

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: flockfile
+Version: 0.2.0
+Summary: A simple lock file class based on file locking.
+Author-email: Ryan Veach <rveach@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/rveach/flockfile
+Project-URL: Source, https://gitlab.com/rveach/flockfile
+Project-URL: Tracker, https://gitlab.com/rveach/flockfile/issues
+Keywords: Lock,Flock
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# flockfile
+
+Just a simple python lock file class using file locks.
+
+## Installation
+
+```bash
+pip install flockfile
+```
+
+## Usage
+
+```python
+from flockfile import FlockFile, FileNotLocked
+
+# init the class using a file name
+# optionally, the directory can be set to something other than /tmp
+lock = FlockFile("myscriptname", lock_dir="/tmp")
+
+
+# lock the file
+lock.lock()
+# if this is unsuccessful, exception FileNotLocked will be raised.
+
+# the following class method can be used to check lock status
+assert lock.check_lock()
+
+# unlock and delete file
+lock.unlock()
+```
+
+`FlockFile` can also be used as a context manager. The lock is acquired on entry
+(raising `FileNotLocked` if it cannot be obtained) and released on exit:
+
+```python
+from flockfile import FlockFile
+
+with FlockFile("myscriptname", lock_dir="/tmp"):
+    # the lock is held here
+    ...
+# the lock is released and the file deleted here
+```
+
+## Questions or Issues?
+
+Please report as a Gitlab issue: https://gitlab.com/rveach/flockfile/issues
+
+## A note on the use of AI
+
+This library was initally created by hand and uploaded to PyPI in 2019. A lot has changed, so I've used AI to add a context manager and modernize the toolset. All commits using AI have been tagged as such.

flockfile-0.2.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+flockfile/__init__.py,sha256=Oikk0D2HQfFHsdOHR9GOCzUFjHIshRye6hteqD4geqU,1785
+flockfile/_version.py,sha256=BGaan9phX84Hg6IlmJ3DbSotRDOdun6tT3UzeOGU88U,528
+flockfile-0.2.0.dist-info/licenses/LICENSE,sha256=RZFVoVXbutbnAJdDAfcEyGKeztds2UAKMw55D8t3GXo,1067
+flockfile-0.2.0.dist-info/METADATA,sha256=jLzVQnoOYTMBFuZDpq8SjzzjTH_Xbb0H1kflyKEKefI,2162
+flockfile-0.2.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+flockfile-0.2.0.dist-info/scm_file_list.json,sha256=UyFCRzwp0pHNmWsjrOfxu_YX7fJWA2wHGdQr2Sjye1o,237
+flockfile-0.2.0.dist-info/scm_version.json,sha256=fz6CYWSUmv_TkTl1MZURcMwZ3g-K8oYMr5aCqvhb30g,160
+flockfile-0.2.0.dist-info/top_level.txt,sha256=C-TDR3EtjR1bB4ns5cB8sCp4PknEHr5Qs2KXlvaIkB4,10
+flockfile-0.2.0.dist-info/RECORD,,

flockfile-0.2.0.dist-info/WHEEL

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

flockfile-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ryan Veach
+
+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.

flockfile-0.2.0.dist-info/scm_file_list.json

@@ -0,0 +1,14 @@
+{
+  "files": [
+    ".gitignore",
+    ".gitlab-ci.yml",
+    ".pre-commit-config.yaml",
+    "README.md",
+    "CLAUDE.md",
+    "uv.lock",
+    "pyproject.toml",
+    "LICENSE",
+    "tests/test_flockfile.py",
+    "flockfile/__init__.py"
+  ]
+}

flockfile-0.2.0.dist-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.2.0",
+  "distance": 0,
+  "node": "g9aa2e5e4b5df80aebafcd45ef50a390e9d1ceed8",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-07-16"
+}

flockfile-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+flockfile