Прочитать файл

Описание

Блок считывает содержимое файла выбранного типа: Текстовый, JSON, KeePass, Yaml, XML, CSV.

---

Описание параметров

Текстовый

1. Путь к файлу - путь к текстовому файлу.

   Тип данных: str (Строка)

   Пример: C:\\data\\file.txt

2. Кодировка (необязательный параметр) - кодировка файла.

   Тип данных: str (Строка)

   Пример: utf-8

Возвращаемое значение - строка с содержимым файла.

Тип данных: str (Строка)

Пример: Текст из файла

JSON

1. Путь к файлу - путь к JSON-файлу.

   Тип данных: str (Строка)

   Пример: C:\\data\\data.json

2. Кодировка (необязательный параметр) - кодировка файла.

   Тип данных: str (Строка)

   Пример: utf-8

Возвращаемое значение - JSON-структура из файла.

Тип данных: dict (Словарь) | list (Список)

Пример: {'name': 'Иван', 'age': 30}

KeePass

1. Путь к файлу - путь к файлу KeePass (.kdbx).

   Тип данных: str (Строка)

   Пример: C:\\data\\vault.kdbx

2. Пароль - пароль к базе KeePass.

   Тип данных: str (Строка)

   Пример: myStrongPassword

3. Название - название записи в базе.

   Тип данных: str (Строка)

   Пример: Google account

Возвращаемое значение - массив значений записи: логин, пароль, ссылка, примечание.

Тип данных: list (Список)

Пример: ['user@mail.com', 'pass123', 'https://site.com', 'Основной аккаунт']

Yaml

1. Путь к файлу - путь к YAML-файлу.

   Тип данных: str (Строка)

   Пример: C:\\data\\config.yaml

2. Использовать загрузчик - тип загрузчика (BaseLoader, SafeLoader, FullLoader, UnsafeLoader).

Возвращаемое значение - структура данных из YAML-файла.

Тип данных: dict (Словарь) | list (Список)

Пример: {'host': 'localhost', 'port': 8080}

XML

1. XML-файл, XML-строка или объект - источник XML-данных.

   Тип данных: str (Строка) | XML object

   Пример: C:\\data\\file.xml

2. Режим чтения XML:
   • Значения или узлы - поиск по тегу/XPath;
   • Таблица - чтение XML в табличном виде.
3. Имя XML-тега или XPath (для режима Значения или узлы) - запрос для поиска значений/узлов.

   Тип данных: str (Строка)

   Пример: .//item

4. Режим возврата (для режима Значения или узлы) - формат результата:
   • Объект;
   • Словарь.
5. XPath строк (для режима Таблица) - XPath, определяющий набор строк таблицы.

   Тип данных: str (Строка)

   Пример: ./*

6. Кодировка (для режима Таблица, необязательный параметр) - кодировка XML-документа.

   Тип данных: str (Строка)

   Пример: utf-8

7. Читать из узлов (для режима Таблица) - источник данных в узле:
   • Элементы и атрибуты;
   • Только элементы;
   • Только атрибуты.
8. Пространства имен XML (для режима Таблица, необязательный параметр) - словарь пространств имен.

   Тип данных: dict (Словарь) | None (Ничто)

   Пример: {'ns': 'http://example.com/ns'}

9. Названия колонок (для режима Таблица, необязательный параметр) - список имен столбцов результата.

   Тип данных: list (Список) | None (Ничто)

   Пример: ['id', 'name', 'price']

10. Типы данных колонок (для режима Таблица, необязательный параметр) - типы данных для столбцов.

    Тип данных: dict (Словарь) | None (Ничто)

    Пример: {'id': 'int', 'price': 'float'}

11. Преобразовать даты (для режима Таблица, необязательный параметр) - преобразование колонок в даты.

    Тип данных: bool (Логическое значение) | list (Список) | dict (Словарь) | None (Ничто)

    Пример: Истина

Поддерживаемые источники

Можно передать путь к файлу .xml, XML-строку или XML-объект.

Возвращаемое значение:

• режим Значения или узлы, режим возврата Объект: найденное значение/узел или список значений/узлов;
• режим Значения или узлы, режим возврата Словарь: словарь или список словарей;
• режим Таблица: таблица DataFrame.

CSV

1. Путь к файлу - путь к CSV-файлу.

   Тип данных: str (Строка)

   Пример: C:\\data\\table.csv

2. Разделитель - символ разделения колонок.
3. Кодировка (необязательный параметр) - кодировка файла.

   Тип данных: str (Строка)

   Пример: utf-8

4. Движок:
   • Многопоточный - чтение через pandas с расширенными параметрами;
   • Однопоточный - чтение через csv.
5. Есть заголовок - признак того, что первая строка CSV содержит названия колонок.

   Тип данных: bool (Логическое значение)

   Пример: Истина

6. Пропускать пустые строки (только для движка Однопоточный) - пропуск пустых строк при чтении.

   Тип данных: bool (Логическое значение)

   Пример: Истина

7. Прочитать столбцы (только для движка Многопоточный) - столбцы для чтения из CSV.

   Тип данных: str (Строка) | None (Ничто)

   Пример: A,C,E:X

8. Пропустить строки (только для движка Многопоточный) - количество или индексы строк для пропуска.

   Тип данных: int (Число) | list (Список) | None (Ничто)

   Пример: 3

9. Прочитать строк (только для движка Многопоточный) - количество строк для чтения после пропуска.

   Тип данных: int (Число) | None (Ничто)

   Пример: 10

10. Тип данных колонок (только для движка Многопоточный) - типы данных колонок при чтении.

    Тип данных: dict (Словарь) | str (Строка) | None (Ничто)

    Пример: {'A': 'str', 'B': 'int'}

Поддерживаемый формат

Для режима CSV поддерживается формат: .csv.

Заметка

Возвращаемый тип зависит от выбранного движка и параметра Есть заголовок. Для однопоточного режима возвращается список (list), для многопоточного — таблица (DataFrame).

Возвращаемое значение:

• движок Однопоточный + Есть заголовок = Да: list[dict];
• движок Однопоточный + Есть заголовок = Нет: list[list];
• движок Многопоточный: DataFrame.

---

Пример использования

Ниже приведены шаблоны примеров для наиболее популярных режимов чтения.

Текстовый

В данном примере происходит считывание текста из текстового файла .txt:

Результат выводится на экран:

KeePass

В данном примере происходит считывание текста из файла .KeePass:

Результат выводится на экран:

CSV

В данном примере выполняется чтение CSV-файла с расширенными параметрами.

Используются параметры:

• Разделитель: ;;
• Кодировка: utf-8;
• Движок: Многопоточный;
• Есть заголовок: Да;
• Прочитать столбцы: Индекс:Фамилия;
• Пропустить строки: Ничто;
• Прочитать строк: 5;
• Тип данных колонок:

  {
      'Индекс': 'int',
      'Имя': 'str',
      'Фамилия': 'str'
  }

Результат чтения сохраняется в переменную file_content и выводится через блок Уведомление пользователя:

---