Skip to main content

File and JSON File Methods.

Project description

File Tools

Build Status PyPI version

Includes useful methods for file/json file reading and writing.

Install

  • python3 -m pip install file-tools

Usage

from file_tools.file import get_file_string, get_file_lines
from file_tools.json_file import import_json, export_json
my_text = get_file_string('text.txt')
my_lines = get_file_lines('text.txt')
my_dict = import_json('example.json')
my_dict['test'] = 1
export_json(data=my_dict, file='example.json')

Methods

  • file
    • get_file_string
      • returns string from file
      • Args
        • file (string)
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module
        • encoding (string='utf-8'), encoding type, defaults to utf-8
    • get_file_lines
      • returns list of lines from file
      • Args
        • file (string)
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module
        • newline (sting='\n'), newline character to parse
        • encoding (string='utf-8'), encoding type, defaults to utf-8
    • write_file_string
      • writes file string to file
      • Args
        • file (string)
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module
        • text (string=''), string to write
        • encoding (string='utf-8'), encoding type, defaults to utf-8
    • append_file_string
      • appends file string to file
      • Args
        • file (string)
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module
        • text (string=''), string to write
        • encoding (string='utf-8'), encoding type, defaults to utf-8
    • write_file_lines
      • appends file lines to file
      • Args
        • file (string)
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module
        • lines (list=[]), lines to write
        • newline (sting='\n'), newline character to separate lines
        • encoding (string='utf-8'), encoding type, defaults to utf-8
    • append_file_lines
      • appends file lines to file
      • Args
        • file (string)
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module
        • lines (list=[]), lines to write
        • newline (sting='\n'), newline character to separate lines
        • encoding (string='utf-8'), encoding type, defaults to utf-8
  • json_file
    • import_json
      • returns dict object (or list) from file
      • Args
        • file (string)
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module
    • export_json
      • exports dict object (or list) to file
      • Args
        • data (dict or list)
        • file (string)
        • indent (int) - number of spaces for json file indentation
        • path (string=''), if empty path will be relative of CWD, otherwise will be relative of path, useful with os.path.abspath(file) to get file relative to module

Project details


Download files

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

Files for file-tools, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size file_tools-0.1.7-py3-none-any.whl (4.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size file-tools-0.1.7.tar.gz (2.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page