python3 fileMethods.py

"""
模块：python3 fileMethods.py
功能：python3 文件的方法。
参考：https://www.runoob.com/python3/python3-file-methods.html
知识点：
1.open() -> 文件对象。
使用 open() 方法一定要保证关闭文件对象，即调用 close() 方法。
open() 函数常用形式:
open(file, mode='r')
完整的语法:
open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)
file: 必需，文件路径（相对或者绝对路径）。
mode: 可选，文件打开模式
buffering: 设置缓冲
encoding: 一般使用utf8
errors: 报错级别
newline: 区分换行符
closefd: 传入的file参数类型
opener:

2.file 对象使用 open 函数来创建。
close() 方法用于关闭一个已打开的文件。
关闭后的文件不能再进行读写操作，否则会触发 ValueError 错误。
close() 方法允许调用多次。

当 file 对象，被引用到操作另外一个文件时，Python 会自动关闭之前的 file 对象。
使用 close() 方法关闭文件是一个好的习惯。
"""
# 1.fileObject.close()
fo = open("runoob.txt", "wb")
print("文件名为: ", fo.name)
# 文件名为:  runoob.txt
fo.close()

# 2.fileObject.flush()
# flush() 方法是用来刷新缓冲区的，即将缓冲区中的数据立刻写入文件，
# 同时清空缓冲区，不需要是被动的等待输出缓冲区写入。
# 一般情况下，文件关闭后会自动刷新缓冲区，
# 但有时你需要在关闭前刷新它，这时就可以使用 flush() 方法。
fo = open("runoob.txt", "wb")
fo.write(b'ok')
# 刷新缓冲区
fo.flush()
# 此行代码用于测试，程序结束前，是否已经写入文件内容。
# input("请输入：")
fo.close()

# 3.fileObject.fileno() -> 文件描述符（int）
# fileno() 方法返回一个整型的文件描述符(file descriptor FD 整型)，
# 可用于底层操作系统的 I/O 操作。
print("3:")
fo = open("runoob.txt", "wb")
fid = fo.fileno()
print("文件描述符为: ", fid)
# 文件描述符为:  3
fo.close()

# 4.fileObject.read([size])
# read() 方法用于从文件读取指定的字符数，如果未给定或为负则读取所有。
# size -- 从文件中读取的字节数。
print("4:")
fo = open("runoob.txt", "r+", encoding='utf-8')
strLen = fo.write("""这是第一行
这是第二行
这是第三行
这是第四行
这是第五行""")
# 换行符 \n 算一个字符。
print("strLen:", strLen)
# strLen: 29
# 重新设置文件读取指针到开头
currentPosition = fo.seek(0, 0)
print("currentPosition:", currentPosition)
# currentPosition: 0
content = fo.read(10)
print(content)
# 这是第一行
# 这是第二
print(len(content))  # 10
fo.close()

# 5.file.readline([size]) -> 从字符串中读取的字节(符)。
# readline() 方法用于从文件读取整行，包括 "\n" 字符。
# 如果指定了一个非负数的参数，则返回指定大小的字节数（不超出该行），包括 "\n" 字符。
# size -- 从文件中读取的字符数。
print("5:")
fo = open("runoob.txt", "r+", encoding='utf-8')
fo.write("""1:www.runoob.com
2:www.runoob.com
3:www.runoob.com
4:www.runoob.com
5:www.runoob.com""")
fo.seek(0, 0)
line = fo.readline()
print(line, end='')
# 1:www.runoob.com
line = fo.readline(5)
print(line)
# 2:www
fo.close()

# 6.fileObject.readlines() -> [.., .., ..]
# readlines() 方法用于读取所有行(直到结束符 EOF)并返回列表，
# 该列表可以由 Python 的 for... in ... 结构进行处理。
# 如果碰到结束符 EOF 则返回空字符串。
print("6:")
fo = open("runoob.txt", "r", encoding='utf-8')
# print(fo.readlines())
for line in fo.readlines():  # 依次读取每行
    line = line.strip()  # 去掉每行头尾空白
    print(line)
fo.close()
# 1:www.runoob.com
# 2:www.runoob.com
# 3:www.runoob.com
# 4:www.runoob.com
# 5:www.runoob.com

# 7.fileObject.seek(offset[, whence]) -> 新的文件位置 / -1。
# seek() 方法用于移动(文件读取)指针到指定位置。
# offset -- 开始的偏移量，也就是代表需要移动偏移的字节数，
# 如果是负数表示从倒数第几位开始。
# whence：可选，默认值为 0。
# 给 offset 定义一个参数，表示要从哪个位置开始偏移；
# 0 代表从文件开头开始算起，1 代表从当前位置开始算起，2 代表从文件末尾算起。
# 如果操作成功，则返回新的文件位置，如果操作失败，则函数返回 -1。
# 注意：
# 文件的开始位置是 0。
# 文件写完后，指针停留在文件结尾，此时的文件位置是文件字符串的长度。

# fileObject.tell()
# tell() 方法返回文件的当前位置，即文件指针当前位置。
print("\n7:")
f = open('workfile', 'wb+')
contentLen = f.write(b'0123456789')
print("contentLen:", contentLen)
# contentLen: 10
currentPosition = f.tell()
print("currentPosition:", currentPosition)
# currentPosition: 10
currentPosition = f.seek(5)  # 移动到文件的第六个字节
print("currentPosition:", currentPosition)
# currentPosition: 5
# 此处可见，不清空缓存，也可读取（缓存）。
print(f.read(1))
# b'5'
currentPosition = f.seek(-3, 2)  # 移动到文件倒数第三个字节
print("currentPosition:", currentPosition)
# currentPosition: 7
print(f.read(1))
# b'7'

# 8.fileObject.write([str]) -> 写入字符串的长度
# write() 方法用于向文件中写入指定字符串。
# 在文件关闭前或缓冲区刷新前，字符串内容存储在缓冲区中，这时你在文件中是看不到写入的内容的。
# 如果文件打开模式带 b，那写入文件内容时，str (参数)要用 encode 方法转为 bytes 形式，
# 否则报错：TypeError: a bytes-like object is required, not 'str'。
# 注：
# 文件对象 fo 是迭代器。
print("\n8:")
fo = open("runoob.txt", "r+")

s = "\n6:www.runoob.com"
# 在文件末尾写入一行
fo.seek(0, 2)
strLen = fo.write(s)
print(strLen == len(s))  # True

# 读取文件所有内容
fo.seek(0, 0)
for index in range(6):
    line = next(fo)
    print("文件行号 %d - %s" % (index, line), end='')
fo.close()
# 文件行号 0 - 1:www.runoob.com
# 文件行号 1 - 2:www.runoob.com
# 文件行号 2 - 3:www.runoob.com
# 文件行号 3 - 4:www.runoob.com
# 文件行号 4 - 5:www.runoob.com
# 文件行号 5 - 6:www.runoob.com

# 9.fileObject.writelines([str]) -> None
# writelines() 方法用于向文件中写入一序列的字符串。
# 这一序列字符串可以是由迭代对象产生的，如一个字符串列表。
# 换行需要制定换行符 \n。
# str -- 要写入文件的字符串序列。
print("\n9:")
fo = open("test.txt", "w")
seq = ["菜鸟教程 1\n", "菜鸟教程 2"]
fo.writelines(seq)
fo.close()

# 10.fileObject.truncate([size])
# truncate() 方法用于从文件的首行首字节开始截断，截断文件为 size 个字节，
# 无 size 表示从当前位置截断；
# 截断之后 V 后面的所有字节被删除，其中 windows 系统下的换行代表2个字节大小。
# size -- 可选，如果存在则文件截断为 size 字节。
print("\n10:")
fo = open("runoob.txt", "r+")
line = fo.readline()
print("读取行: %s" % line)

fo.truncate()
line = fo.readlines()
print("读取行: %s" % line)
fo.close()

print("\n10.2:")
fo = open("runoob.txt", "r+")
# 截取10个字节
fo.truncate(10)
s = fo.read()
print("读取数据: %s" % s)
# 读取数据: 1:www.runo
fo.close()