Initial commit (v1.0.0)

Author: trinkey

.gitignore

@@ -0,0 +1,3 @@
+*.egg-info/
+dist/
+tests/

LICENSE

@@ -0,0 +1,45 @@
+# Ensure File
+An easy way to manage file creation
+
+Example usage:
+```py
+from ensure_file import ensure_file as ef
+
+# This will create a file in the user directory under the `.example` folder
+# if the file doesn't already exist. If the file does exist, nothing happens.
+# Along with that, it will return true if a file is created, and false if
+# nothing happens. This applies to everything else going forward.
+ef("~/.example/foo.txt")
+
+# Using the `default_value` parameter, you can set the default value to be
+# written to the file. If the file already exists, nothing happens.
+import json
+ef("./bar.json", default_value=json.dumps({
+  "foo": "bar"
+}))
+
+# If you want to create a folder, you can set the `folder` parameter to true.
+ef("/tmp/foo", folder=True)
+
+# If there is already a folder with the same name as a file you want to create,
+# the folder will be deleted and overwritten. This can be disabled by setting
+# the `auto_correct_type` to false. In this function call, nothing would happen
+# because of the folder created on the previous line.
+ef("/tmp/foo", folder=False, auto_correct_type=False)
+
+# If you want to not actually create any files or folders and instead throw an
+# error if a file or folder doesn't exist, you can easily do so by setting the
+# `throw_error` parameter to true. By default, this will also throw an error
+# if the file or folder is the wrong type, such as checking if the file you're
+# checking has the same name as a folder in the same directory. The type
+# checking can be disabled by setting the `throw_check_type` parameter to
+# false.
+try:
+    ef("./some/file.css", folder=False, throw_error=True)
+    print("The file exists!")
+
+except FileNotFoundError:
+    print("The file doesn't exist!")
+except FileExistsError:
+    print("A folder exists where there should be a file!")
+```

README.md

@@ -0,0 +1,9 @@
+# Building
+python3 -m build
+
+# Pushing (requires user input)
+python3 -m twine upload --repository pypi dist/*
+
+# Remove excess files
+rm -r dist/*
+rm -r src/*.egg-info

build.sh

@@ -0,0 +1,18 @@
+[project]
+name = "ensure_file"
+version = "1.0.0"
+authors = [
+  { name="Hazel", email="[email protected]" },
+]
+description = "An easy way to manage file creation."
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/trinkey/ensure-file"
+Issues = "https://github.com/trinkey/ensure-file/issues"

pyproject.toml

@@ -0,0 +1,83 @@
+import os
+
+from typing import Union
+
+def ensure_file(
+    path: Union[str, bytes], *,
+    folder: bool = False,
+    default_value: Union[str, bytes] = b"",
+    auto_correct_type: bool = True,
+    throw_error: bool = False,
+    throw_check_type: bool = True
+) -> bool:
+    '''Creates a file or folder if it doesn't exist.
+
+    path: string - The file/folder path
+    folder: boolean - Whether or not to create a folder instead of a file.
+    default_value: string | bytes - The default value to put into a created file (assuming folder is false).
+    auto_correct_type: boolean - Whether or not to delete the file and recreate it if it is a folder instead of a file or vice versa.
+    throw_error: boolean - Throws an error if the file doesn't exist, instead of creating a new one.
+    throw_check_type: boolean - Requires throw_error to be true. This also throws an error if a folder is meant to be a file or vice versa.
+
+    Returns true if a file was created or the file type was swapped and false if the file wasn't created.'''
+
+    # Type checking
+    if isinstance(path, bytes):
+        path: str = bytes.decode(path)
+    if not isinstance(path, str):
+        raise TypeError(f"'path' should be str or bytes, not {type(path)}")
+    if not isinstance(folder, bool):
+        folder: bool = bool(folder)
+    if isinstance(default_value, str):
+        default_value: bytes = str.encode(default_value)
+    if not isinstance(default_value, bytes):
+        default_value: bytes = str.encode(str(default_value))
+    if not isinstance(auto_correct_type, bool):
+        auto_correct_type: bool = bool(auto_correct_type)
+    if not isinstance(throw_error, bool):
+        throw_error: bool = bool(throw_error)
+    if not isinstance(throw_check_type, bool):
+        throw_check_type: bool = bool(throw_check_type)
+
+    # Expand the user part of a path
+    if path and path[0] == "~":
+        path: str = os.path.expanduser(path)
+
+    # Throws the errors if needed
+    if throw_error:
+        if not os.path.exists(path):
+            raise FileNotFoundError(f"The {'folder' if folder else 'file'} at {path} doesn't exist.")
+
+        if throw_check_type and ((os.path.isdir(path) and not folder) or (not os.path.isdir(path) and folder)):
+            raise FileExistsError(f"The {'file' if folder else 'folder'} at {path} should be a {'folder' if folder else 'file'}.")
+
+        return False
+
+    if os.path.exists(path):
+        # File: exists; Type: Folder; Should be: File
+        if auto_correct_type and os.path.isdir(path) and not folder:
+            os.rmdir(path)
+            f = open(path, "wb")
+            f.write(default_value)
+            f.close()
+            return True
+
+        # File: exists; Type: File; Should be: Fplder
+        if auto_correct_type and not os.path.isdir(path) and folder:
+            os.remove(path)
+            os.mkdir(path)
+            return True
+
+        # File: exists; Type: File | Folder; Should be: File | Folder
+        return False
+
+    if folder:
+        # File: doesn't exist; Should be: Folder
+        os.mkdir(path)
+    else:
+        # File: doesn't exist; Should be: File
+        f = open(path, "wb")
+        f.write(default_value)
+        f.close()
+
+    return True