Здравствуйте! Это не статья, а документация к моему пакету в pypi.

Simple_file_user - пакет для простой работы с файлами. В нём есть несколько функций и класс для продвинутой работы с файлами.

Установка

Чтобы установить этот пакет напиши в командной строке:

python -m pip install simple_file_user

Быстрый старт

Импортируем класс:

from simple_file_user.File import File

Строка выше импортирует класс File. Создадим объект файла:

file = File("file.txt", "utf-8", True)

И запишем в него что-нибудь:

file.rewrite("Что-нибудь.")

Ну, и проверим записалась ли наша строка в файл:

file.read()

-------------

Что-нибудь

Импорт

import simple_file_user # Импортирует всё, но возможности пакета вызываются только с префиксом simple_file_user.
from simple_file_user import * # Импортирует всё
from simple_file_user import name_of_function # Импортирует определённую функцию.
from simple_file_user.File import File # Импортирует класс File.

Обзор функций

Это список функций, включённых в пакет.

• read(path: str, encoding: str = "utf-8", binary_mode: bool = False) -> str ---- Читает файл и возвращает его содержимое.
• rewrite(path: str, content: str, encoding: str = "utf-8") -> int ---- Очищает файл и записывает в него content. Возвращает количество записанных символов.
• add(path: str, content: str, encoding = "utf-8") -> int ---- Дописывает content в файл. Возвращает количество записанных символов.
• remove(path: str) -> None ---- Удаляет файл.
• rename(path: str, new_name: str) -> None ---- Переименовывает файл.
• getSize(path: str) -> int ---- Возвращает размер файла в байтах.
• getName(path: str) -> str ---- Возвращает имя файла.
• getExtension(path: str) -> str ---- Возвращает расширение файла.
• writeToFile(path: str, encoding: str = "utf-8") ---- Декоратор. Возвращает функцию, записывающую в файл возвращаемое значение задекорированного вызываемого объекта.
• addToFile(path: str, encoding: str = "utf-8") ---- Декоратор. Возвращает функцию, дописывающую в файл возвращаемое значение задекорированного вызываемого объекта.

Если есть желание узнать больше об этих функциях используй help(name_of_function).

Класс File

В пакете есть класс файла. Он расположен в модуле File и имеет два приватных поля: path (путь) и encoding (кодировка). Для получения их значения используйте геттеры getPath() и getEncoding().

Создание объекта файла

File(path: str, , encoding: str = "utf-8", new: bool = False)

Обзор методов

• read() -> str ---- Открывает файл и возвращает его содержимое.
• write(content: str, mod: str) -> int ---- Пишет content в файл соответственно mod.
• rewrite(content: str) -> int ---- Очищает файл и пишет в него content количество записанных символов.
• add(content: str) -> int ---- Дописывает content в файл. Возвращает количество записанных символов.
• readLine(number_of_line: int) -> str ---- Возвращает строку из файла.
• rename(new_name: str) -> None ---- Переименовывает файл.
• getSize() -> int ---- Возвращает размер файла в байтах.
• getName() -> str ---- Возвращает имя файла.
• getEncoding() -> str ---- возвращает кодировку файла.
• getPath() -> str ---- Возвращает путь к файлу.
• getExtension() -> str ---- Возвращает расширение файла.
• remove() -> None ---- Удаляет файл и уничтожает объект файла.
• split(key: str) -> list ---- Возвращает список с разделённым содержимым файла.
• rsplit(key: str) -> list ---- Возвращает перевёрнутый список с разделённым содержимым файла.

Сравнение объектов File.

Объекты файла также поддерживают работу с операторами сравнения. Сравнивать можно только объекты класса File, иначе вылетит исключение TypeError. Операторы == и != сравнивают содержимое файлов. Другие же ( < > <= >=) сравнивают их размер.