xbot.ftp.FTPBase

概述

使用FTP对象示例与fpt服务端进行交互

详情

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()

get_ftp_files

获取文件服务器上当前连接路径下的全部文件信息（包括文件和文件夹）

get_ftp_files(self, remote_path="")

参数

• remote_path: 需要获取文件信息远程路径，默认值为空，表示获取当前连接的工作路径

返回值

• dict：返回一个以remote_files 和 remote_folders 为键值，value为列表的字典类型

示例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()

download_file

下载文件服务器上指令路径下的文件到本地

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

参数

• local_path: 远程文件要下载到本地的瑞金
• remote_file: 服务器上相对当前连接的工作路径需要下载的文件路径
• download_mode：当本地路径下存在同名文件时的处理方式,默认值是 overwrite 覆盖本地文件
  • overwrite：覆盖本地文件
  • notdownlaod: 存在同名文件时停止下载
  • uniquename: 存在同名文件时自动生成文件名

返回值 无

示例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:\works', '123.txt')

download_files

从远程目录下载多个文件到本地目录

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

参数

• local_path, 本地路径
• download_files, 需要下载文件列表
• dowload_mode, 本地存在同名文件时的下载模式,默认值为overwrite覆盖本地文件
  • overwrite, 存在同名文件时覆盖本地文件
  • notdownlaod, 存在同名文件时停止下载
  • uniquename, 存在同名文件时自动生成文件名

返回值 无

示例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:\works', ['123.txt', 'abc.txt'])

download_folder

从远程目录下载文件到(报错文件夹中的子文件)到指定的本地目录

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

参数

• local_path, 本地路径
• remote_path, 远程文件夹路径
• dowload_mode, 本地存在同名文件时的下载模式,默认值为overwrite覆盖本地文件
  • overwrite, 存在同名文件时覆盖本地文件
  • notdownlaod, 存在同名文件时停止下载
  • uniquename, 存在同名文件时自动生成文件名

返回值 无

示例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:\works', 'files')

download_folders

从远程目录下载文件到(报错文件夹中的子文件)到指定的本地目录

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

参数

• local_path, 本地路径
• remote_paths, 远程文件夹路径
• dowload_mode, 本地存在同名文件时的下载模式,默认值为overwrite覆盖本地文件
  • overwrite, 存在同名文件时覆盖本地文件
  • notdownlaod, 存在同名文件时停止下载
  • uniquename, 存在同名文件时自动生成文件名

返回值 无

示例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:\works', ['folder1', 'folder2'])

upload_file

上传本地文件到远程服务器

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

参数

• local_file, 需要上传的本地文件
• remote_path, 本地文件将要上传到的远程文件夹,可为空为空时当前连接的Working路径,默认值为空
• upload_mode, 远程目标路径下存在和需要上传的文件同名的文件时的上传模式,默认值为 overwrote 覆盖远程文件
  • overwrite, 存在同名文件时覆盖远程文件
  • notupload, 存在同名文件时放弃上传
  • uniquename, 存在同名文件时自动生成文件名

返回值 无

示例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:\works\123.txt')

upload_files

上传多个本地文件到远程服务器

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

参数

• local_files, 需要上传的本地文件列表
• remote_path, 本地文件将要上传到的远程文件夹,可为空为空时当前连接的Working路径,默认值为空
• upload_mode, 远程目标路径下存在和需要上传的文件同名的文件时的上传模式,默认值为 overwrote 覆盖远程文件
  • overwrite, 存在同名文件时覆盖远程文件
  • notupload, 存在同名文件时放弃上传
  • uniquename, 存在同名文件时自动生成文件名

示例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:\works\123.txt', r'D:\works\abc.txt'])

upload_folder

上传本地文件夹到远程服务器

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

参数

• local_folder, 需要上传的本地文件夹路径
• remote_path, 本地文件夹将要上传到的远程路径,默认值为空表示上传到当前连接的Working路径
• upload_mode, 远程目标路径下存在和需要上传的文件同名的文件时的上传模式,默认值为 overwrote 覆盖远程文件
  • overwrite, 存在同名文件时覆盖远程文件
  • notupload, 存在同名文件时放弃上传
  • uniquename, 存在同名文件时自动生成文件名

返回值 无

示例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:\works\')

upload_folders

上传多个本地文件夹到远程服务器

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

参数

• local_folders, 需要上传的本地文件夹路径列表
• remote_path, 本地文件夹将要上传到的远程路径,默认值为空表示上传到当前连接的Working路径
• upload_mode, 远程目标路径下存在和需要上传的文件同名的文件时的上传模式,默认值为 overwrote 覆盖远程文件
  • overwrite, 存在同名文件时覆盖远程文件
  • notupload, 存在同名文件时放弃上传
  • uniquename, 存在同名文件时自动生成文件名

返回值 无

示例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:\works\', r'D:\works1'])

change_workspace_path

改变当前连接的Working路径

change_workspace_path(self, new_remote_path)

参数

• new_remote_path, 新的Working路径

返回值 无

示例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')

delete_file

删除当前连接Working路径下的文件

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')

rename_file

修改当前连接的Working路径下指定文件的名称

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')

create_directory

在当前连接的Working路径下创建文件夹

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')

delete_folder

删除当前连接的Working路径下指定的文件夹

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')