Skip to main content

A lightweight and fast Python API for simplifying file operations

Project description

pyfastfile

A lightweight Python library for easy-to-use operations.


logo

python License Status Type Github

Installation

pip install pyfastfile

Usage

The encoding parameter defaults to utf-8 in all functions that support text encoding.
All index-based functions use zero-based indexing.

Titles


Main Functions

Function Name Description Arguments Returns
overwrite() Overwrites a file with given content. path:str, data:str,encoding:str None
append() Appends data to the end of a file. path:str, data:str,encoding:str None
read() Reads entire file content as string. path:str,encoding:str str
readlines() Returns file lines as a list. path:str, newline:bool,encoding:str list
getline() Returns a specific line from file. path:str, line:int,newline:bool,encoding:str str
exists() Checks if file exists. path:str bool
find() Returns lines containing target text. path:str,data:str,encoding:str list[str]
find_num() Returns line numbers matching target text. path:str,data:str,encoding:str list[int]
delete() Delete target file. path:str None
rename() Rename target file. path:str, name:str None
touch() Create file. path:str,existserror:bool None
move() Move files filepath:str,targetpath:str None
clear() Clears the content of a file by overwriting it with an empty string. path: str, encoding: str = "utf-8" None
count_lines() Returns the number of lines in a file. path: str int
size_mb() Returns file size in megabytes. path:str float
size() Returns file size in bytes. path:str int

Csv Functions

Function Name Description Arguments Returns
csv_read() Read target csv. path:str,encoding:str Generator
csv_append() Appends data to the end of a csv file. path:str,data:list,encoding:str None
csv_getheader() Return header of the target csv file. path:str,encoding:str list
csv_getrow() Return target row of the csv file. path:str,row:int,encoding:str list
csv_getcolumn() Return target column of the csv file. path:str,column:str,encoding:str list
csv_getdata() Gets a value from CSV by row and column. path:str,row:int,column:str,encoding:str, any
csv_updaterow() Update target row path:str,row:int,new_data:list,encoding:str None
csv_overwrite() Overwrite on target file. path:str,data:list,encoding:str None
csv_count() Return lenght of target file. path:str,withheader:bool int

Json Functions

Function Name Description Arguments Returns
json_read() Read target JSON file and parse its content. path:str dict
json_overwrite() Overwrite target JSON file with new data. path:str, data:dict, encoding:str None
json_append() Reads JSON file, merges new dictionary into existing data (key update behavior). path:str, data:dict None
json_delete_key() Deletes a specific key from JSON data and rewrites the file. path:str, key:str, encoding:str None
json_is_valid() Checks whether the target JSON file contains valid JSON data. path:str bool
json_get_values() Returns all values from the target JSON object. path:str, withlist:bool, encoding:str dict_values
json_get_keys() Returns all keys from the target JSON object. path:str, withlist:bool, encoding:str dict_keys

Directory Functions

Function Name Description Arguments Returns
dir_create() Creates the target directory if it does not already exist. path:str None
dir_list() Lists all entries in the target directory. path:str list
dir_is_directory() Checks whether the target path is a directory. path:str bool
dir_delete() Deletes the target directory. Removes recursively if non-empty. path:str None
dir_is_empty() Checks whether the target directory is empty. path:str bool
dir_size() Returns the total size of the target directory in bytes, recursively. path:str int
dir_size_mb() Returns the total size of the target directory in megabytes, recursively. path:str float

Utility Functions

Function Name Description Arguments Returns
destroy_newline() Removes newline characters from text. data:str str
lmap() Only: list(map(...)) func:function,lst:list list
copy_to_clipboard() Copy text on clipboard text:str None

Project Repo GithubProject Repo PyPI -- Author Github ProfileAuthor PyPI Profile

--Batuhan Şenol

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfastfile-0.4.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyfastfile-0.4.0-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file pyfastfile-0.4.0.tar.gz.

File metadata

  • Download URL: pyfastfile-0.4.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for pyfastfile-0.4.0.tar.gz
Algorithm Hash digest
SHA256 5cb5638224999b248a8db4b7ee03c801c8a416945dbfcb3750aac3e9779181c6
MD5 2a37ac33dd6501ceee24a5eab138d274
BLAKE2b-256 6523fbb94fe7b07ca925f05ac5ebc9121ed821a393db8d46e25b957f057c44a0

See more details on using hashes here.

File details

Details for the file pyfastfile-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: pyfastfile-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 22.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for pyfastfile-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ed8ea949b3421e35922eb24210e7f49dd0b3aad64ad69494bf4e14d7ec4a33c
MD5 f25d5f563e2f50324d18d5e7ee0f2145
BLAKE2b-256 d6907158c6d4eb6c7c91bf201c3ed356217a28f34a07213f5cbaa2ae820bbc89

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page