File Transfer Protocol (FTP) (Протокол Передачи Файлов) используется многими компаниями и организациями для передачи данных. Python содержит модуль ftplib, который реализует клиентскую часть протокола FTP. Вы можете узнать всю интересующую вас информацию о FTP, обратившись к документу RFC 959 в интернете. Однако, в данной статье мы пройдемся лишь по ключевым вопросам данной темы:
- Подключение к серверу FTP
- Навигация по структуре
- Загрузка файлов из сервера FTP
- Заливка файлов на сервер FTP
Приступим!
Подключение к серверу FTP
Первое, что нам нужно сделать, это, собственно, найти сервер FTP, к которому мы будем подключаться. Существует множество бесплатных серверов, которые вы можете использовать. Например, большая часть дистрибутивов Linux имеют FTP зеркала, которые находятся в свободном доступе. На сайте Fedora (https://admin.fedoraproject.org/mirrormanager/) вы найдете длинный список зеркал, которые вы можете использовать.
Но среди них не только FTP, так что убедитесь в том, что подключаетесь к нужному протоколу, иначе возникнет ошибка подключения. Для нашего обучения, мы используем ftp.cse.buffalo.edu. В официальной документации Python используется ftp.debian.org, так что вы спокойно можете использовать и его. Давайте попробуем подключиться к серверу прямо сейчас. Откройте интерпретатор Python в вашем терминале, или используйте IDLE, совместно со следующим кодом:
|
1 2 3 4 |
from ftplib import FTP ftp = FTP('ftp.cse.buffalo.edu') print(ftp.login()) |
Результат:
|
1 |
230 Guest login ok, access restrictions apply. |
Давайте немного притормозим. Здесь мы импортировали класс FTP из модуля ftplib. Далее, мы создали экземпляр класса, передав ему хост, к котором у мы хотим подключиться. Так как мы не передаем имя пользователя или пароль, Python предположит, что мы решили подключиться анонимно. Если так вышло, что вам нужно подключиться к серверу FTP используя нестандартный порт, тогда вам нужно использовать метод connect. Вот так:
|
1 2 3 4 5 6 |
from ftplib import FTP ftp = FTP() HOST = 'ftp.cse.buffalo.edu' PORT = 12345 ftp.connect(HOST, PORT) |
Данный код не сработает, так как сервер FTP в данном примере не содержит открытый для нас порт 12345. Однако, суть в том, чтобы указывать, как подключиться к порту, который отключается от порта по умолчанию. Если сервер FTP, к которому вы подключаетесь, требует защиту TLS, то вам потребуется импортировать класс FTP_TLS вместо класса FTP. Класс FTP_TLS поддерживает keyfile и certfile. Если вы хотите защитить свое подключение, тогда вам нужно вызвать prot_p для этой цели.
Навигация по каталогам с ftplib
Давайте узнаем, как посмотреть, что находится в сервере FTP и попробуем менять каталоги. Рассмотрим код, который отображает нормальный метод , которым этого можно достичь:
|
1 2 3 4 5 6 7 |
from ftplib import FTP ftp = FTP() ftp.login() data = ftp.retrlines('LIST') print(data) |
Результат:
|
1 2 3 4 5 6 7 8 9 10 |
from ftplib import FTP ftp = FTP() ftp.login() # Меняем директорию ftp.cwd('mirror') data = ftp.retrlines('LIST') print(data) |
Результат:
Здесь мы подключаемся и посылаем команду LIST серверу FTP. Это делается посредством вызова метода retrlines нашего объекта ftp. Метод retrlines выводит результат команды, которую мы вызывали. В данном примере мы вызывали команду LIST, которая извлекает список файлов и\или папок совместно их соответствующей информацией и выводит их. Далее мы использовали команду cwd, чтобы сменить нашу рабочую директорию на другую папку и выполняем команду LIST еще раз, чтобы увидеть, что в этой папке. Вы можете также использовать функцию dir вашего объекта ftp для получения списка данной папки.
Загрузка файлов через FTP
Простой просмотр содержимого FTP – не так уж и полезно. Вам практически в любом случае захочется скачать файл с сервера. Давайте разберемся с тем, как это делается:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
from ftplib import FTP ftp = FTP('ftp.debian.org') ftp.login() ftp.cwd('debian') # Путь на нашем компьютере где сохранить файл. out = 'C:\\files\\README.html' with open(out, 'wb') as f: ftp.retrbinary('RETR ' + 'README.html', f.write) |
В данном примере, мы подключились к FTP Debian Linux и сменили папку на папку debian. Далее мы называем файл, который мы хотим сохранить и открываем его в бинарном моде. Наконец мы используем retrbinary для вызова RETR для извлечения файла и записи его в на локальном диске. Если вы хотите скачать все файлы ftp, тогда вам нужен список файлов.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
import ftplib import os ftp = ftplib.FTP('ftp.debian.org') ftp.login() ftp.cwd('debian') filenames = ftp.nlst() for filename in filenames: host_file = os.path.join( 'C:\\files\\ftp_test', filename ) try: with open(host_file, 'wb') as local_file: ftp.retrbinary('RETR ' + filename, local_file.write) except ftplib.error_perm: pass ftp.quit() |
Этот пример очень похож на предыдущий. Вам нужно обновить его, для соответствия с выбранной локацией загрузки. Первая часть этого кода, в целом, остается неизменной, но далее вы должны заметить, что мы вызываем nlst, который дает нам список названий файлов и каталогов. Вы можете передать эту команду каталогу ради списка, или просто вызвать её, после чего он укажет, что вам нужен список данного каталога.
Обратите внимание на то, что команда nlst не указывает нам на то, как выполнять дифференциацию между файлами и каталогами из её результатов. Хотя в данном примере это не так уж и важно. Это относится к более сложным скриптам. В любом случае, данная команда зациклится над выданным списком и попробует скачать файлы. Если так вышло, что наш «файл» на самом деле является каталогом, то мы получим пустой файл на нашем диске с тем же названием, что и у каталога на FTP сервере. Также существует команда MLSD, которую вы можете вызвать при помощи метода mlsd, но её поддерживают не все FTP сервера. А с теми, которые поддерживают, вы можете заметить различия между ними.
Загрузка файлов на FTP сервер
Еще один важный вопрос, которым вы можете задаться при работе с FTP сервером, это загрузка файлов ftplib. С Python вы можете и это! Существует два метода, пользуясь которыми вы можете загружать файлы:
- storlines – для загрузки текстовых файлов (TXT, HTML, RST)
- storbinary – для загрузки бинарных файлов (PDF, XLS, etc)
Давайте посмотрим на примере, как мы будем это делать:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
import ftplib def ftp_upload(ftp_obj, path, ftype='TXT'): """ Функция для загрузки файлов на FTP-сервер @param ftp_obj: Объект протокола передачи файлов @param path: Путь к файлу для загрузки """ if ftype == 'TXT': with open(path) as fobj: ftp.storlines('STOR ' + path, fobj) else: with open(path, 'rb') as fobj: ftp.storbinary('STOR ' + path, fobj, 1024) if __name__ == '__main__': ftp = ftplib.FTP('host', 'username', 'password') ftp.login() path = '/path/to/something.txt' ftp_upload(ftp, path) pdf_path = '/path/to/something.pdf' ftp_upload(ftp, pdf_path, ftype='PDF') ftp.quit() |
В данном примере мы создали функцию для загрузки файлов. Мы берем объект ftp, путь к файлу, который мы хотим залить и тип файла. Далее, мы быстро проверяем тип файла, чтобы определить, используем мы storlines или же storbinary для процесса загрузки. Наконец, в нашем условном операторе внизу мы подключаем FTP сервер, логинимся и загружаем текстовый файл или файл PDF. Простое дополнение к этому – некоторая логика перехода на конкретный каталог после входа в саму систему, поскольку мы явно не хотим просто заливать файлы в корневую папку.
Подведем итоги
Теперь вы знаете достаточно, для того, чтобы начать использовать ftplib от Python. Существует множество других методов, с которыми настоятельно рекомендуется ознакомиться в соответствующей документации. Однако теперь вы владеете базовыми понятиями составления списков директорий, навигации в структуре файлов, а также загрузка файлов на сервер.
Являюсь администратором нескольких порталов по обучению языков программирования Python, Golang и Kotlin. В составе небольшой команды единомышленников, мы занимаемся популяризацией языков программирования на русскоязычную аудиторию. Большая часть статей была адаптирована нами на русский язык и распространяется бесплатно.
E-mail: vasile.buldumac@ati.utm.md
Образование
Universitatea Tehnică a Moldovei (utm.md)
- 2014 — 2018 Технический Университет Молдовы, ИТ-Инженер. Тема дипломной работы «Автоматизация покупки и продажи криптовалюты используя технический анализ»
- 2018 — 2020 Технический Университет Молдовы, Магистр, Магистерская диссертация «Идентификация человека в киберпространстве по фотографии лица»