Python中的pretty()函数用法详解

在Python中，pretty()函数是用于格式化打印输出的工具函数。它可以将数据结构以更易读的方式显示出来，方便程序员调试和查看数据。

pretty()函数是在pprint模块中定义的，因此在使用之前需要先导入该模块。下面是pretty()函数的用法详解。

## 1. 基本用法

pretty()函数接受一个需要格式化输出的对象作为参数，并返回一个字符串。它会根据对象的类型，将其按照一定的格式进行输出。

下面是一个简单的例子，展示了pretty()函数的基本用法：

from pprint import pprint

data = {
    'name': 'John',
    'age': 30,
    'email': 'john@example.com',
    'skills': ['Python', 'Java', 'C++']
}

pprint(data)

输出结果如下：

{'age': 30,
 'email': 'john@example.com',
 'name': 'John',
 'skills': ['Python', 'Java', 'C++']}

可以看到，pretty()函数会按照字典的键的顺序，将键值对按照一定的格式进行输出，使其更容易阅读。

## 2. 控制输出格式

pretty()函数提供了一些选项，可以控制输出的格式。下面是一些常用选项的示例：

- depth：控制输出的嵌套层次。默认值为None，表示无限制地输出所有层次。如果设置为一个大于0的整数，则只输出指定层次的内容。

- width：控制输出的行宽。默认值为80。如果设置为一个较小的整数，则会换行输出。

- compact：控制输出是否紧凑。默认值为False，表示使用缩进，使输出更易读。如果设置为True，则不使用缩进。

下面是一个示例，展示了如何使用这些选项控制输出的格式：

from pprint import pprint

data = {
    'name': 'John',
    'age': 30,
    'email': 'john@example.com',
    'skills': ['Python', 'Java', 'C++'],
    'details': {
        'address': '123 Main St',
        'phone': '555-1234'
    }
}

pprint(data, depth=1, width=40, compact=True)

输出结果如下：

{'age': 30,
 'details': {...},
 'email': 'john@example.com',
 'name': 'John',
 'skills': ['Python', 'Java', 'C++']}

可以看到，由于设置了depth=1，details字典的内容被缩写为{...}；由于设置了width=40，compact=True，超过行宽的内容会自动换行，并且不使用缩进。

## 3. 自定义输出格式

pretty()函数还提供了一种自定义输出格式的方法，即通过设置indent参数来指定缩进的字符。

下面是一个示例，展示了如何自定义输出格式：

from pprint import pprint

data = {
    'name': 'John',
    'age': 30,
    'email': 'john@example.com',
    'skills': ['Python', 'Java', 'C++']
}

pprint(data, indent='-> ')

输出结果如下：

-> {'age': 30,
->  'email': 'john@example.com',
->  'name': 'John',
->  'skills': ['Python', 'Java', 'C++']}

可以看到，由于设置了indent='-> '，输出的每一行都会以箭头符号->作为缩进。

## 4. 其他用法

pretty()函数还可以用于格式化输出其他类型的对象，如列表、集合、元组等。

下面是一个示例，展示了如何格式化输出一个列表：

from pprint import pprint

data = ['Apple', 'Banana', 'Orange']

pprint(data, width=20)

输出结果如下：

['Apple',
 'Banana',
 'Orange']

可以看到，pretty()函数会按照列表的元素顺序，将每个元素单独占据一行输出。

除了格式化输出，pretty()函数还可以用于将格式化后的字符串写入文件或其他输出流。

下面是一个示例，展示了如何将格式化后的字符串写入文件：

from pprint import pprint

data = {
    'name': 'John',
    'age': 30,
    'email': 'john@example.com',
    'skills': ['Python', 'Java', 'C++']
}

with open('output.txt', 'w') as f:
    pprint(data, stream=f)

这个例子会将格式化后的字符串写入名为output.txt的文件中。

总结起来，pretty()函数是Python中一个实用的工具函数，它可以将数据结构以更易读的方式进行输出。通过控制选项，可以灵活地控制输出的格式。不仅如此，pretty()函数还可以用于格式化输出其他类型的对象，以及将格式化后的字符串写入文件或其他输出流。这使得pretty()函数成为程序员调试和查看数据的有力工具。