generalfile 2.5.12

Easily manage files cross platform.

generalfile

Easily manage files cross platform.

Contents

generalfile
├─ Dependency Diagram
├─ Installation showing dependencies
├─ Information
├─ Attributes
├─ Contributions
└─ Todo

Dependency Diagram

flowchart LR
2([file]) --> 4([packager])
1([library]) --> 3([vector])
1([library]) --> 4([packager])
0([import]) --> 1([library])
1([library]) --> 2([file])
click 0 "https://github.com/ManderaGeneral/generalimport"
click 1 "https://github.com/ManderaGeneral/generallibrary"
click 2 "https://github.com/ManderaGeneral/generalfile"
click 3 "https://github.com/ManderaGeneral/generalvector"
click 4 "https://github.com/ManderaGeneral/generalpackager"
style 2 fill:#482

Installation showing dependencies

pip install	generalfile	generalfile[spreadsheet]	generalfile[full]
generallibrary	✔️	✔️	✔️
send2trash	✔️	✔️	✔️
appdirs	✔️	✔️	✔️
dill	✔️	✔️	✔️
pandas	❌	✔️	✔️

Information

Package	Ver	Latest Release	Python	Platform	Cover
generalfile	2.5.12	2022-10-07 16:07 CEST	3.8, 3.9, 3.10	Windows, Ubuntu	72.3 %

Attributes

Module: generalfile
├─ Class: CaseSensitivityError
├─ Class: ConfigFile
│  ├─ Method: exists
│  ├─ Method: get_custom_serializers
│  ├─ Method: get_field_dict_serializable (Untested)
│  ├─ Method: halt_getattr (Untested)
│  ├─ Method: read_hook_post (Untested)
│  ├─ Method: read_hook_pre (Untested)
│  ├─ Method: safe_equals (Untested)
│  ├─ Method: write_config
│  ├─ Method: write_hook_post (Untested)
│  └─ Method: write_hook_pre (Untested)
├─ Class: InvalidCharacterError
└─ Class: Path
   ├─ Class: Path
   ├─ Method: absolute
   ├─ Method: as_working_dir
   ├─ Property: cfg
   ├─ Method: contains
   ├─ Method: copy
   ├─ Method: copy_to_folder
   ├─ Method: create_folder
   ├─ Method: delete
   ├─ Method: delete_folder_content
   ├─ Method: empty
   ├─ Method: encode
   ├─ Method: endswith
   ├─ Method: exists
   ├─ Method: forward_slash
   ├─ Method: from_alternative
   ├─ Method: get_active_venv (Untested)
   ├─ Method: get_cache_dir
   ├─ Method: get_differing_files
   ├─ Method: get_lock_dir
   ├─ Method: get_lock_path
   ├─ Method: get_parent_package (Untested)
   ├─ Method: get_parent_repo
   ├─ Method: get_parent_venv (Untested)
   ├─ Method: get_working_dir
   ├─ Method: is_absolute
   ├─ Method: is_file
   ├─ Method: is_folder
   ├─ Method: is_identical
   ├─ Method: is_package (Untested)
   ├─ Method: is_relative
   ├─ Method: is_repo (Untested)
   ├─ Method: is_root
   ├─ Method: is_venv (Untested)
   ├─ Method: lock
   ├─ Method: match
   ├─ Method: mirror_path
   ├─ Method: move
   ├─ Method: name
   ├─ Method: open_folder
   ├─ Method: open_operation
   ├─ Method: pack
   ├─ Method: parts
   ├─ Property: pickle
   ├─ Method: read
   ├─ Method: relative
   ├─ Method: remove_end
   ├─ Method: remove_start
   ├─ Method: rename
   ├─ Method: root
   ├─ Method: same_destination
   ├─ Method: scrub
   ├─ Method: seconds_since_creation
   ├─ Method: seconds_since_modified
   ├─ Method: set_working_dir
   ├─ Method: size
   ├─ Method: spawn_children (Untested)
   ├─ Method: spawn_parents (Untested)
   ├─ Property: spreadsheet
   ├─ Method: startswith
   ├─ Method: stem
   ├─ Method: suffix
   ├─ Method: suffixes
   ├─ Property: text
   ├─ Method: to_alternative
   ├─ Method: trash
   ├─ Method: trash_folder_content
   ├─ Method: true_stem
   ├─ Method: unpack
   ├─ Method: view_paths (Untested)
   ├─ Method: with_name
   ├─ Method: with_stem
   ├─ Method: with_suffix
   ├─ Method: with_suffixes
   ├─ Method: with_true_stem
   ├─ Method: without_file
   └─ Method: write

Contributions

Issue-creation and discussions are most welcome!

Pull requests are not wanted, please discuss with me before investing any time

Todo

Module	Message
path.py	Binary extension.
configfile.py	Handle custom serializers within iterable for ConfigFile.
path_spreadsheet.py	Support DataFrame and Series with spreadsheet.append()
path_lock.py	Lock the optional extra paths.

^{Generated 2022-10-07 16:07 CEST for commit 5e81fd9.}