Python-File-Tools 0.1.0__py3-none-any.whl

python_file_tools/test/test_sort.py

@@ -0,0 +1,172 @@
+#!/usr/bin/env python3
+
+import python_file_tools.sort as pft_sort
+from os.path import abspath
+
+def test_get_first_section():
+    """
+    Tests the get_first_section function.
+    """
+    # Test getting number sections
+    assert pft_sort.get_first_section("12") == "12"
+    assert pft_sort.get_first_section("123 Thing!") == "123"
+    assert pft_sort.get_first_section("1.25Words") == "1.25"
+    assert pft_sort.get_first_section("1,000 Next") == "1,000"
+    assert pft_sort.get_first_section("1,523.26!Numbers") == "1,523.26"
+    # Test getting non-number sections
+    assert pft_sort.get_first_section("Just text.") == "Just text."
+    assert pft_sort.get_first_section("Text, then Numbers.137") == "Text, then Numbers."
+    # Test getting section from string that has none
+    assert pft_sort.get_first_section("") == ""
+
+def test_compare_sections():
+    """
+    Tests the compare_sections function.
+    """
+    # Test comparing just numbers
+    assert pft_sort.compare_sections("25", "0025") == 0
+    assert pft_sort.compare_sections("1,000", "1000") == 0
+    assert pft_sort.compare_sections("2", "2.000") == 0
+    assert pft_sort.compare_sections("2", "3") == -1
+    assert pft_sort.compare_sections("54", "023") == 1
+    assert pft_sort.compare_sections("1,200", "1250") == -1
+    assert pft_sort.compare_sections("3,500", "3,000") == 1
+    assert pft_sort.compare_sections("0105.3", "105.38") == -1
+    assert pft_sort.compare_sections("1.5", "1.25") == 1
+    assert pft_sort.compare_sections("1", "1.5") == -1
+    # Test comparing just text
+    assert pft_sort.compare_sections("text", "text") == 0
+    assert pft_sort.compare_sections("abc", "def") == -1
+    assert pft_sort.compare_sections("test", "blah") == 1
+    assert pft_sort.compare_sections("un", "unfinished") == -1
+    assert pft_sort.compare_sections("ending", "end") == 1
+    # Test comparing text and numbers
+    assert pft_sort.compare_sections("43", "text") == -1
+    assert pft_sort.compare_sections("other", "5.8") == 1
+    # Test with missing sections
+    assert pft_sort.compare_sections("", "540") == -1
+    assert pft_sort.compare_sections("0", "") == 1
+    assert pft_sort.compare_sections("", "word") == -1
+    assert pft_sort.compare_sections("other", "")
+
+def test_compare_alphanum():
+    """
+    Tests the compare_alphanum function.
+    """
+    # Test identical strings
+    assert pft_sort.compare_alphanum("", "") == 0
+    assert pft_sort.compare_alphanum("23 test", "23 test") == 0
+    # Test comparing by number
+    assert pft_sort.compare_alphanum("Test 4", "  test 10") == -1
+    assert pft_sort.compare_alphanum("  Thing 34.5 more",  "Thing 5") == 1
+    assert pft_sort.compare_alphanum("14 Name 1", "14   name 3") == -1
+    assert pft_sort.compare_alphanum("024 thing next 5", "24 thing next 2") == 1
+    # Test comparing by text
+    assert pft_sort.compare_alphanum("45 abc", "45 Test") == -1
+    assert pft_sort.compare_alphanum("987 banana", "0987   AAA") == 1
+    assert pft_sort.compare_alphanum("5 Thing 65 next", "5 thing 65.0 other") == -1
+    assert pft_sort.compare_alphanum("5.8 next 4 zzz", " 5.80 next 4 aaa") == 1
+    assert pft_sort.compare_alphanum("12 thing", "12 thing next") == -1
+    assert pft_sort.compare_alphanum("50 other next", "050 Other") == 1
+    # Test comparing that with identical sections
+    assert pft_sort.compare_alphanum("AAA", "aaa") == -1
+    assert pft_sort.compare_alphanum("1.0", "1") == 1
+
+def test_sort_alphanum():
+    """
+    Tests the sort_alphanum function.
+    """
+    lst = ["test 10", "test 1", "test 003", "3.5", "06 Next", "middle"]
+    sort = pft_sort.sort_alphanum(lst)
+    assert sort == ["3.5", "06 Next", "middle", "test 1", "test 003", "test 10"]
+
+def test_get_value_from_dictionary():
+    """
+    Tests the get_value_from_dictionary function.
+    """
+    # Test getting a basic value
+    dictionary = {"name":"thing", "other":"name"}
+    assert pft_sort.get_value_from_dictionary(dictionary, ["name"]) == "thing"
+    assert pft_sort.get_value_from_dictionary(dictionary, ["other"]) == "name"
+    # Test getting a deeply nested value
+    dictionary = {"thing":{"a":123, "b":456}, "even":{"deeper":{"a":"abc"}}}
+    assert pft_sort.get_value_from_dictionary(dictionary, ["thing","a"]) == 123
+    assert pft_sort.get_value_from_dictionary(dictionary, ["thing","b"]) == 456
+    assert pft_sort.get_value_from_dictionary(dictionary, ["even","deeper","a"]) == "abc"
+    # Test getting an array value
+    dictionary = {"thing":["a","b","c","d"], "other":{"list":[10,20,30]}}
+    assert pft_sort.get_value_from_dictionary(dictionary, ["thing",1]) == "b"
+    assert pft_sort.get_value_from_dictionary(dictionary, ["other","list",1]) == 20
+    # Test getting a mix of array and key values
+    dictionary = {"a":[{"name":"title"}, {"name":"other"}]}
+    assert pft_sort.get_value_from_dictionary(dictionary, ["a",0,"name"]) == "title"
+    assert pft_sort.get_value_from_dictionary(dictionary, ["a",1,"name"]) == "other"
+    # Test getting an invalid key
+    assert pft_sort.get_value_from_dictionary(dictionary, [1]) is None
+    assert pft_sort.get_value_from_dictionary(dictionary, ["item"]) is None
+    assert pft_sort.get_value_from_dictionary(["thing"], [2]) is None
+    assert pft_sort.get_value_from_dictionary(["thing"], ["item"]) is None
+    assert pft_sort.get_value_from_dictionary(dictionary, ["a",5]) is None
+    assert pft_sort.get_value_from_dictionary(dictionary, ["a","thing"]) is None
+
+def test_compare_dictionaries_alphanum():
+    """
+    Tests the compare_dictionaries_alphanum function.
+    """
+    # Test comparing dictionaries one key deep
+    dict1 = {"dvk_alpha_sort_key":"name", "name":"", "other":"blah"}
+    dict2 = {"dvk_alpha_sort_key":"name", "name":"", "other":"thing"}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == 0
+    dict1 = {"dvk_alpha_sort_key":"name", "name":"001", "other":"blah"}
+    dict2 = {"dvk_alpha_sort_key":"name", "name":"2", "other":"thing"}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == -1
+    dict1 = {"dvk_alpha_sort_key":"other", "name":"001", "other":"Part 23.5"}
+    dict2 = {"dvk_alpha_sort_key":"other", "name":"2", "other":"Part 23"}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == 1
+    # Test comparing dictionaries multiple keys deep
+    dict1 = {"dvk_alpha_sort_key":["name","thing"], "name":{"thing":"0"}, "other":"blah"}
+    dict2 = {"dvk_alpha_sort_key":["name","thing"], "name":{"thing":"0"}, "other":"new"}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == 0
+    dict1 = {"dvk_alpha_sort_key":["name","thing"], "name":{"thing":"A"}, "other":"blah"}
+    dict2 = {"dvk_alpha_sort_key":["name","thing"], "name":{"thing":"B"}, "other":"new"}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == -1
+    dict1 = {"dvk_alpha_sort_key":["name","thing","a"], "name":{"thing":{"a":"thing"}}, "other":"blah"}
+    dict2 = {"dvk_alpha_sort_key":["name","thing","a"], "name":{"thing":{"a":"other"}}, "other":"new"}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == 1
+    # Test comparing dictionaries with keys referencing a given array value
+    dict1 = {"dvk_alpha_sort_key":["list",2], "list":["1","2","c","3"]}
+    dict2 = {"dvk_alpha_sort_key":["list",2], "list":["a","b","c","d"]}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == 0
+    dict1 = {"dvk_alpha_sort_key":["list",0], "list":["1","2","c","3"]}
+    dict2 = {"dvk_alpha_sort_key":["list",0], "list":["a","b","c","d"]}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == -1
+    dict1 = {"dvk_alpha_sort_key":["list",3], "list":["1","2","c","Other"]}
+    dict2 = {"dvk_alpha_sort_key":["list",3], "list":["a","b","c","25"]}
+    assert pft_sort.compare_dictionaries_alphanum(dict1, dict2) == 1
+
+def test_sort_dictionaries_alphanum():
+    """
+    Tests the sort_dictionaries_alphanum function.
+    """
+    dictionaries = []
+    dictionaries.append({"name":"Title 1", "other":{"a":"123", "b":"245"}})
+    dictionaries.append({"name":"Title 10", "other":{"a":"523", "b":"Thing"}})
+    dictionaries.append({"name":"Name", "other":{"a":"a", "b":"b"}})
+    dictionaries.append({"name":"ZZZ", "other":{"a":"name", "b":"title"}})
+    dictionaries.append({"name":"AAA", "other":{"a":"123.5", "b":"Blah"}})
+    # Test sorting by a standard value
+    dictionaries = pft_sort.sort_dictionaries_alphanum(dictionaries, "name")
+    assert len(dictionaries) == 5
+    assert dictionaries[0] == {"name":"AAA", "other":{"a":"123.5", "b":"Blah"}}
+    assert dictionaries[1] == {"name":"Name", "other":{"a":"a", "b":"b"}}
+    assert dictionaries[2] == {"name":"Title 1", "other":{"a":"123", "b":"245"}}
+    assert dictionaries[3] == {"name":"Title 10", "other":{"a":"523", "b":"Thing"}}
+    assert dictionaries[4] == {"name":"ZZZ", "other":{"a":"name", "b":"title"}}
+    # Test sorting by a deeper value
+    dictionaries = pft_sort.sort_dictionaries_alphanum(dictionaries, ["other","a"])
+    assert len(dictionaries) == 5
+    assert dictionaries[0] == {"name":"Title 1", "other":{"a":"123", "b":"245"}}
+    assert dictionaries[1] == {"name":"AAA", "other":{"a":"123.5", "b":"Blah"}}
+    assert dictionaries[2] == {"name":"Title 10", "other":{"a":"523", "b":"Thing"}}
+    assert dictionaries[3] == {"name":"Name", "other":{"a":"a", "b":"b"}}
+    assert dictionaries[4] == {"name":"ZZZ", "other":{"a":"name", "b":"title"}}

python_file_tools-0.1.0.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: Python-File-Tools
+Version: 0.1.0
+Summary: Some basic tools that makes some basic file operations easier in Python. 
+Home-page: https://github.com/Drakovek/Python-File-Tools
+Author: Drakovek
+Author-email: DrakovekMail@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+# Python-File-Tools
+
+Python-File-Tools is a collection of simple functions for creating and manipulating files. This was all originally written form my [MetadataMagic](https://github.com/Drakovek/MetadataMagic/blob/master/README.md) project to make working with certain file archiving and creation easier, but decided to spin it off into its own thing, since I wound up finding the tools useful in other projects
+
+These are all for using as library functions for other python projects. There are no command line utilities. I'll list the functions here, but for further details you can check the code itself. I've documented the functions and their parameters pretty well in the comments there, so I feel that should do for the time being.
+
+# MAIN FUNCTIONS
+
+Main file tool functions within the file_tools.py file.
+
+## write_text_file
+
+Writes a given piece of text to a text file in UTF-8 encoding.
+
+## read_text_file
+
+Returns the contents of a given text file as a string, with wide support for different text file encoding schemes.
+
+## write_json_file
+
+Writes a given dictionary as a .json file using UTF-8 encoding.
+
+## read_json_file
+
+Returns the contents of a given .json file as a python dictionary, with support for different text encoding schemes.
+
+## find_all_files
+
+Returns a list of absolute file paths for all the files in a directory, with or without subdirectories
+
+## find_files_of_type
+
+Returns a list of absolute file paths for all files in a directory that use a specific file extension or extensions.
+
+## directory_contains
+
+Returns whether a directory contains any files with a given file extension or extensions
+
+## create_zip
+
+Archives the contents of a directory into a zip file, adding a mimetype if desired.
+
+## extract_zip
+
+Extracts the contents of a .zip file into a directory, with many options for how to structure the extracted files and what files to not include.
+
+## extract_file_from_zip
+
+Extracts a single specific file from a .zip file
+
+## get_file_friendly_text
+
+Takes a given string and returns a text string that is allowed to be used as a filename across all major OSes and file systems, with option for pure ASCII text
+
+## get_available_filename
+
+Returns a valid filename for a directory given a desired filename, altering the name if a file with that name already exists
+
+## rename_file
+
+Renames a file to a given filename, taking care that the filename is valid and doesn't already exist.
+
+# SORT FUNCTIONS
+
+Sorting functions within the sort.py file. Mostly to do with "smart alphanumeric sorting" which is my quick way of saying sorting alphanumerically the way a human might, without getting confused by extra whitespace, capitalization, leading zeros, or other basic formatting. So "File 10" always comes after "File 2" and "b" comes after "A" unlike with basic alphabetic sorting.
+
+## compare_alphanum
+
+Compares two strings using smart alphanumeric comparison.
+
+## sort_alphanum
+
+Sorts a list of strings using smart alphanumeric sorting.
+
+## sort_dictionaries_alphanum
+
+Sorts a list of python dictionaries based on the contents of a given key using smart alphanumeric sorting.

python_file_tools-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+python_file_tools/__init__.py,sha256=465UF2d7w-z_W3_H95Lj5ZjpMYzo-w3g7BSCFaC_C80,67
+python_file_tools/file_tools.py,sha256=J0LDyM0vPRTcca7A31MsA6GhkUm7Sbv8765PeOVq6bw,19748
+python_file_tools/sort.py,sha256=DkNiGKHO1WfrSo1pB-gzhs1wboISPbXVL5SbehDt_0A,6354
+python_file_tools/test/__init__.py,sha256=v3HSLt-xqpmjSSp59mki82hVbOHQa1Cdc7PgwSkzm_Y,365
+python_file_tools/test/test_file_tools.py,sha256=MOllJPQR6D9rx9Ye7b21MRmoeyQG15qtI0W1C-obH_g,29455
+python_file_tools/test/test_sort.py,sha256=WQ2sUya9zSefP5LzR5P9ZZDPsgg721HrCai5VDP2UBA,9400
+python_file_tools-0.1.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_file_tools-0.1.0.dist-info/METADATA,sha256=Zw7f0KKQNYTeGz8RCn7jGgvKiv2N3SED0jc1MC-a5_0,3831
+python_file_tools-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+python_file_tools-0.1.0.dist-info/top_level.txt,sha256=oVf8cuyNnQMvURzTbdg1kzYTyXdt4f7jVv93YsBkkI0,18
+python_file_tools-0.1.0.dist-info/RECORD,,

python_file_tools-0.1.0.dist-info/WHEEL

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