xbot.ftp.FTPBase

この記事の内容
  1. メソッド
  2. unlogin()
  3. get_ftp_files()
  4. download_file()
  5. download_files()
  6. download_folder()
  7. download_folders()
  8. upload_file()
  9. upload_files()
  10. upload_folder()
  11. upload_folders()
  12. change_workspace_path()
  13. delete_file()
  14. rename_file()
  15. create_directory()
  16. delete_folder()

FTPオブジェクトのインスタンスを使用してFTPサーバーとやり取りします。

メソッド

unlogin()

ログアウトして、現在の接続を切断します。

unlogin(self)

入力パラメータ

なし

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.instance.unlogin()

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> FTPからログアウトします。

get_ftp_files()

ファイルサーバー上の現在の接続先パスにあるすべてのファイル情報(ファイルとフォルダを含む)を取得します。

get_ftp_files(self, remote_path="")

入力パラメータ

remote_path: ファイル情報を取得するリモートパスです。デフォルト値は空で、現在接続している作業パスの情報を取得することを表します。

戻り値

dict:remote_files と remote_folders をキーとし、値がリストである辞書型のデータを返します。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    resutl = ftp.get_ftp_files()

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> FTPからログアウトします。

download_file()

ファイルサーバー上の指定されたパスにあるファイルをローカルにダウンロードします。

download_file(self, local_path, remote_file, download_mode='overwrite')

入力パラメータ

local_path: リモートファイルのダウンロード先となるローカルパスです。

remote_file: サーバー上でダウンロードするファイルのパスです。現在接続している作業パスからの相対パスで指定します。

download_mode:ローカルパスに同名ファイルが存在する場合の操作です。'overwrite'(ローカルファイルを上書き)、'notdownload'(同名ファイルが存在する場合はダウンロードを停止)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.download_file(r'D:\', '123.txt')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> リモートサーバー上の "123.txt" という名前のファイルをダウンロードし、ローカルディスクDに保存します。

download_files()

リモートディレクトリから複数のファイルをローカルディレクトリにダウンロードします。

download_files(self, local_path, download_files, download_mode='overwrite')

入力パラメータ

local_path: リモートファイルのダウンロード先となるローカルパスです。

download_files: サーバー上でダウンロードするファイルのリストです。現在接続している作業パスからの相対パスで指定します。

download_mode:ローカルパスに同名ファイルが存在する場合の操作です。'overwrite'(ローカルファイルを上書き)、'notdownload'(同名ファイルが存在する場合はダウンロードを停止)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.download_files(r'D:\', ['123.txt', 'abc.txt'])

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> リモートサーバー上の "123.txt"、"abc.txt" という名前のファイルをダウンロードし、ローカルディスクDに保存します。

download_folder()

リモートディレクトリからファイル(フォルダ内の子ファイルを含む)を指定されたローカルディレクトリにダウンロードします。

download_folder(self, local_path, remote_path, download_mode = 'overwrite')

入力パラメータ

local_path: リモートファイルのダウンロード先となるローカルパスです。

remote_path: 取得するフォルダのリモートディレクトリです。

download_mode:ローカルパスに同名ファイルが存在する場合の操作です。'overwrite'(ローカルファイルを上書き)、'notdownload'(同名ファイルが存在する場合はダウンロードを停止)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from . import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.download_folder(r'D:\', 'files')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> リモートサーバー上の files という名前のフォルダをダウンロードし、ローカルディスクDに保存します。

download_folders()

リモートディレクトリからファイル(フォルダ内の子ファイルを含む)を指定されたローカルディレクトリにダウンロードします。

download_folders(self, local_path, remote_paths, download_mode = 'overwrite')

入力パラメータ

local_path: リモートフォルダのダウンロード先となるローカルパスです。

remote_paths: リモートフォルダのパスのリストです。

download_mode:ローカルパスに同名ファイルが存在する場合の操作です。'overwrite'(ローカルファイルを上書き)、'notdownload'(同名ファイルが存在する場合はダウンロードを停止)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.download_folders(r'D:\', ['folder1', 'folder2'])

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> リモートサーバー上の "folder1"、"folder2" という名前のフォルダをダウンロードし、ローカルディスクDに保存します。

upload_file()

ローカルファイルをリモートサーバーにアップロードします。

upload_file(self, local_file, remote_path='', upload_mode='overwrite')

入力パラメータ

local_file:アップロードするローカルファイルです。

remote_path:ローカルファイルのアップロード先となるリモートフォルダです。空の場合は現在の接続先パスを使用します。デフォルトは空です。

upload_mode:リモートの保存先パスに、アップロードするファイルと同名のファイルが存在する場合のアップロードモードです。'overwrite'(同名ファイルが存在する場合はリモートファイルを上書き)、'notupload'(同名ファイルが存在する場合はアップロードしない)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

戻り値なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.upload_file(r'D:\123.txt')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> ファイル D:\123.txt をアップロードします。

upload_files()

複数のローカルファイルをリモートサーバーにアップロードします。

upload_files(self, local_files, remote_path='', upload_mode='overwrite')

入力パラメータ

local_files:アップロードするローカルファイルのリストです。

remote_path:ローカルファイルのアップロード先となるリモートフォルダです。空の場合は現在の接続先パスを使用します。デフォルトは空です。

upload_mode:リモートの保存先パスに、アップロードするファイルと同名のファイルが存在する場合のアップロードモードです。'overwrite'(同名ファイルが存在する場合はリモートファイルを上書き)、'notupload'(同名ファイルが存在する場合はアップロードしない)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.upload_files([r'D:\123.txt', r'D:\abc.txt'])

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> ファイル D:\123.txt、D:\abc.txt をアップロードします。

upload_folder()

ローカルフォルダをリモートサーバーにアップロードします。

upload_folder(self, local_folder, remote_path='', upload_mode='overwrite')

入力パラメータ

local_folder:アップロードするローカルフォルダのパスです。

remote_path:ローカルファイルのアップロード先となるリモートフォルダです。空の場合は現在の接続先パスを使用します。デフォルトは空です。

upload_mode:リモートの保存先パスに、アップロードするファイルと同名のファイルが存在する場合のアップロードモードです。'overwrite'(同名ファイルが存在する場合はリモートファイルを上書き)、'notupload'(同名ファイルが存在する場合はアップロードしない)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.upload_folder(r'D:\')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> フォルダ D:\ をアップロードします。

upload_folders()

複数のローカルフォルダをリモートサーバーにアップロードします。

upload_folders(self, local_folders, remote_path='', upload_mode='overwrite')

入力パラメータ

local_folder:アップロードするローカルフォルダのパスのリストです。

remote_path:ローカルファイルのアップロード先となるリモートフォルダです。空の場合は現在の接続先パスを使用します。デフォルトは空です。

upload_mode:リモートの保存先パスに、アップロードするファイルと同名のファイルが存在する場合のアップロードモードです。'overwrite'(同名ファイルが存在する場合はリモートファイルを上書き)、'notupload'(同名ファイルが存在する場合はアップロードしない)、または 'uniquename'(同名ファイルが存在する場合はファイル名を自動生成)を選択できます。デフォルトは 'overwrite' です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.upload_folders([r'D:\', r'E:\'])

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> フォルダ "D:"、"E:" をアップロードします。

change_workspace_path()

現在接続している作業パスを変更します。

change_workspace_path(self, new_remote_path)

入力パラメータ

new_remote_path:新しいリモートの作業パスです。

戻り値なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.change_workspace_path('new_workspace_path')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> 現在接続している作業パスを "new_workspace_path" に変更します。

delete_file()

現在接続している作業パスにあるファイルを削除します。

delete_file(self, remote_file)

入力パラメータ

remote_file:対象ファイルのファイル名です。

戻り値なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.delete_file('123.txt')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> 現在接続している作業パスにあるファイル "123.txt" を削除します。

rename_file()

現在接続している作業パスにある指定されたファイルの名前を変更します。

rename_file(self, remote_file, new_name)

入力パラメータ

remote_file:名前を変更するリモートファイルです。

new_name:新しいファイル名です。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.rename_file('123.txt', 'abc.txt')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> 現在接続している作業パスにある "123.txt" の名前を "abc.txt" に変更します。

create_directory()

現在接続している作業パスにフォルダを作成します。

create_directory(self, new_remote_path)

入力パラメータ

new_remote_path:作成するフォルダの名前です。

戻り値なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.create_directory('new_folder')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> 現在接続している作業パスにフォルダ "new_folder" を作成します。

delete_folder()

現在接続している作業パスにある指定されたフォルダを削除します。

delete_folder(self, remote_path)

入力パラメータ

remote_path:対象フォルダの名前です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    ftp_instance = xbot.ftp.connect('127.0.0.1', 'zhangsan@123.com', password='123456')
    ftp.delete_folder('folder_name')

この例の実行内容: アカウント zhangsan@123.com、パスワード '123456' でローカルのFTPに接続します --> 現在接続している作業パスにあるフォルダ "folder_name" を削除します。

APIリファレンスの記事一覧ページの先頭へ ↑